{ "x-generator": "On Key REST API Docs Generator", "openapi": "3.0.0", "info": { "title": "On Key MM API Specification", "description": "Better and smarter enterprise asset management with one of the world's leading Enterprise Asset Management (EAM) systems.", "termsOfService": "https://www.onkey.com/", "contact": { "name": "On Key Support", "url": "https://www.onkey.com/", "email": "onkey.support@pragmaworld.net" }, "license": { "name": "On Key Licence", "url": "https://www.onkey.com/" }, "version": "1.0.0" }, "servers": [ { "url": "{scheme}://{server}:{port}/api/tenants/{client}/{connection}", "description": "On Key API Server", "variables": { "scheme": { "default": "https", "description": "HTTP scheme" }, "server": { "default": "", "description": "Server host" }, "port": { "default": "443", "description": "Port" }, "client": { "default": "", "description": "Client" }, "connection": { "default": "", "description": "Connection/Environment (i.e. prod, qa)" } } } ], "paths": { "/Modules/MM/Categories/{id}": { "get": { "tags": [ "Category" ], "summary": "Get a Category resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | Category->Code | string | |\r\n| createdByUserId | Category->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Category->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Category->CreatedByUser_FullName | string | |\r\n| createdOn | Category->CreatedOn | string | date-time |\r\n| isActive | Category->IsActive | boolean | |\r\n| modifiedByUserId | Category->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Category->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Category->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Category->ModifiedOn | string | date-time |\r\n| permissionTreeId | Category->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Category->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Category->PermissionTree_Description | string | |\r\n| version | Category->Version | integer | int32 |\r\n| id | Category->Id | integer | int64 |\r\n| description | Category->Description | string | |\r\n| notes | Category->Notes | string | |\r\n| sequenceNumber | Category->SequenceNumber | integer | int32 |\r\n", "operationId": "GetCategory", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Category Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Category", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetCategoryResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Category" ], "summary": "Update an existing Category resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Category->Version | integer | int32 |\r\n| code | Category->Code | string | |\r\n| description | Category->Description | string | |\r\n| sequenceNumber | Category->SequenceNumber | integer | int32 |\r\n| notes | Category->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": "UpdateCategory", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Category Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateCategoryResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Category was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Category" ], "summary": "Delete an existing Category resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Category->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": "DeleteCategory", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Category Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteCategoryResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Category was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Categories": { "get": { "tags": [ "Category" ], "summary": "Get a collection of Category resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Category->Version | integer | int32 |\r\n| id | Category->Id | integer | int64 |\r\n| code | Category->Code | string | |\r\n| description | Category->Description | string | |\r\n| sequenceNumber | Category->SequenceNumber | integer | int32 |\r\n| notes | Category->Notes | string | |\r\n| createdOn | Category->CreatedOn | string | date-time |\r\n| modifiedOn | Category->ModifiedOn | string | date-time |\r\n", "operationId": "GetCategoryCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Category collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetCategoryCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Category" ], "summary": "Create a new Category resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | Category->PermissionTree_Id | integer | int64 |\r\n| code | Category->Code | string | |\r\n| description | Category->Description | string | |\r\n| sequenceNumber | Category->SequenceNumber | integer | int32 |\r\n| notes | Category->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": "CreateCategory", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateCategoryResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Categories/Lookups/LookupCategoryChangePermissionTree": { "get": { "tags": [ "Category" ], "summary": "Lookup the permission set for changing the Category.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupCategoryChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/CategoryChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Categories/Lookups/LookupCategoryInsertPermissionTree": { "get": { "tags": [ "Category" ], "summary": "Lookup the permission set for creating the Category.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupCategoryInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/CategoryInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Categories/Batch/{ids}": { "get": { "tags": [ "Category" ], "summary": "Get a collection of Category resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | Category->Code | string | |\r\n| createdByUserId | Category->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Category->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Category->CreatedByUser_FullName | string | |\r\n| createdOn | Category->CreatedOn | string | date-time |\r\n| isActive | Category->IsActive | boolean | |\r\n| modifiedByUserId | Category->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Category->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Category->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Category->ModifiedOn | string | date-time |\r\n| permissionTreeId | Category->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Category->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Category->PermissionTree_Description | string | |\r\n| version | Category->Version | integer | int32 |\r\n| id | Category->Id | integer | int64 |\r\n| description | Category->Description | string | |\r\n| notes | Category->Notes | string | |\r\n| sequenceNumber | Category->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetCategory", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Category id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Category collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetCategoryResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Categories/Batch": { "post": { "tags": [ "Category" ], "summary": "Create a new collection of Category resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | Category->PermissionTree_Id | integer | int64 |\r\n| code | Category->Code | string | |\r\n| description | Category->Description | string | |\r\n| sequenceNumber | Category->SequenceNumber | integer | int32 |\r\n| notes | Category->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": "BatchCreateCategory", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateCategoryResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Category batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Category" ], "summary": "Update a collection of existing Category resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Category->Id | integer | int64 |\r\n| version | Category->Version | integer | int32 |\r\n| code | Category->Code | string | |\r\n| description | Category->Description | string | |\r\n| sequenceNumber | Category->SequenceNumber | integer | int32 |\r\n| notes | Category->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": "BatchUpdateCategory", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateCategoryResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Category batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Category" ], "summary": "Delete a collection of existing Category resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Category->Id | integer | int64 |\r\n| version | Category->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": "BatchDeleteCategory", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteCategoryResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Category batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Categories/{id}/Active": { "patch": { "tags": [ "Category" ], "summary": "Change the IsActive status for an existing Category resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Category->Version | integer | int32 |\r\n| isActive | Category->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": "ChangeCategoryIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Category Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeCategoryIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Categories/{id}/PermissionTree": { "patch": { "tags": [ "Category" ], "summary": "Change the PermissionTree for an existing Category resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Category->Version | integer | int32 |\r\n| permissionTreeId | Category->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": "ChangeCategoryPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Category Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeCategoryPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Categories/Batch/Active": { "patch": { "tags": [ "Category" ], "summary": "Change the IsActive status for a collection of existing Category resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Category->Id | integer | int64 |\r\n| version | Category->Version | integer | int32 |\r\n| isActive | Category->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": "BatchChangeCategoryIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeCategoryIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Categories/Batch/PermissionTree": { "patch": { "tags": [ "Category" ], "summary": "Change the PermissionTree status for a collection of existing Category resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Category->Id | integer | int64 |\r\n| version | Category->Version | integer | int32 |\r\n| permissionTreeId | Category->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": "BatchChangeCategoryPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeCategoryPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Commodities/{id}": { "get": { "tags": [ "Commodity" ], "summary": "Get a Commodity 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 | Commodity->Code | string | |\r\n| isActive | Commodity->IsActive | boolean | |\r\n| createdByUserId | Commodity->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Commodity->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Commodity->CreatedByUser_FullName | string | |\r\n| createdOn | Commodity->CreatedOn | string | date-time |\r\n| modifiedByUserId | Commodity->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Commodity->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Commodity->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Commodity->ModifiedOn | string | date-time |\r\n| version | Commodity->Version | integer | int32 |\r\n| permissionTreeId | Commodity->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Commodity->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Commodity->PermissionTree_Description | string | |\r\n| id | Commodity->Id | integer | int64 |\r\n| costElementId | Commodity->CostElement_Id | integer | int64 |\r\n| costElementCode | Commodity->CostElement_Code | string | |\r\n| costElementDescription | Commodity->CostElement_Description | string | |\r\n| description | Commodity->Description | string | |\r\n| notes | Commodity->Notes | string | |\r\n| sequenceNumber | Commodity->SequenceNumber | integer | int32 |\r\n", "operationId": "GetCommodity", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Commodity Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Commodity", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetCommodityResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Commodity" ], "summary": "Update an existing Commodity resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Commodity->Version | integer | int32 |\r\n| code | Commodity->Code | string | |\r\n| description | Commodity->Description | string | |\r\n| sequenceNumber | Commodity->SequenceNumber | integer | int32 |\r\n| costElementId | Commodity->CostElement_Id | integer | int64 |\r\n| notes | Commodity->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| costElementId | Nullable | False | |\r\n\r\n", "operationId": "UpdateCommodity", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Commodity Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateCommodityResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Commodity was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Commodity" ], "summary": "Delete an existing Commodity resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Commodity->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": "DeleteCommodity", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Commodity Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteCommodityResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Commodity was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Commodities": { "get": { "tags": [ "Commodity" ], "summary": "Get a collection of Commodity 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 | Commodity->Version | integer | int32 |\r\n| id | Commodity->Id | integer | int64 |\r\n| code | Commodity->Code | string | |\r\n| description | Commodity->Description | string | |\r\n| sequenceNumber | Commodity->SequenceNumber | integer | int32 |\r\n| costElementId | Commodity->CostElement_Id | integer | int64 |\r\n| costElementCode | Commodity->CostElement_Code | string | |\r\n| costElementDescription | Commodity->CostElement_Description | string | |\r\n| notes | Commodity->Notes | string | |\r\n| createdOn | Commodity->CreatedOn | string | date-time |\r\n| modifiedOn | Commodity->ModifiedOn | string | date-time |\r\n", "operationId": "GetCommodityCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Commodity collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetCommodityCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Commodity" ], "summary": "Create a new Commodity resource.", "description": "### Request Body\r\n#### 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 | Commodity->PermissionTree_Id | integer | int64 |\r\n| code | Commodity->Code | string | |\r\n| description | Commodity->Description | string | |\r\n| sequenceNumber | Commodity->SequenceNumber | integer | int32 |\r\n| costElementId | Commodity->CostElement_Id | integer | int64 |\r\n| notes | Commodity->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| costElementId | Required | True | |\r\n| costElementId | Nullable | False | |\r\n\r\n", "operationId": "CreateCommodity", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateCommodityResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Commodities/Lookups/LookupCommodityChangePermissionTree": { "get": { "tags": [ "Commodity" ], "summary": "Lookup the permission set for changing the Commodity.", "description": "### Response Body\r\n#### Payload\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": "LookupCommodityChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/CommodityChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Commodities/Lookups/LookupCommodityCostElement": { "get": { "tags": [ "Commodity" ], "summary": "Lookup the Cost Element for the Commodity.", "description": "### Response Body\r\n#### Payload\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": "LookupCommodityCostElement", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Cost Element collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/CommodityCostElementLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Commodities/Lookups/LookupCommodityInsertPermissionTree": { "get": { "tags": [ "Commodity" ], "summary": "Lookup the permission set for creating the Commodity.", "description": "### Response Body\r\n#### Payload\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": "LookupCommodityInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/CommodityInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Commodities/Batch/{ids}": { "get": { "tags": [ "Commodity" ], "summary": "Get a collection of Commodity 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 | Commodity->Code | string | |\r\n| isActive | Commodity->IsActive | boolean | |\r\n| createdByUserId | Commodity->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Commodity->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Commodity->CreatedByUser_FullName | string | |\r\n| createdOn | Commodity->CreatedOn | string | date-time |\r\n| modifiedByUserId | Commodity->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Commodity->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Commodity->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Commodity->ModifiedOn | string | date-time |\r\n| version | Commodity->Version | integer | int32 |\r\n| permissionTreeId | Commodity->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Commodity->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Commodity->PermissionTree_Description | string | |\r\n| id | Commodity->Id | integer | int64 |\r\n| costElementId | Commodity->CostElement_Id | integer | int64 |\r\n| costElementCode | Commodity->CostElement_Code | string | |\r\n| costElementDescription | Commodity->CostElement_Description | string | |\r\n| description | Commodity->Description | string | |\r\n| notes | Commodity->Notes | string | |\r\n| sequenceNumber | Commodity->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetCommodity", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Commodity id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Commodity collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetCommodityResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Commodities/Batch": { "post": { "tags": [ "Commodity" ], "summary": "Create a new collection of Commodity resources.", "description": "### Request Body\r\n#### 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 | Commodity->PermissionTree_Id | integer | int64 |\r\n| code | Commodity->Code | string | |\r\n| description | Commodity->Description | string | |\r\n| sequenceNumber | Commodity->SequenceNumber | integer | int32 |\r\n| costElementId | Commodity->CostElement_Id | integer | int64 |\r\n| notes | Commodity->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| costElementId | Required | True | |\r\n| costElementId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateCommodity", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateCommodityResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Commodity batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Commodity" ], "summary": "Update a collection of existing Commodity resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Commodity->Id | integer | int64 |\r\n| version | Commodity->Version | integer | int32 |\r\n| code | Commodity->Code | string | |\r\n| description | Commodity->Description | string | |\r\n| sequenceNumber | Commodity->SequenceNumber | integer | int32 |\r\n| costElementId | Commodity->CostElement_Id | integer | int64 |\r\n| notes | Commodity->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| costElementId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateCommodity", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateCommodityResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Commodity batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Commodity" ], "summary": "Delete a collection of existing Commodity resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Commodity->Id | integer | int64 |\r\n| version | Commodity->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": "BatchDeleteCommodity", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteCommodityResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Commodity batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Commodities/{id}/Active": { "patch": { "tags": [ "Commodity" ], "summary": "Change the IsActive status for an existing Commodity resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Commodity->Version | integer | int32 |\r\n| isActive | Commodity->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": "ChangeCommodityIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Commodity Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeCommodityIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Commodities/{id}/PermissionTree": { "patch": { "tags": [ "Commodity" ], "summary": "Change the PermissionTree for an existing Commodity resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Commodity->Version | integer | int32 |\r\n| permissionTreeId | Commodity->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": "ChangeCommodityPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Commodity Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeCommodityPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Commodities/Batch/Active": { "patch": { "tags": [ "Commodity" ], "summary": "Change the IsActive status for a collection of existing Commodity resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Commodity->Id | integer | int64 |\r\n| version | Commodity->Version | integer | int32 |\r\n| isActive | Commodity->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": "BatchChangeCommodityIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeCommodityIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Commodities/Batch/PermissionTree": { "patch": { "tags": [ "Commodity" ], "summary": "Change the PermissionTree status for a collection of existing Commodity resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Commodity->Id | integer | int64 |\r\n| version | Commodity->Version | integer | int32 |\r\n| permissionTreeId | Commodity->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": "BatchChangeCommodityPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeCommodityPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/{id}": { "get": { "tags": [ "Material Master" ], "summary": "Get a Material Master 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 | MaterialMaster->Code | string | |\r\n| isActive | MaterialMaster->IsActive | boolean | |\r\n| createdByUserId | MaterialMaster->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MaterialMaster->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MaterialMaster->CreatedByUser_FullName | string | |\r\n| createdOn | MaterialMaster->CreatedOn | string | date-time |\r\n| modifiedByUserId | MaterialMaster->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MaterialMaster->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MaterialMaster->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MaterialMaster->ModifiedOn | string | date-time |\r\n| version | MaterialMaster->Version | integer | int32 |\r\n| permissionTreeId | MaterialMaster->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MaterialMaster->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MaterialMaster->PermissionTree_Description | string | |\r\n| id | MaterialMaster->Id | integer | int64 |\r\n| alternativeDescription | MaterialMaster->AlternativeDescription | string | |\r\n| barcode | MaterialMaster->Barcode | string | |\r\n| categoryId | MaterialMaster->Category_Id | integer | int64 |\r\n| categoryCode | MaterialMaster->Category_Code | string | |\r\n| categoryDescription | MaterialMaster->Category_Description | string | |\r\n| classification | MaterialMaster->Classification | string | |\r\n| commodityId | MaterialMaster->Commodity_Id | integer | int64 |\r\n| commodityCode | MaterialMaster->Commodity_Code | string | |\r\n| commodityDescription | MaterialMaster->Commodity_Description | string | |\r\n| costElementId | MaterialMaster->CostElement_Id | integer | int64 |\r\n| costElementCode | MaterialMaster->CostElement_Code | string | |\r\n| costElementDescription | MaterialMaster->CostElement_Description | string | |\r\n| defaultMaterialMasterBinId | MaterialMaster->DefaultMaterialMasterBin_Id | integer | int64 |\r\n| defaultMaterialMasterBinCode | MaterialMaster->DefaultMaterialMasterBin_Code | string | |\r\n| defaultMaterialMasterSupplierId | MaterialMaster->DefaultMaterialMasterSupplier_Id | integer | int64 |\r\n| defaultMaterialMasterSupplierSupplierId | MaterialMaster->DefaultMaterialMasterSupplier_Supplier_Id | integer | int64 |\r\n| defaultMaterialMasterSupplierSupplierCode | MaterialMaster->DefaultMaterialMasterSupplier_Supplier_Code | string | |\r\n| defaultMaterialMasterSupplierSupplierDescription | MaterialMaster->DefaultMaterialMasterSupplier_Supplier_Description | string | |\r\n| description | MaterialMaster->Description | string | |\r\n| highLifeExpectancy | MaterialMaster->HighLifeExpectancy | string | duration |\r\n| isInsuranceItem | MaterialMaster->IsInsuranceItem | boolean | |\r\n| isStockItem | MaterialMaster->IsStockItem | boolean | |\r\n| itemSize | MaterialMaster->ItemSize | string | |\r\n| leadTime | MaterialMaster->LeadTime | string | duration |\r\n| lowLifeExpectancy | MaterialMaster->LowLifeExpectancy | string | duration |\r\n| maximumLevel | MaterialMaster->MaximumLevel | number | float |\r\n| mediumLifeExpectancy | MaterialMaster->MediumLifeExpectancy | string | duration |\r\n| minimumLevel | MaterialMaster->MinimumLevel | number | float |\r\n| notes | MaterialMaster->Notes | string | |\r\n| partsReplacementMethod | MaterialMaster->PartsReplacementMethod | string (Allowed values: [Physical, Preferred, TypeSideOnly, Unknown]) | enum |\r\n| replaceByDate | MaterialMaster->ReplaceByDate | string | date-time |\r\n| replacedOnDate | MaterialMaster->ReplacedOnDate | string | date-time |\r\n| replaceWithMaterialMasterId | MaterialMaster->ReplaceWithMaterialMaster_Id | integer | int64 |\r\n| replaceWithMaterialMasterCode | MaterialMaster->ReplaceWithMaterialMaster_Code | string | |\r\n| replaceWithMaterialMasterDescription | MaterialMaster->ReplaceWithMaterialMaster_Description | string | |\r\n| sequenceNumber | MaterialMaster->SequenceNumber | integer | int32 |\r\n| unitOfMeasurementId | MaterialMaster->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | MaterialMaster->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | MaterialMaster->UnitOfMeasurement_Description | string | |\r\n", "operationId": "GetMaterialMaster", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Material Master", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMaterialMasterResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Material Master" ], "summary": "Update an existing Material Master resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MaterialMaster->Version | integer | int32 |\r\n| alternativeDescription | MaterialMaster->AlternativeDescription | string | |\r\n| barcode | MaterialMaster->Barcode | string | |\r\n| categoryId | MaterialMaster->Category_Id | integer | int64 |\r\n| classification | MaterialMaster->Classification | string | |\r\n| code | MaterialMaster->Code | string | |\r\n| commodityId | MaterialMaster->Commodity_Id | integer | int64 |\r\n| costElementId | MaterialMaster->CostElement_Id | integer | int64 |\r\n| defaultMaterialMasterBinId | MaterialMaster->DefaultMaterialMasterBin_Id | integer | int64 |\r\n| defaultMaterialMasterSupplierId | MaterialMaster->DefaultMaterialMasterSupplier_Id | integer | int64 |\r\n| description | MaterialMaster->Description | string | |\r\n| highLifeExpectancy | MaterialMaster->HighLifeExpectancy | string | duration |\r\n| itemSize | MaterialMaster->ItemSize | string | |\r\n| isInsuranceItem | MaterialMaster->IsInsuranceItem | boolean | |\r\n| isStockItem | MaterialMaster->IsStockItem | boolean | |\r\n| leadTime | MaterialMaster->LeadTime | string | duration |\r\n| lowLifeExpectancy | MaterialMaster->LowLifeExpectancy | string | duration |\r\n| maximumLevel | MaterialMaster->MaximumLevel | number | float |\r\n| mediumLifeExpectancy | MaterialMaster->MediumLifeExpectancy | string | duration |\r\n| minimumLevel | MaterialMaster->MinimumLevel | number | float |\r\n| notes | MaterialMaster->Notes | string | |\r\n| partsReplacementMethod | MaterialMaster->PartsReplacementMethod | string (Allowed values: [Physical, Preferred, TypeSideOnly, Unknown]) | enum |\r\n| sequenceNumber | MaterialMaster->SequenceNumber | integer | int32 |\r\n| unitOfMeasurementId | MaterialMaster->UnitOfMeasurement_Id | integer | int64 |\r\n| replaceWithMaterialMasterId | MaterialMaster->ReplaceWithMaterialMaster_Id | integer | int64 |\r\n| replaceByDate | MaterialMaster->ReplaceByDate | string | date-time |\r\n| replacedOnDate | MaterialMaster->ReplacedOnDate | string | date-time |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| barcode | Min Length | >= 1 chars| |\r\n| barcode | Max Length | <= 50 chars| |\r\n| classification | Min Length | >= 1 chars| |\r\n| classification | Max Length | <= 50 chars| |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| commodityId | Nullable | False | |\r\n| costElementId | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| highLifeExpectancy | Min Value | >= 00:00:00| |\r\n| itemSize | Min Length | >= 1 chars| |\r\n| itemSize | Max Length | <= 50 chars| |\r\n| isInsuranceItem | Nullable | False | |\r\n| isStockItem | Nullable | False | |\r\n| leadTime | Min Value | >= 00:00:00| |\r\n| lowLifeExpectancy | Min Value | >= 00:00:00| |\r\n| maximumLevel | Min Value | >= 0| |\r\n| minimumLevel | Min Value | >= 0| |\r\n| notes | Min Length | >= 1 chars| |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "UpdateMaterialMaster", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateMaterialMasterResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Material Master was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Material Master" ], "summary": "Delete an existing Material Master resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MaterialMaster->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": "DeleteMaterialMaster", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteMaterialMasterResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Material Master was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters": { "get": { "tags": [ "Material Master" ], "summary": "Get a collection of Material Master 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 | MaterialMaster->Id | integer | int64 |\r\n| code | MaterialMaster->Code | string | |\r\n| description | MaterialMaster->Description | string | |\r\n| alternativeDescription | MaterialMaster->AlternativeDescription | string | |\r\n| isStockItem | MaterialMaster->IsStockItem | boolean | |\r\n| classification | MaterialMaster->Classification | string | |\r\n| commodityId | MaterialMaster->Commodity_Id | integer | int64 |\r\n| commodityCode | MaterialMaster->Commodity_Code | string | |\r\n| costElementId | MaterialMaster->CostElement_Id | integer | int64 |\r\n| costElementCode | MaterialMaster->CostElement_Code | string | |\r\n| categoryId | MaterialMaster->Category_Id | integer | int64 |\r\n| categoryCode | MaterialMaster->Category_Code | string | |\r\n| unitOfMeasurementId | MaterialMaster->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | MaterialMaster->UnitOfMeasurement_Code | string | |\r\n| defaultMaterialMasterBinId | MaterialMaster->DefaultMaterialMasterBin_Id | integer | int64 |\r\n| defaultMaterialMasterBinCode | MaterialMaster->DefaultMaterialMasterBin_Code | string | |\r\n| defaultMaterialMasterSupplierSupplierId | MaterialMaster->DefaultMaterialMasterSupplier_Supplier_Id | integer | int64 |\r\n| defaultMaterialMasterSupplierSupplierCode | MaterialMaster->DefaultMaterialMasterSupplier_Supplier_Code | string | |\r\n| defaultMaterialMasterSupplierSupplierDescription | MaterialMaster->DefaultMaterialMasterSupplier_Supplier_Description | string | |\r\n| version | MaterialMaster->Version | integer | int32 |\r\n", "operationId": "GetMaterialMasterCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Material Master collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMaterialMasterCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Material Master" ], "summary": "Create a new Material Master resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| alternativeDescription | MaterialMaster->AlternativeDescription | string | |\r\n| barcode | MaterialMaster->Barcode | string | |\r\n| categoryId | MaterialMaster->Category_Id | integer | int64 |\r\n| classification | MaterialMaster->Classification | string | |\r\n| code | MaterialMaster->Code | string | |\r\n| commodityId | MaterialMaster->Commodity_Id | integer | int64 |\r\n| costElementId | MaterialMaster->CostElement_Id | integer | int64 |\r\n| description | MaterialMaster->Description | string | |\r\n| highLifeExpectancy | MaterialMaster->HighLifeExpectancy | string | duration |\r\n| itemSize | MaterialMaster->ItemSize | string | |\r\n| isInsuranceItem | MaterialMaster->IsInsuranceItem | boolean | |\r\n| isStockItem | MaterialMaster->IsStockItem | boolean | |\r\n| leadTime | MaterialMaster->LeadTime | string | duration |\r\n| lowLifeExpectancy | MaterialMaster->LowLifeExpectancy | string | duration |\r\n| maximumLevel | MaterialMaster->MaximumLevel | number | float |\r\n| mediumLifeExpectancy | MaterialMaster->MediumLifeExpectancy | string | duration |\r\n| minimumLevel | MaterialMaster->MinimumLevel | number | float |\r\n| notes | MaterialMaster->Notes | string | |\r\n| partsReplacementMethod | MaterialMaster->PartsReplacementMethod | string (Allowed values: [Physical, Preferred, TypeSideOnly, Unknown]) | enum |\r\n| permissionTreeId | MaterialMaster->PermissionTree_Id | integer | int64 |\r\n| replaceWithMaterialMasterId | MaterialMaster->ReplaceWithMaterialMaster_Id | integer | int64 |\r\n| replaceByDate | MaterialMaster->ReplaceByDate | string | date-time |\r\n| replacedOnDate | MaterialMaster->ReplacedOnDate | string | date-time |\r\n| sequenceNumber | MaterialMaster->SequenceNumber | integer | int32 |\r\n| unitOfMeasurementId | MaterialMaster->UnitOfMeasurement_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| barcode | Min Length | >= 1 chars| |\r\n| barcode | Max Length | <= 50 chars| |\r\n| classification | Min Length | >= 1 chars| |\r\n| classification | Max Length | <= 50 chars| |\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| commodityId | Required | True | |\r\n| commodityId | Nullable | False | |\r\n| costElementId | Required | True | |\r\n| costElementId | 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| highLifeExpectancy | Min Value | >= 00:00:00| |\r\n| itemSize | Min Length | >= 1 chars| |\r\n| itemSize | Max Length | <= 50 chars| |\r\n| isInsuranceItem | Required | True | |\r\n| isInsuranceItem | Nullable | False | |\r\n| isStockItem | Required | True | |\r\n| isStockItem | Nullable | False | |\r\n| leadTime | Min Value | >= 00:00:00| |\r\n| lowLifeExpectancy | Min Value | >= 00:00:00| |\r\n| maximumLevel | Min Value | >= 0| |\r\n| minimumLevel | Min Value | >= 0| |\r\n| notes | Min Length | >= 1 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| unitOfMeasurementId | Required | True | |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "CreateMaterialMaster", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateMaterialMasterResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Lookups/LookupMaterialMasterCategory": { "get": { "tags": [ "Material Master" ], "summary": "Lookup the Category for the Material Master.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Category->Id | integer | int64 |\r\n| code | Category->Code | string | |\r\n| description | Category->Description | string | |\r\n", "operationId": "LookupMaterialMasterCategory", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Category collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterCategoryLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Lookups/LookupMaterialMasterChangePermissionTree": { "get": { "tags": [ "Material Master" ], "summary": "Lookup the permission set for changing the Material Master.", "description": "### Response Body\r\n#### Payload\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": "LookupMaterialMasterChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Lookups/LookupMaterialMasterCommodity": { "get": { "tags": [ "Material Master" ], "summary": "Lookup the Commodity for the Material Master.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Commodity->Id | integer | int64 |\r\n| code | Commodity->Code | string | |\r\n| description | Commodity->Description | string | |\r\n", "operationId": "LookupMaterialMasterCommodity", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Commodity collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterCommodityLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Lookups/LookupMaterialMasterCostElement": { "get": { "tags": [ "Material Master" ], "summary": "Lookup the Cost Element for the Material Master.", "description": "### Response Body\r\n#### Payload\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": "LookupMaterialMasterCostElement", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Cost Element collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterCostElementLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Lookups/LookupMaterialMasterDefaultBin": { "get": { "tags": [ "Material Master" ], "summary": "Lookup the Material Master Bin for the Material Master.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MaterialMasterBin->Id | integer | int64 |\r\n| code | MaterialMasterBin->Code | string | |\r\n", "operationId": "LookupMaterialMasterDefaultBin", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Material Master Bin collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterDefaultBinLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Lookups/LookupMaterialMasterDefaultSupplier": { "get": { "tags": [ "Material Master" ], "summary": "Lookup the Material Master Supplier for the Material Master.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MaterialMasterSupplier->Id | integer | int64 |\r\n| supplierId | MaterialMasterSupplier->Supplier_Id | integer | int64 |\r\n| supplierCode | MaterialMasterSupplier->Supplier_Code | string | |\r\n| supplierDescription | MaterialMasterSupplier->Supplier_Description | string | |\r\n", "operationId": "LookupMaterialMasterDefaultSupplier", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Material Master Supplier collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterDefaultSupplierLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Lookups/LookupMaterialMasterInsertPermissionTree": { "get": { "tags": [ "Material Master" ], "summary": "Lookup the permission set for creating the Material Master.", "description": "### Response Body\r\n#### Payload\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": "LookupMaterialMasterInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Lookups/LookupMaterialMasterLinkWarehouses": { "get": { "tags": [ "Material Master" ], "summary": "Lookup up the Warehouse to include for merging", "description": "### Response Body\r\n#### Payload\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": "LookupMaterialMasterLinkWarehouses", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Warehouse collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterLinkWarehouseLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Lookups/LookupMaterialMasterReplaceWithMaterialMaster": { "get": { "tags": [ "Material Master" ], "summary": "Lookup the Material Master for the Material Master.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MaterialMaster->Id | integer | int64 |\r\n| code | MaterialMaster->Code | string | |\r\n| description | MaterialMaster->Description | string | |\r\n", "operationId": "LookupMaterialMasterReplaceWithMaterialMaster", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Material Master collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterReplaceWithMaterialMasterLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Lookups/LookupMaterialMasterUnitOfMeasurement": { "get": { "tags": [ "Material Master" ], "summary": "Lookup the Unit Of Measurement for the Material Master.", "description": "### Response Body\r\n#### Payload\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": "LookupMaterialMasterUnitOfMeasurement", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Unit Of Measurement collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterUnitOfMeasurementLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Batch/{ids}": { "get": { "tags": [ "Material Master" ], "summary": "Get a collection of Material Master 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 | MaterialMaster->Code | string | |\r\n| isActive | MaterialMaster->IsActive | boolean | |\r\n| createdByUserId | MaterialMaster->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MaterialMaster->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MaterialMaster->CreatedByUser_FullName | string | |\r\n| createdOn | MaterialMaster->CreatedOn | string | date-time |\r\n| modifiedByUserId | MaterialMaster->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MaterialMaster->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MaterialMaster->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MaterialMaster->ModifiedOn | string | date-time |\r\n| version | MaterialMaster->Version | integer | int32 |\r\n| permissionTreeId | MaterialMaster->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MaterialMaster->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MaterialMaster->PermissionTree_Description | string | |\r\n| id | MaterialMaster->Id | integer | int64 |\r\n| alternativeDescription | MaterialMaster->AlternativeDescription | string | |\r\n| barcode | MaterialMaster->Barcode | string | |\r\n| categoryId | MaterialMaster->Category_Id | integer | int64 |\r\n| categoryCode | MaterialMaster->Category_Code | string | |\r\n| categoryDescription | MaterialMaster->Category_Description | string | |\r\n| classification | MaterialMaster->Classification | string | |\r\n| commodityId | MaterialMaster->Commodity_Id | integer | int64 |\r\n| commodityCode | MaterialMaster->Commodity_Code | string | |\r\n| commodityDescription | MaterialMaster->Commodity_Description | string | |\r\n| costElementId | MaterialMaster->CostElement_Id | integer | int64 |\r\n| costElementCode | MaterialMaster->CostElement_Code | string | |\r\n| costElementDescription | MaterialMaster->CostElement_Description | string | |\r\n| defaultMaterialMasterBinId | MaterialMaster->DefaultMaterialMasterBin_Id | integer | int64 |\r\n| defaultMaterialMasterBinCode | MaterialMaster->DefaultMaterialMasterBin_Code | string | |\r\n| defaultMaterialMasterSupplierId | MaterialMaster->DefaultMaterialMasterSupplier_Id | integer | int64 |\r\n| defaultMaterialMasterSupplierSupplierId | MaterialMaster->DefaultMaterialMasterSupplier_Supplier_Id | integer | int64 |\r\n| defaultMaterialMasterSupplierSupplierCode | MaterialMaster->DefaultMaterialMasterSupplier_Supplier_Code | string | |\r\n| defaultMaterialMasterSupplierSupplierDescription | MaterialMaster->DefaultMaterialMasterSupplier_Supplier_Description | string | |\r\n| description | MaterialMaster->Description | string | |\r\n| highLifeExpectancy | MaterialMaster->HighLifeExpectancy | string | duration |\r\n| isInsuranceItem | MaterialMaster->IsInsuranceItem | boolean | |\r\n| isStockItem | MaterialMaster->IsStockItem | boolean | |\r\n| itemSize | MaterialMaster->ItemSize | string | |\r\n| leadTime | MaterialMaster->LeadTime | string | duration |\r\n| lowLifeExpectancy | MaterialMaster->LowLifeExpectancy | string | duration |\r\n| maximumLevel | MaterialMaster->MaximumLevel | number | float |\r\n| mediumLifeExpectancy | MaterialMaster->MediumLifeExpectancy | string | duration |\r\n| minimumLevel | MaterialMaster->MinimumLevel | number | float |\r\n| notes | MaterialMaster->Notes | string | |\r\n| partsReplacementMethod | MaterialMaster->PartsReplacementMethod | string (Allowed values: [Physical, Preferred, TypeSideOnly, Unknown]) | enum |\r\n| replaceByDate | MaterialMaster->ReplaceByDate | string | date-time |\r\n| replacedOnDate | MaterialMaster->ReplacedOnDate | string | date-time |\r\n| replaceWithMaterialMasterId | MaterialMaster->ReplaceWithMaterialMaster_Id | integer | int64 |\r\n| replaceWithMaterialMasterCode | MaterialMaster->ReplaceWithMaterialMaster_Code | string | |\r\n| replaceWithMaterialMasterDescription | MaterialMaster->ReplaceWithMaterialMaster_Description | string | |\r\n| sequenceNumber | MaterialMaster->SequenceNumber | integer | int32 |\r\n| unitOfMeasurementId | MaterialMaster->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | MaterialMaster->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | MaterialMaster->UnitOfMeasurement_Description | string | |\r\n", "operationId": "BatchGetMaterialMaster", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Material Master id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Material Master collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetMaterialMasterResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Batch": { "post": { "tags": [ "Material Master" ], "summary": "Create a new collection of Material Master resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| alternativeDescription | MaterialMaster->AlternativeDescription | string | |\r\n| barcode | MaterialMaster->Barcode | string | |\r\n| categoryId | MaterialMaster->Category_Id | integer | int64 |\r\n| classification | MaterialMaster->Classification | string | |\r\n| code | MaterialMaster->Code | string | |\r\n| commodityId | MaterialMaster->Commodity_Id | integer | int64 |\r\n| costElementId | MaterialMaster->CostElement_Id | integer | int64 |\r\n| description | MaterialMaster->Description | string | |\r\n| highLifeExpectancy | MaterialMaster->HighLifeExpectancy | string | duration |\r\n| itemSize | MaterialMaster->ItemSize | string | |\r\n| isInsuranceItem | MaterialMaster->IsInsuranceItem | boolean | |\r\n| isStockItem | MaterialMaster->IsStockItem | boolean | |\r\n| leadTime | MaterialMaster->LeadTime | string | duration |\r\n| lowLifeExpectancy | MaterialMaster->LowLifeExpectancy | string | duration |\r\n| maximumLevel | MaterialMaster->MaximumLevel | number | float |\r\n| mediumLifeExpectancy | MaterialMaster->MediumLifeExpectancy | string | duration |\r\n| minimumLevel | MaterialMaster->MinimumLevel | number | float |\r\n| notes | MaterialMaster->Notes | string | |\r\n| partsReplacementMethod | MaterialMaster->PartsReplacementMethod | string (Allowed values: [Physical, Preferred, TypeSideOnly, Unknown]) | enum |\r\n| permissionTreeId | MaterialMaster->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | MaterialMaster->SequenceNumber | integer | int32 |\r\n| unitOfMeasurementId | MaterialMaster->UnitOfMeasurement_Id | integer | int64 |\r\n| replaceWithMaterialMasterId | MaterialMaster->ReplaceWithMaterialMaster_Id | integer | int64 |\r\n| replaceByDate | MaterialMaster->ReplaceByDate | string | date-time |\r\n| replacedOnDate | MaterialMaster->ReplacedOnDate | string | date-time |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| barcode | Min Length | >= 1 chars| |\r\n| barcode | Max Length | <= 50 chars| |\r\n| classification | Min Length | >= 1 chars| |\r\n| classification | Max Length | <= 50 chars| |\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| commodityId | Required | True | |\r\n| commodityId | Nullable | False | |\r\n| costElementId | Required | True | |\r\n| costElementId | 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| highLifeExpectancy | Min Value | >= 00:00:00| |\r\n| itemSize | Min Length | >= 1 chars| |\r\n| itemSize | Max Length | <= 50 chars| |\r\n| isInsuranceItem | Required | True | |\r\n| isInsuranceItem | Nullable | False | |\r\n| isStockItem | Required | True | |\r\n| isStockItem | Nullable | False | |\r\n| leadTime | Min Value | >= 00:00:00| |\r\n| lowLifeExpectancy | Min Value | >= 00:00:00| |\r\n| maximumLevel | Min Value | >= 0| |\r\n| minimumLevel | Min Value | >= 0| |\r\n| notes | Min Length | >= 1 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| unitOfMeasurementId | Required | True | |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateMaterialMaster", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateMaterialMasterResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Material Master batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Material Master" ], "summary": "Update a collection of existing Material Master resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MaterialMaster->Id | integer | int64 |\r\n| version | MaterialMaster->Version | integer | int32 |\r\n| alternativeDescription | MaterialMaster->AlternativeDescription | string | |\r\n| barcode | MaterialMaster->Barcode | string | |\r\n| categoryId | MaterialMaster->Category_Id | integer | int64 |\r\n| classification | MaterialMaster->Classification | string | |\r\n| code | MaterialMaster->Code | string | |\r\n| commodityId | MaterialMaster->Commodity_Id | integer | int64 |\r\n| costElementId | MaterialMaster->CostElement_Id | integer | int64 |\r\n| defaultMaterialMasterBinId | MaterialMaster->DefaultMaterialMasterBin_Id | integer | int64 |\r\n| defaultMaterialMasterSupplierId | MaterialMaster->DefaultMaterialMasterSupplier_Id | integer | int64 |\r\n| description | MaterialMaster->Description | string | |\r\n| highLifeExpectancy | MaterialMaster->HighLifeExpectancy | string | duration |\r\n| itemSize | MaterialMaster->ItemSize | string | |\r\n| isInsuranceItem | MaterialMaster->IsInsuranceItem | boolean | |\r\n| isStockItem | MaterialMaster->IsStockItem | boolean | |\r\n| leadTime | MaterialMaster->LeadTime | string | duration |\r\n| lowLifeExpectancy | MaterialMaster->LowLifeExpectancy | string | duration |\r\n| maximumLevel | MaterialMaster->MaximumLevel | number | float |\r\n| mediumLifeExpectancy | MaterialMaster->MediumLifeExpectancy | string | duration |\r\n| minimumLevel | MaterialMaster->MinimumLevel | number | float |\r\n| notes | MaterialMaster->Notes | string | |\r\n| partsReplacementMethod | MaterialMaster->PartsReplacementMethod | string (Allowed values: [Physical, Preferred, TypeSideOnly, Unknown]) | enum |\r\n| sequenceNumber | MaterialMaster->SequenceNumber | integer | int32 |\r\n| unitOfMeasurementId | MaterialMaster->UnitOfMeasurement_Id | integer | int64 |\r\n| replaceWithMaterialMasterId | MaterialMaster->ReplaceWithMaterialMaster_Id | integer | int64 |\r\n| replaceByDate | MaterialMaster->ReplaceByDate | string | date-time |\r\n| replacedOnDate | MaterialMaster->ReplacedOnDate | string | date-time |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| barcode | Min Length | >= 1 chars| |\r\n| barcode | Max Length | <= 50 chars| |\r\n| classification | Min Length | >= 1 chars| |\r\n| classification | Max Length | <= 50 chars| |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| commodityId | Nullable | False | |\r\n| costElementId | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| highLifeExpectancy | Min Value | >= 00:00:00| |\r\n| itemSize | Min Length | >= 1 chars| |\r\n| itemSize | Max Length | <= 50 chars| |\r\n| isInsuranceItem | Nullable | False | |\r\n| isStockItem | Nullable | False | |\r\n| leadTime | Min Value | >= 00:00:00| |\r\n| lowLifeExpectancy | Min Value | >= 00:00:00| |\r\n| maximumLevel | Min Value | >= 0| |\r\n| minimumLevel | Min Value | >= 0| |\r\n| notes | Min Length | >= 1 chars| |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateMaterialMaster", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateMaterialMasterResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Material Master batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Material Master" ], "summary": "Delete a collection of existing Material Master resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MaterialMaster->Id | integer | int64 |\r\n| version | MaterialMaster->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": "BatchDeleteMaterialMaster", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteMaterialMasterResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Material Master batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/{id}/Active": { "patch": { "tags": [ "Material Master" ], "summary": "Change the IsActive status for an existing Material Master resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MaterialMaster->Version | integer | int32 |\r\n| isActive | MaterialMaster->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": "ChangeMaterialMasterIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMaterialMasterIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/{id}/PermissionTree": { "patch": { "tags": [ "Material Master" ], "summary": "Change the PermissionTree for an existing Material Master resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MaterialMaster->Version | integer | int32 |\r\n| permissionTreeId | MaterialMaster->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": "ChangeMaterialMasterPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMaterialMasterPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/LinkWarehouses": { "post": { "tags": [ "Material Master" ], "summary": "Link several Warehouse and Material Master together.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| sourceMaterialMasterIds | MaterialMasterLinkWarehouse->SourceMaterialMasterIds | array | array |\r\n| targetWarehouseIds | MaterialMasterLinkWarehouse->TargetWarehouseIds | 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| sourceMaterialMasterIds | Required | True | |\r\n| sourceMaterialMasterIds | Nullable | False | |\r\n| targetWarehouseIds | Required | True | |\r\n| targetWarehouseIds | Nullable | False | |\r\n\r\n", "operationId": "MaterialMasterLinkWarehouses", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterLinkWarehouseResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Batch/Active": { "patch": { "tags": [ "Material Master" ], "summary": "Change the IsActive status for a collection of existing Material Master resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MaterialMaster->Id | integer | int64 |\r\n| version | MaterialMaster->Version | integer | int32 |\r\n| isActive | MaterialMaster->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": "BatchChangeMaterialMasterIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMaterialMasterIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Batch/PermissionTree": { "patch": { "tags": [ "Material Master" ], "summary": "Change the PermissionTree status for a collection of existing Material Master resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MaterialMaster->Id | integer | int64 |\r\n| version | MaterialMaster->Version | integer | int32 |\r\n| permissionTreeId | MaterialMaster->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": "BatchChangeMaterialMasterPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMaterialMasterPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Attributes/{id}": { "get": { "tags": [ "Material Master Attribute" ], "summary": "Get a collection of Material Master Attribute resources for the Material Master.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| materialMasterId | MaterialMasterAttribute->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | MaterialMasterAttribute->MaterialMaster_Code | string | |\r\n| materialMasterDescription | MaterialMasterAttribute->MaterialMaster_Description | string | |\r\n| createdByUserId | MaterialMasterAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MaterialMasterAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MaterialMasterAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | MaterialMasterAttribute->CreatedOn | string | date-time |\r\n| isActive | MaterialMasterAttribute->IsActive | boolean | |\r\n| modifiedByUserId | MaterialMasterAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MaterialMasterAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MaterialMasterAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MaterialMasterAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | MaterialMasterAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MaterialMasterAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MaterialMasterAttribute->PermissionTree_Description | string | |\r\n| version | MaterialMasterAttribute->Version | integer | int32 |\r\n| id | MaterialMasterAttribute->Id | integer | int64 |\r\n| attributeId | MaterialMasterAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | MaterialMasterAttribute->Attribute_Code | string | |\r\n| attributeDescription | MaterialMasterAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | MaterialMasterAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | MaterialMasterAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | MaterialMasterAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | MaterialMasterAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | MaterialMasterAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | MaterialMasterAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | MaterialMasterAttribute->Notes | string | |\r\n| predefinedValueId | MaterialMasterAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | MaterialMasterAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | MaterialMasterAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | MaterialMasterAttribute->SequenceNumber | integer | int32 |\r\n| value | MaterialMasterAttribute->Value | object | composite |\r\n", "operationId": "GetMaterialMasterAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Material Master Attribute", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMaterialMasterAttributeResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Material Master Attribute" ], "summary": "Update an existing Material Master 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 | MaterialMasterAttribute->Version | integer | int32 |\r\n| value | MaterialMasterAttribute->Value | object | composite |\r\n| predefinedValueId | MaterialMasterAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | MaterialMasterAttribute->SequenceNumber | integer | int32 |\r\n| notes | MaterialMasterAttribute->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": "UpdateMaterialMasterAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateMaterialMasterAttributeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Material Master Attribute was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Material Master Attribute" ], "summary": "Delete an existing Material Master 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 | MaterialMasterAttribute->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": "DeleteMaterialMasterAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteMaterialMasterAttributeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Material Master Attribute was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/{materialMasterId}/Attributes": { "get": { "tags": [ "Material Master Attribute" ], "summary": "Get a collection of Material Master Attribute resources for the Material Master.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MaterialMasterAttribute->Id | integer | int64 |\r\n| version | MaterialMasterAttribute->Version | integer | int32 |\r\n| sequenceNumber | MaterialMasterAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | MaterialMasterAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | MaterialMasterAttribute->Attribute_Code | string | |\r\n| attributeDescription | MaterialMasterAttribute->Attribute_Description | string | |\r\n| attributeDataType | MaterialMasterAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | MaterialMasterAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | MaterialMasterAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | MaterialMasterAttribute->PredefinedValue_Value | object | composite |\r\n| value | MaterialMasterAttribute->Value | object | composite |\r\n| notes | MaterialMasterAttribute->Notes | string | |\r\n| createdOn | MaterialMasterAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | MaterialMasterAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetMaterialMasterAttributeCollectionForMaterialMaster", "parameters": [ { "name": "materialMasterId", "in": "path", "required": true, "description": "Material Master Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Material Master Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMaterialMasterAttributeCollectionForMaterialMasterResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Attributes": { "get": { "tags": [ "Material Master Attribute" ], "summary": "Get a collection of Material Master 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 | MaterialMasterAttribute->Id | integer | int64 |\r\n| version | MaterialMasterAttribute->Version | integer | int32 |\r\n| sequenceNumber | MaterialMasterAttribute->SequenceNumber | integer | int32 |\r\n| materialMasterCode | MaterialMasterAttribute->MaterialMaster_Code | string | |\r\n| materialMasterDescription | MaterialMasterAttribute->MaterialMaster_Description | string | |\r\n| attributeId | MaterialMasterAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | MaterialMasterAttribute->Attribute_Code | string | |\r\n| attributeDescription | MaterialMasterAttribute->Attribute_Description | string | |\r\n| attributeDataType | MaterialMasterAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | MaterialMasterAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | MaterialMasterAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | MaterialMasterAttribute->PredefinedValue_Value | object | composite |\r\n| value | MaterialMasterAttribute->Value | object | composite |\r\n| notes | MaterialMasterAttribute->Notes | string | |\r\n| createdOn | MaterialMasterAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | MaterialMasterAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetMaterialMasterAttributeCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Material Master Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMaterialMasterAttributeCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Material Master Attribute" ], "summary": "Create a new Material Master 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| materialMasterId | MaterialMasterAttribute->MaterialMaster_Id | integer | int64 |\r\n| attributeId | MaterialMasterAttribute->Attribute_Id | integer | int64 |\r\n| value | MaterialMasterAttribute->Value | object | composite |\r\n| predefinedValueId | MaterialMasterAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | MaterialMasterAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | MaterialMasterAttribute->SequenceNumber | integer | int32 |\r\n| notes | MaterialMasterAttribute->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| materialMasterId | Required | True | |\r\n| materialMasterId | 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": "CreateMaterialMasterAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateMaterialMasterAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Attributes/Lookups/LookupMaterialMasterAttributeAllowedValue": { "get": { "tags": [ "Material Master Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Material Master 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": "LookupMaterialMasterAttributeAllowedValue", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Attribute Allowed Value collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterAttributeAttributeAllowedValueLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Attributes/Lookups/LookupMaterialMasterAttribute": { "get": { "tags": [ "Material Master Attribute" ], "summary": "Lookup the Attribute for the Material Master 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": "LookupMaterialMasterAttribute", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterAttributeAttributeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Attributes/Lookups/LookupMaterialMasterAttributeChangePermissionTree": { "get": { "tags": [ "Material Master Attribute" ], "summary": "Lookup the permission set for changing the Material Master 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": "LookupMaterialMasterAttributeChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterAttributeChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Attributes/Lookups/LookupMaterialMasterAttributeInsertPermissionTree": { "get": { "tags": [ "Material Master Attribute" ], "summary": "Lookup the permission set for creating the Material Master 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": "LookupMaterialMasterAttributeInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterAttributeInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Attributes/Lookups/LookupMaterialMasterAttributeMaterialMaster": { "get": { "tags": [ "Material Master Attribute" ], "summary": "Lookup the Material Master Attribute for the Material Master 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 | MaterialMaster->Id | integer | int64 |\r\n| code | MaterialMaster->Code | string | |\r\n| description | MaterialMaster->Description | string | |\r\n", "operationId": "LookupMaterialMasterAttributeMaterialMaster", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Material Master collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterAttributeMaterialMasterLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Attributes/Batch/{ids}": { "get": { "tags": [ "Material Master Attribute" ], "summary": "Get a collection of Material Master 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| materialMasterId | MaterialMasterAttribute->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | MaterialMasterAttribute->MaterialMaster_Code | string | |\r\n| materialMasterDescription | MaterialMasterAttribute->MaterialMaster_Description | string | |\r\n| createdByUserId | MaterialMasterAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MaterialMasterAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MaterialMasterAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | MaterialMasterAttribute->CreatedOn | string | date-time |\r\n| isActive | MaterialMasterAttribute->IsActive | boolean | |\r\n| modifiedByUserId | MaterialMasterAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MaterialMasterAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MaterialMasterAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MaterialMasterAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | MaterialMasterAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MaterialMasterAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MaterialMasterAttribute->PermissionTree_Description | string | |\r\n| version | MaterialMasterAttribute->Version | integer | int32 |\r\n| id | MaterialMasterAttribute->Id | integer | int64 |\r\n| attributeId | MaterialMasterAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | MaterialMasterAttribute->Attribute_Code | string | |\r\n| attributeDescription | MaterialMasterAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | MaterialMasterAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | MaterialMasterAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | MaterialMasterAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | MaterialMasterAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | MaterialMasterAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | MaterialMasterAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | MaterialMasterAttribute->Notes | string | |\r\n| predefinedValueId | MaterialMasterAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | MaterialMasterAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | MaterialMasterAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | MaterialMasterAttribute->SequenceNumber | integer | int32 |\r\n| value | MaterialMasterAttribute->Value | object | composite |\r\n", "operationId": "BatchGetMaterialMasterAttribute", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Material Master Attribute id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Material Master Attribute collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetMaterialMasterAttributeResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Attributes/Batch": { "post": { "tags": [ "Material Master Attribute" ], "summary": "Create a new collection of Material Master 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| materialMasterId | MaterialMasterAttribute->MaterialMaster_Id | integer | int64 |\r\n| attributeId | MaterialMasterAttribute->Attribute_Id | integer | int64 |\r\n| value | MaterialMasterAttribute->Value | object | composite |\r\n| predefinedValueId | MaterialMasterAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | MaterialMasterAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | MaterialMasterAttribute->SequenceNumber | integer | int32 |\r\n| notes | MaterialMasterAttribute->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| materialMasterId | Required | True | |\r\n| materialMasterId | 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": "BatchCreateMaterialMasterAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateMaterialMasterAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Material Master Attribute batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Material Master Attribute" ], "summary": "Update a collection of existing Material Master 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 | MaterialMasterAttribute->Id | integer | int64 |\r\n| version | MaterialMasterAttribute->Version | integer | int32 |\r\n| value | MaterialMasterAttribute->Value | object | composite |\r\n| predefinedValueId | MaterialMasterAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | MaterialMasterAttribute->SequenceNumber | integer | int32 |\r\n| notes | MaterialMasterAttribute->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": "BatchUpdateMaterialMasterAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateMaterialMasterAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Material Master Attribute batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Material Master Attribute" ], "summary": "Delete a collection of existing Material Master 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 | MaterialMasterAttribute->Id | integer | int64 |\r\n| version | MaterialMasterAttribute->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": "BatchDeleteMaterialMasterAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteMaterialMasterAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Material Master Attribute batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Attributes/{id}/Active": { "patch": { "tags": [ "Material Master Attribute" ], "summary": "Change the IsActive status for an existing Material Master 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 | MaterialMasterAttribute->Version | integer | int32 |\r\n| isActive | MaterialMasterAttribute->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": "ChangeMaterialMasterAttributeIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMaterialMasterAttributeIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Material Master Attribute" ], "summary": "Change the PermissionTree for an existing Material Master 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 | MaterialMasterAttribute->Version | integer | int32 |\r\n| permissionTreeId | MaterialMasterAttribute->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": "ChangeMaterialMasterAttributePermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMaterialMasterAttributePermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Attributes/Batch/Active": { "patch": { "tags": [ "Material Master Attribute" ], "summary": "Change the IsActive status for a collection of existing Material Master 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 | MaterialMasterAttribute->Id | integer | int64 |\r\n| version | MaterialMasterAttribute->Version | integer | int32 |\r\n| isActive | MaterialMasterAttribute->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": "BatchChangeMaterialMasterAttributeIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMaterialMasterAttributeIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Material Master Attribute" ], "summary": "Change the PermissionTree status for a collection of existing Material Master 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 | MaterialMasterAttribute->Id | integer | int64 |\r\n| version | MaterialMasterAttribute->Version | integer | int32 |\r\n| permissionTreeId | MaterialMasterAttribute->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": "BatchChangeMaterialMasterAttributePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMaterialMasterAttributePermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Bins/{id}": { "get": { "tags": [ "Material Master Bin" ], "summary": "Get a Material Master Bin 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 | MaterialMasterBin->IsActive | boolean | |\r\n| createdByUserId | MaterialMasterBin->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MaterialMasterBin->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MaterialMasterBin->CreatedByUser_FullName | string | |\r\n| createdOn | MaterialMasterBin->CreatedOn | string | date-time |\r\n| modifiedByUserId | MaterialMasterBin->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MaterialMasterBin->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MaterialMasterBin->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MaterialMasterBin->ModifiedOn | string | date-time |\r\n| version | MaterialMasterBin->Version | integer | int32 |\r\n| permissionTreeId | MaterialMasterBin->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MaterialMasterBin->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MaterialMasterBin->PermissionTree_Description | string | |\r\n| id | MaterialMasterBin->Id | integer | int64 |\r\n| code | MaterialMasterBin->Code | string | |\r\n| materialMasterId | MaterialMasterBin->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | MaterialMasterBin->MaterialMaster_Code | string | |\r\n| materialMasterDescription | MaterialMasterBin->MaterialMaster_Description | string | |\r\n| notes | MaterialMasterBin->Notes | string | |\r\n| sequenceNumber | MaterialMasterBin->SequenceNumber | integer | int32 |\r\n", "operationId": "GetMaterialMasterBin", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Bin Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Material Master Bin", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMaterialMasterBinResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Material Master Bin" ], "summary": "Update an existing Material Master Bin resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MaterialMasterBin->Version | integer | int32 |\r\n| code | MaterialMasterBin->Code | string | |\r\n| notes | MaterialMasterBin->Notes | string | |\r\n| sequenceNumber | MaterialMasterBin->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| notes | Min Length | >= 1 chars| |\r\n\r\n", "operationId": "UpdateMaterialMasterBin", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Bin Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateMaterialMasterBinResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Material Master Bin was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Material Master Bin" ], "summary": "Delete an existing Material Master Bin resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MaterialMasterBin->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": "DeleteMaterialMasterBin", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Bin Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteMaterialMasterBinResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Material Master Bin was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Bins": { "get": { "tags": [ "Material Master Bin" ], "summary": "Get a collection of Material Master Bin 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 | MaterialMasterBin->Id | integer | int64 |\r\n| materialMasterCode | MaterialMasterBin->MaterialMaster_Code | string | |\r\n| code | MaterialMasterBin->Code | string | |\r\n| sequenceNumber | MaterialMasterBin->SequenceNumber | integer | int32 |\r\n| notes | MaterialMasterBin->Notes | string | |\r\n| version | MaterialMasterBin->Version | integer | int32 |\r\n", "operationId": "GetMaterialMasterBinCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Material Master Bin collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMaterialMasterBinCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Material Master Bin" ], "summary": "Create a new Material Master Bin resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| materialMasterId | MaterialMasterBin->MaterialMaster_Id | integer | int64 |\r\n| code | MaterialMasterBin->Code | string | |\r\n| notes | MaterialMasterBin->Notes | string | |\r\n| permissionTreeId | MaterialMasterBin->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | MaterialMasterBin->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| materialMasterId | Required | True | |\r\n| materialMasterId | 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| notes | Min Length | >= 1 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateMaterialMasterBin", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateMaterialMasterBinResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/{materialMasterId}/Bins": { "get": { "tags": [ "Material Master Bin" ], "summary": "Get a collection of Material Master Bin resources for the Material Master.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MaterialMasterBin->Id | integer | int64 |\r\n| version | MaterialMasterBin->Version | integer | int32 |\r\n| code | MaterialMasterBin->Code | string | |\r\n| notes | MaterialMasterBin->Notes | string | |\r\n| sequenceNumber | MaterialMasterBin->SequenceNumber | integer | int32 |\r\n", "operationId": "GetMaterialMasterBinForMaterialMasterCollection", "parameters": [ { "name": "materialMasterId", "in": "path", "required": true, "description": "Material Master Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Material Master Bin collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMaterialMasterBinForMaterialMasterCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Bins/Lookups/LookupMaterialMasterBinChangePermissionTree": { "get": { "tags": [ "Material Master Bin" ], "summary": "Lookup the permission set for changing the Material Master Bin.", "description": "### Response Body\r\n#### Payload\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": "LookupMaterialMasterBinChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterBinChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Bins/Lookups/LookupMaterialMasterBinInsertPermissionTree": { "get": { "tags": [ "Material Master Bin" ], "summary": "Lookup the permission set for creating the Material Master Bin.", "description": "### Response Body\r\n#### Payload\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": "LookupMaterialMasterBinInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterBinInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Bins/Lookups/LookupMaterialMasterBinMaterialMaster": { "get": { "tags": [ "Material Master Bin" ], "summary": "Lookup the Competency for the Material Master Bin.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MaterialMaster->Id | integer | int64 |\r\n| code | MaterialMaster->Code | string | |\r\n| description | MaterialMaster->Description | string | |\r\n", "operationId": "LookupMaterialMasterBinMaterialMaster", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Material Master collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterBinMaterialMasterLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Bins/Batch/{ids}": { "get": { "tags": [ "Material Master Bin" ], "summary": "Get a collection of Material Master Bin 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 | MaterialMasterBin->IsActive | boolean | |\r\n| createdByUserId | MaterialMasterBin->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MaterialMasterBin->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MaterialMasterBin->CreatedByUser_FullName | string | |\r\n| createdOn | MaterialMasterBin->CreatedOn | string | date-time |\r\n| modifiedByUserId | MaterialMasterBin->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MaterialMasterBin->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MaterialMasterBin->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MaterialMasterBin->ModifiedOn | string | date-time |\r\n| version | MaterialMasterBin->Version | integer | int32 |\r\n| permissionTreeId | MaterialMasterBin->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MaterialMasterBin->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MaterialMasterBin->PermissionTree_Description | string | |\r\n| id | MaterialMasterBin->Id | integer | int64 |\r\n| code | MaterialMasterBin->Code | string | |\r\n| materialMasterId | MaterialMasterBin->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | MaterialMasterBin->MaterialMaster_Code | string | |\r\n| materialMasterDescription | MaterialMasterBin->MaterialMaster_Description | string | |\r\n| notes | MaterialMasterBin->Notes | string | |\r\n| sequenceNumber | MaterialMasterBin->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetMaterialMasterBin", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Material Master Bin id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Material Master Bin collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetMaterialMasterBinResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Bins/Batch": { "post": { "tags": [ "Material Master Bin" ], "summary": "Create a new collection of Material Master Bin resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| materialMasterId | MaterialMasterBin->MaterialMaster_Id | integer | int64 |\r\n| code | MaterialMasterBin->Code | string | |\r\n| notes | MaterialMasterBin->Notes | string | |\r\n| permissionTreeId | MaterialMasterBin->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | MaterialMasterBin->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| materialMasterId | Required | True | |\r\n| materialMasterId | 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| notes | Min Length | >= 1 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateMaterialMasterBin", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateMaterialMasterBinResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Material Master Bin batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Material Master Bin" ], "summary": "Update a collection of existing Material Master Bin resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MaterialMasterBin->Id | integer | int64 |\r\n| version | MaterialMasterBin->Version | integer | int32 |\r\n| code | MaterialMasterBin->Code | string | |\r\n| notes | MaterialMasterBin->Notes | string | |\r\n| sequenceNumber | MaterialMasterBin->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| notes | Min Length | >= 1 chars| |\r\n\r\n", "operationId": "BatchUpdateMaterialMasterBin", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateMaterialMasterBinResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Material Master Bin batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Material Master Bin" ], "summary": "Delete a collection of existing Material Master Bin resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MaterialMasterBin->Id | integer | int64 |\r\n| version | MaterialMasterBin->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": "BatchDeleteMaterialMasterBin", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteMaterialMasterBinResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Material Master Bin batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Bins/{id}/Active": { "patch": { "tags": [ "Material Master Bin" ], "summary": "Change the IsActive status for an existing Material Master Bin resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MaterialMasterBin->Version | integer | int32 |\r\n| isActive | MaterialMasterBin->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": "ChangeMaterialMasterBinIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Bin Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMaterialMasterBinIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Bins/{id}/PermissionTree": { "patch": { "tags": [ "Material Master Bin" ], "summary": "Change the PermissionTree for an existing Material Master Bin resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MaterialMasterBin->Version | integer | int32 |\r\n| permissionTreeId | MaterialMasterBin->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": "ChangeMaterialMasterBinPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Bin Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMaterialMasterBinPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Bins/Batch/Active": { "patch": { "tags": [ "Material Master Bin" ], "summary": "Change the IsActive status for a collection of existing Material Master Bin resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MaterialMasterBin->Id | integer | int64 |\r\n| version | MaterialMasterBin->Version | integer | int32 |\r\n| isActive | MaterialMasterBin->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": "BatchChangeMaterialMasterBinIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMaterialMasterBinIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Bins/Batch/PermissionTree": { "patch": { "tags": [ "Material Master Bin" ], "summary": "Change the PermissionTree status for a collection of existing Material Master Bin resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MaterialMasterBin->Id | integer | int64 |\r\n| version | MaterialMasterBin->Version | integer | int32 |\r\n| permissionTreeId | MaterialMasterBin->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": "BatchChangeMaterialMasterBinPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMaterialMasterBinPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Documents/{id}": { "get": { "tags": [ "Material Master Document" ], "summary": "Get a Material Master 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| materialMasterId | MaterialMasterDocument->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | MaterialMasterDocument->MaterialMaster_Code | string | |\r\n| materialMasterDescription | MaterialMasterDocument->MaterialMaster_Description | string | |\r\n| isActive | MaterialMasterDocument->IsActive | boolean | |\r\n| createdByUserId | MaterialMasterDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MaterialMasterDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MaterialMasterDocument->CreatedByUser_FullName | string | |\r\n| createdOn | MaterialMasterDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | MaterialMasterDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MaterialMasterDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MaterialMasterDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MaterialMasterDocument->ModifiedOn | string | date-time |\r\n| version | MaterialMasterDocument->Version | integer | int32 |\r\n| permissionTreeId | MaterialMasterDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MaterialMasterDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MaterialMasterDocument->PermissionTree_Description | string | |\r\n| id | MaterialMasterDocument->Id | integer | int64 |\r\n| documentRecordId | MaterialMasterDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | MaterialMasterDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | MaterialMasterDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | MaterialMasterDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | MaterialMasterDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | MaterialMasterDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | MaterialMasterDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | MaterialMasterDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | MaterialMasterDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | MaterialMasterDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | MaterialMasterDocument->Notes | string | |\r\n| sequenceNumber | MaterialMasterDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetMaterialMasterDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Material Master Document", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMaterialMasterDocumentResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Material Master Document" ], "summary": "Update an existing Material Master 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 | MaterialMasterDocument->Version | integer | int32 |\r\n| sequenceNumber | MaterialMasterDocument->SequenceNumber | integer | int32 |\r\n| notes | MaterialMasterDocument->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": "UpdateMaterialMasterDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateMaterialMasterDocumentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Material Master Document was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Material Master Document" ], "summary": "Delete an existing Material Master 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 | MaterialMasterDocument->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": "DeleteMaterialMasterDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteMaterialMasterDocumentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Material Master Document was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/{id}/Documents": { "get": { "tags": [ "Material Master Document" ], "summary": "Get a collection of Material Master Document resources for the Material Master.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MaterialMasterDocument->Id | integer | int64 |\r\n| version | MaterialMasterDocument->Version | integer | int32 |\r\n| sequenceNumber | MaterialMasterDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | MaterialMasterDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | MaterialMasterDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | MaterialMasterDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | MaterialMasterDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | MaterialMasterDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | MaterialMasterDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | MaterialMasterDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetMaterialMasterDocumentCollectionForMaterialMaster", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Material Master Document collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMaterialMasterDocumentCollectionForMaterialMasterResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Documents": { "get": { "tags": [ "Material Master Document" ], "summary": "Get a collection of Material Master 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 | MaterialMasterDocument->Id | integer | int64 |\r\n| version | MaterialMasterDocument->Version | integer | int32 |\r\n| materialMasterId | MaterialMasterDocument->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | MaterialMasterDocument->MaterialMaster_Code | string | |\r\n| materialMasterDescription | MaterialMasterDocument->MaterialMaster_Description | string | |\r\n| sequenceNumber | MaterialMasterDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | MaterialMasterDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | MaterialMasterDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | MaterialMasterDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | MaterialMasterDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | MaterialMasterDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | MaterialMasterDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | MaterialMasterDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetMaterialMasterDocumentCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Material Master Document collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMaterialMasterDocumentCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Material Master Document" ], "summary": "Create a new Material Master 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| materialMasterId | MaterialMasterDocument->MaterialMaster_Id | integer | int64 |\r\n| documentRecordId | MaterialMasterDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | MaterialMasterDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | MaterialMasterDocument->SequenceNumber | integer | int32 |\r\n| notes | MaterialMasterDocument->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| materialMasterId | Required | True | |\r\n| materialMasterId | 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": "CreateMaterialMasterDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateMaterialMasterDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Documents/Lookups/LookupMaterialMasterDocumentChangePermissionTree": { "get": { "tags": [ "Material Master Document" ], "summary": "Lookup the permission set for changing the Material Master 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": "LookupMaterialMasterDocumentChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterDocumentChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Documents/Lookups/LookupMaterialMasterDocument": { "get": { "tags": [ "Material Master Document" ], "summary": "Material Master 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": "LookupMaterialMasterDocument", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Document Record collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterDocumentDocumentLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Documents/Lookups/LookupMaterialMasterDocumentInsertPermissionTree": { "get": { "tags": [ "Material Master Document" ], "summary": "Lookup the permission set for creating the Material Master 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": "LookupMaterialMasterDocumentInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterDocumentInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Documents/Lookups/LookupMaterialMasterDocumentMaterialMaster": { "get": { "tags": [ "Material Master Document" ], "summary": "Lookup the Material Master Document for the Material Master 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 | MaterialMaster->Id | integer | int64 |\r\n| code | MaterialMaster->Code | string | |\r\n| description | MaterialMaster->Description | string | |\r\n", "operationId": "LookupMaterialMasterDocumentMaterialMaster", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Material Master collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterDocumentMaterialMasterLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Documents/Batch/{ids}": { "get": { "tags": [ "Material Master Document" ], "summary": "Get a collection of Material Master 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| materialMasterId | MaterialMasterDocument->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | MaterialMasterDocument->MaterialMaster_Code | string | |\r\n| materialMasterDescription | MaterialMasterDocument->MaterialMaster_Description | string | |\r\n| isActive | MaterialMasterDocument->IsActive | boolean | |\r\n| createdByUserId | MaterialMasterDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MaterialMasterDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MaterialMasterDocument->CreatedByUser_FullName | string | |\r\n| createdOn | MaterialMasterDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | MaterialMasterDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MaterialMasterDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MaterialMasterDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MaterialMasterDocument->ModifiedOn | string | date-time |\r\n| version | MaterialMasterDocument->Version | integer | int32 |\r\n| permissionTreeId | MaterialMasterDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MaterialMasterDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MaterialMasterDocument->PermissionTree_Description | string | |\r\n| id | MaterialMasterDocument->Id | integer | int64 |\r\n| documentRecordId | MaterialMasterDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | MaterialMasterDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | MaterialMasterDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | MaterialMasterDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | MaterialMasterDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | MaterialMasterDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | MaterialMasterDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | MaterialMasterDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | MaterialMasterDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | MaterialMasterDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | MaterialMasterDocument->Notes | string | |\r\n| sequenceNumber | MaterialMasterDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetMaterialMasterDocument", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Material Master Document id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Material Master Document collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetMaterialMasterDocumentResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Documents/Batch": { "post": { "tags": [ "Material Master Document" ], "summary": "Create a new collection of Material Master 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| materialMasterId | MaterialMasterDocument->MaterialMaster_Id | integer | int64 |\r\n| documentRecordId | MaterialMasterDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | MaterialMasterDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | MaterialMasterDocument->SequenceNumber | integer | int32 |\r\n| notes | MaterialMasterDocument->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| materialMasterId | Required | True | |\r\n| materialMasterId | 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": "BatchCreateMaterialMasterDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateMaterialMasterDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Material Master Document batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Material Master Document" ], "summary": "Update a collection of existing Material Master 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 | MaterialMasterDocument->Id | integer | int64 |\r\n| version | MaterialMasterDocument->Version | integer | int32 |\r\n| sequenceNumber | MaterialMasterDocument->SequenceNumber | integer | int32 |\r\n| notes | MaterialMasterDocument->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": "BatchUpdateMaterialMasterDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateMaterialMasterDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Material Master Document batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Material Master Document" ], "summary": "Delete a collection of existing Material Master 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 | MaterialMasterDocument->Id | integer | int64 |\r\n| version | MaterialMasterDocument->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": "BatchDeleteMaterialMasterDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteMaterialMasterDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Material Master Document batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Documents/{id}/Active": { "patch": { "tags": [ "Material Master Document" ], "summary": "Change the IsActive status for an existing Material Master 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 | MaterialMasterDocument->Version | integer | int32 |\r\n| isActive | MaterialMasterDocument->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": "ChangeMaterialMasterDocumentIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMaterialMasterDocumentIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Material Master Document" ], "summary": "Change the PermissionTree for an existing Material Master 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 | MaterialMasterDocument->Version | integer | int32 |\r\n| permissionTreeId | MaterialMasterDocument->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": "ChangeMaterialMasterDocumentPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMaterialMasterDocumentPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Material Master Document" ], "summary": "Change the PermissionTree status for a collection of existing Material Master 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 | MaterialMasterDocument->Id | integer | int64 |\r\n| version | MaterialMasterDocument->Version | integer | int32 |\r\n| permissionTreeId | MaterialMasterDocument->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": "BatchChangeMaterialMasterDocumentPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMaterialMasterDocumentPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Documents/Batch/Active": { "patch": { "tags": [ "Material Master Document" ], "summary": "Change the IsActive status for a collection of existing Material Master 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 | MaterialMasterDocument->Id | integer | int64 |\r\n| version | MaterialMasterDocument->Version | integer | int32 |\r\n| isActive | MaterialMasterDocument->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": "BatchChangeMaterialMasterDocumentIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMaterialMasterDocumentIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Suppliers/{id}": { "get": { "tags": [ "Material Master Supplier" ], "summary": "Get a Material Master 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| isActive | MaterialMasterSupplier->IsActive | boolean | |\r\n| createdByUserId | MaterialMasterSupplier->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MaterialMasterSupplier->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MaterialMasterSupplier->CreatedByUser_FullName | string | |\r\n| createdOn | MaterialMasterSupplier->CreatedOn | string | date-time |\r\n| modifiedByUserId | MaterialMasterSupplier->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MaterialMasterSupplier->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MaterialMasterSupplier->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MaterialMasterSupplier->ModifiedOn | string | date-time |\r\n| version | MaterialMasterSupplier->Version | integer | int32 |\r\n| permissionTreeId | MaterialMasterSupplier->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MaterialMasterSupplier->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MaterialMasterSupplier->PermissionTree_Description | string | |\r\n| id | MaterialMasterSupplier->Id | integer | int64 |\r\n| leadTime | MaterialMasterSupplier->LeadTime | string | duration |\r\n| materialMasterId | MaterialMasterSupplier->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | MaterialMasterSupplier->MaterialMaster_Code | string | |\r\n| materialMasterDescription | MaterialMasterSupplier->MaterialMaster_Description | string | |\r\n| notes | MaterialMasterSupplier->Notes | string | |\r\n| sequenceNumber | MaterialMasterSupplier->SequenceNumber | integer | int32 |\r\n| supplierId | MaterialMasterSupplier->Supplier_Id | integer | int64 |\r\n| supplierCode | MaterialMasterSupplier->Supplier_Code | string | |\r\n| supplierDescription | MaterialMasterSupplier->Supplier_Description | string | |\r\n| supplierPartNumber | MaterialMasterSupplier->SupplierPartNumber | string | |\r\n", "operationId": "GetMaterialMasterSupplier", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Supplier Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Material Master Supplier", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMaterialMasterSupplierResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Material Master Supplier" ], "summary": "Update an existing Material Master 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 | MaterialMasterSupplier->Version | integer | int32 |\r\n| sequenceNumber | MaterialMasterSupplier->SequenceNumber | integer | int32 |\r\n| supplierPartNumber | MaterialMasterSupplier->SupplierPartNumber | string | |\r\n| leadTime | MaterialMasterSupplier->LeadTime | string | duration |\r\n| notes | MaterialMasterSupplier->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": "UpdateMaterialMasterSupplier", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Supplier Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateMaterialMasterSupplierResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Material Master Supplier was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Material Master Supplier" ], "summary": "Delete an existing Material Master 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 | MaterialMasterSupplier->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": "DeleteMaterialMasterSupplier", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Supplier Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteMaterialMasterSupplierResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Material Master Supplier was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Suppliers": { "get": { "tags": [ "Material Master Supplier" ], "summary": "Get a collection of Material Master 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| id | MaterialMasterSupplier->Id | integer | int64 |\r\n| materialMasterId | MaterialMasterSupplier->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | MaterialMasterSupplier->MaterialMaster_Code | string | |\r\n| supplierId | MaterialMasterSupplier->Supplier_Id | integer | int64 |\r\n| supplierCode | MaterialMasterSupplier->Supplier_Code | string | |\r\n| supplierDescription | MaterialMasterSupplier->Supplier_Description | string | |\r\n| sequenceNumber | MaterialMasterSupplier->SequenceNumber | integer | int32 |\r\n| notes | MaterialMasterSupplier->Notes | string | |\r\n| version | MaterialMasterSupplier->Version | integer | int32 |\r\n", "operationId": "GetMaterialMasterSupplierCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Material Master Supplier collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMaterialMasterSupplierCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Material Master Supplier" ], "summary": "Create a new Material Master 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| leadTime | MaterialMasterSupplier->LeadTime | string | duration |\r\n| materialMasterId | MaterialMasterSupplier->MaterialMaster_Id | integer | int64 |\r\n| supplierId | MaterialMasterSupplier->Supplier_Id | integer | int64 |\r\n| permissionTreeId | MaterialMasterSupplier->PermissionTree_Id | integer | int64 |\r\n| supplierPartNumber | MaterialMasterSupplier->SupplierPartNumber | string | |\r\n| sequenceNumber | MaterialMasterSupplier->SequenceNumber | integer | int32 |\r\n| notes | MaterialMasterSupplier->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| materialMasterId | Required | True | |\r\n| materialMasterId | Nullable | False | |\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\r\n", "operationId": "CreateMaterialMasterSupplier", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateMaterialMasterSupplierResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/{materialMasterId}/Suppliers": { "get": { "tags": [ "Material Master Supplier" ], "summary": "Get a collection of Material Master Supplier resources for the Material Master.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MaterialMasterSupplier->Id | integer | int64 |\r\n| version | MaterialMasterSupplier->Version | integer | int32 |\r\n| supplierId | MaterialMasterSupplier->Supplier_Id | integer | int64 |\r\n| supplierCode | MaterialMasterSupplier->Supplier_Code | string | |\r\n| supplierDescription | MaterialMasterSupplier->Supplier_Description | string | |\r\n| notes | MaterialMasterSupplier->Notes | string | |\r\n| supplierPartNumber | MaterialMasterSupplier->SupplierPartNumber | string | |\r\n| sequenceNumber | MaterialMasterSupplier->SequenceNumber | integer | int32 |\r\n", "operationId": "GetMaterialMasterSupplierForMaterialMasterCollection", "parameters": [ { "name": "materialMasterId", "in": "path", "required": true, "description": "Material Master Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Material Master Supplier collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMaterialMasterSupplierForMaterialMasterCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Suppliers/Lookups/LookupMaterialMasterSupplierChangePermissionTree": { "get": { "tags": [ "Material Master Supplier" ], "summary": "Lookup the permission set for changing the Material Master 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": "LookupMaterialMasterSupplierChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterSupplierChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Suppliers/Lookups/LookupMaterialMasterSupplierInsertPermissionTree": { "get": { "tags": [ "Material Master Supplier" ], "summary": "Lookup the permission set for creating the Material Master 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": "LookupMaterialMasterSupplierInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterSupplierInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Suppliers/Lookups/LookupMaterialMasterSupplierMaterialMaster": { "get": { "tags": [ "Material Master Supplier" ], "summary": "Lookup the Supplier for the Material Master 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 | MaterialMaster->Id | integer | int64 |\r\n| code | MaterialMaster->Code | string | |\r\n| description | MaterialMaster->Description | string | |\r\n", "operationId": "LookupMaterialMasterSupplierMaterialMaster", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Material Master collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterSupplierMaterialMasterLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Suppliers/Lookups/LookupMaterialMasterSupplierSupplier": { "get": { "tags": [ "Material Master Supplier" ], "summary": "Lookup the Supplier for the Material Master 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 | Supplier->Id | integer | int64 |\r\n| code | Supplier->Code | string | |\r\n| description | Supplier->Description | string | |\r\n", "operationId": "LookupMaterialMasterSupplierSupplier", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Supplier collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MaterialMasterSupplierSupplierLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Suppliers/Batch/{ids}": { "get": { "tags": [ "Material Master Supplier" ], "summary": "Get a collection of Material Master 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| isActive | MaterialMasterSupplier->IsActive | boolean | |\r\n| createdByUserId | MaterialMasterSupplier->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MaterialMasterSupplier->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MaterialMasterSupplier->CreatedByUser_FullName | string | |\r\n| createdOn | MaterialMasterSupplier->CreatedOn | string | date-time |\r\n| modifiedByUserId | MaterialMasterSupplier->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MaterialMasterSupplier->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MaterialMasterSupplier->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MaterialMasterSupplier->ModifiedOn | string | date-time |\r\n| version | MaterialMasterSupplier->Version | integer | int32 |\r\n| permissionTreeId | MaterialMasterSupplier->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MaterialMasterSupplier->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MaterialMasterSupplier->PermissionTree_Description | string | |\r\n| id | MaterialMasterSupplier->Id | integer | int64 |\r\n| leadTime | MaterialMasterSupplier->LeadTime | string | duration |\r\n| materialMasterId | MaterialMasterSupplier->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | MaterialMasterSupplier->MaterialMaster_Code | string | |\r\n| materialMasterDescription | MaterialMasterSupplier->MaterialMaster_Description | string | |\r\n| notes | MaterialMasterSupplier->Notes | string | |\r\n| sequenceNumber | MaterialMasterSupplier->SequenceNumber | integer | int32 |\r\n| supplierId | MaterialMasterSupplier->Supplier_Id | integer | int64 |\r\n| supplierCode | MaterialMasterSupplier->Supplier_Code | string | |\r\n| supplierDescription | MaterialMasterSupplier->Supplier_Description | string | |\r\n| supplierPartNumber | MaterialMasterSupplier->SupplierPartNumber | string | |\r\n", "operationId": "BatchGetMaterialMasterSupplier", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Material Master Supplier id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Material Master Supplier collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetMaterialMasterSupplierResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Suppliers/Batch": { "post": { "tags": [ "Material Master Supplier" ], "summary": "Create a new collection of Material Master 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| leadTime | MaterialMasterSupplier->LeadTime | string | duration |\r\n| materialMasterId | MaterialMasterSupplier->MaterialMaster_Id | integer | int64 |\r\n| supplierId | MaterialMasterSupplier->Supplier_Id | integer | int64 |\r\n| permissionTreeId | MaterialMasterSupplier->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | MaterialMasterSupplier->SequenceNumber | integer | int32 |\r\n| supplierPartNumber | MaterialMasterSupplier->SupplierPartNumber | string | |\r\n| notes | MaterialMasterSupplier->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| materialMasterId | Required | True | |\r\n| materialMasterId | Nullable | False | |\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\r\n", "operationId": "BatchCreateMaterialMasterSupplier", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateMaterialMasterSupplierResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Material Master Supplier batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Material Master Supplier" ], "summary": "Update a collection of existing Material Master 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 | MaterialMasterSupplier->Id | integer | int64 |\r\n| version | MaterialMasterSupplier->Version | integer | int32 |\r\n| leadTime | MaterialMasterSupplier->LeadTime | string | duration |\r\n| supplierPartNumber | MaterialMasterSupplier->SupplierPartNumber | string | |\r\n| sequenceNumber | MaterialMasterSupplier->SequenceNumber | integer | int32 |\r\n| notes | MaterialMasterSupplier->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": "BatchUpdateMaterialMasterSupplier", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateMaterialMasterSupplierResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Material Master Supplier batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Material Master Supplier" ], "summary": "Delete a collection of existing Material Master 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 | MaterialMasterSupplier->Id | integer | int64 |\r\n| version | MaterialMasterSupplier->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": "BatchDeleteMaterialMasterSupplier", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteMaterialMasterSupplierResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Material Master Supplier batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Suppliers/{id}/Active": { "patch": { "tags": [ "Material Master Supplier" ], "summary": "Change the IsActive status for an existing Material Master 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 | MaterialMasterSupplier->Version | integer | int32 |\r\n| isActive | MaterialMasterSupplier->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": "ChangeMaterialMasterSupplierIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Supplier Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMaterialMasterSupplierIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Suppliers/{id}/PermissionTree": { "patch": { "tags": [ "Material Master Supplier" ], "summary": "Change the PermissionTree for an existing Material Master 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 | MaterialMasterSupplier->Version | integer | int32 |\r\n| permissionTreeId | MaterialMasterSupplier->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": "ChangeMaterialMasterSupplierPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Material Master Supplier Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMaterialMasterSupplierPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Suppliers/Batch/Active": { "patch": { "tags": [ "Material Master Supplier" ], "summary": "Change the IsActive status for a collection of existing Material Master 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 | MaterialMasterSupplier->Id | integer | int64 |\r\n| version | MaterialMasterSupplier->Version | integer | int32 |\r\n| isActive | MaterialMasterSupplier->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": "BatchChangeMaterialMasterSupplierIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMaterialMasterSupplierIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/MaterialMasters/Suppliers/Batch/PermissionTree": { "patch": { "tags": [ "Material Master Supplier" ], "summary": "Change the PermissionTree status for a collection of existing Material Master 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 | MaterialMasterSupplier->Id | integer | int64 |\r\n| version | MaterialMasterSupplier->Version | integer | int32 |\r\n| permissionTreeId | MaterialMasterSupplier->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": "BatchChangeMaterialMasterSupplierPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMaterialMasterSupplierPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/{id}": { "get": { "tags": [ "Requisition" ], "summary": "Get a Requisition 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 | Requisition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Requisition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Requisition->CreatedByUser_FullName | string | |\r\n| createdOn | Requisition->CreatedOn | string | date-time |\r\n| modifiedByUserId | Requisition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Requisition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Requisition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Requisition->ModifiedOn | string | date-time |\r\n| version | Requisition->Version | integer | int32 |\r\n| permissionTreeId | Requisition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Requisition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Requisition->PermissionTree_Description | string | |\r\n| code | Requisition->Code | string | |\r\n| codeCounter | Requisition->CodeCounter | integer | int64 |\r\n| codePrefix | Requisition->CodePrefix | string | |\r\n| requester | Requisition->Requester | string | |\r\n| requesterContactId | Requisition->RequesterContact_Id | integer | int64 |\r\n| requesterContactCode | Requisition->RequesterContact_Code | string | |\r\n| id | Requisition->Id | integer | int64 |\r\n| approvalWorkflowInterceptedStatusId | Requisition->ApprovalWorkflowInterceptedStatus_Id | integer | int64 |\r\n| approvalWorkflowInterceptedStatusBaseStatus | Requisition->ApprovalWorkflowInterceptedStatus_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled, AwaitingApprovalWorkflow]) | enum |\r\n| approvalWorkflowInterceptedStatusCode | Requisition->ApprovalWorkflowInterceptedStatus_Code | string | |\r\n| approvalWorkflowInterceptedStatusDescription | Requisition->ApprovalWorkflowInterceptedStatus_Description | string | |\r\n| approvalWorkflowProgress | Requisition->ApprovalWorkflowProgress | string (Allowed values: [NotStarted, Rejected, InProgress, Approved]) | enum |\r\n| codedNonStockItemCost | Requisition->CodedNonStockItemCost | number | decimal |\r\n| contractorItemCost | Requisition->ContractorItemCost | number | decimal |\r\n| directPurchaseItemCost | Requisition->DirectPurchaseItemCost | number | decimal |\r\n| importanceId | Requisition->Importance_Id | integer | int64 |\r\n| importanceCode | Requisition->Importance_Code | string | |\r\n| importanceDescription | Requisition->Importance_Description | string | |\r\n| notes | Requisition->Notes | string | |\r\n| requestedOn | Requisition->RequestedOn | string | date-time |\r\n| requesterType | Requisition->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| requestTypeId | Requisition->RequestType_Id | integer | int64 |\r\n| requestTypeDescription | Requisition->RequestType_Description | string | |\r\n| requestTypeCode | Requisition->RequestType_Code | string | |\r\n| latestRequisitionStatusChangeId | Requisition->LatestRequisitionStatusChange_Id | integer | int64 |\r\n| latestRequisitionStatusChangeRemark | Requisition->LatestRequisitionStatusChange_Remark | string | |\r\n| sequenceNumber | Requisition->SequenceNumber | integer | int32 |\r\n| statusId | Requisition->Status_Id | integer | int64 |\r\n| statusBaseStatus | Requisition->Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled, AwaitingApprovalWorkflow]) | enum |\r\n| statusCode | Requisition->Status_Code | string | |\r\n| statusDescription | Requisition->Status_Description | string | |\r\n| stockItemCost | Requisition->StockItemCost | number | decimal |\r\n| totalItemCost | Requisition->TotalItemCost | number | decimal |\r\n| totalTransactionCost | Requisition->TotalTransactionCost | number | decimal |\r\n| workOrderId | Requisition->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | Requisition->WorkOrder_Code | string | |\r\n| workOrderDescription | Requisition->WorkOrder_Description | string | |\r\n| workOrderCostCentreId | Requisition->WorkOrder_CostCentre_Id | integer | int64 |\r\n| workOrderCostCentreCode | Requisition->WorkOrder_CostCentre_Code | string | |\r\n| workOrderCostCentreDescription | Requisition->WorkOrder_CostCentre_Description | string | |\r\n| workOrderGeneralLedgerId | Requisition->WorkOrder_GeneralLedger_Id | integer | int64 |\r\n| workOrderGeneralLedgerCode | Requisition->WorkOrder_GeneralLedger_Code | string | |\r\n| workOrderGeneralLedgerDescription | Requisition->WorkOrder_GeneralLedger_Description | string | |\r\n| workOrderSiteId | Requisition->WorkOrder_Site_Id | integer | int64 |\r\n| workOrderSiteCode | Requisition->WorkOrder_Site_Code | string | |\r\n| workOrderSiteDescription | Requisition->WorkOrder_Site_Description | string | |\r\n", "operationId": "GetRequisition", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Requisition", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Requisition" ], "summary": "Update an existing Requisition resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Requisition->Version | integer | int32 |\r\n| code | Requisition->Code | string | |\r\n| notes | Requisition->Notes | string | |\r\n| importanceId | Requisition->Importance_Id | integer | int64 |\r\n| requestTypeId | Requisition->RequestType_Id | integer | int64 |\r\n| requestedOn | Requisition->RequestedOn | string | date-time |\r\n| requester | Requisition->Requester | string | |\r\n| requesterContactId | Requisition->RequesterContact_Id | integer | int64 |\r\n| requesterType | Requisition->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| sequenceNumber | Requisition->SequenceNumber | integer | int32 |\r\n| workOrderId | Requisition->WorkOrder_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| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| requestedOn | Nullable | False | |\r\n| requester | Nullable | False | Requisition->RequesterType eq 'FreeText' |\r\n| requester | Min Length | >= 1 chars| |\r\n| requesterContactId | Nullable | True | Requisition->RequesterType eq 'User' |\r\n| requesterContactId | Nullable | False | Requisition->RequesterType eq 'Contact' |\r\n| requesterType | Nullable | False | |\r\n| workOrderId | Nullable | False | |\r\n\r\n", "operationId": "UpdateRequisition", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateRequisitionResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Requisition was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Requisition" ], "summary": "Delete an existing Requisition resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Requisition->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": "DeleteRequisition", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteRequisitionResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Requisition was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/{id}/Approvals": { "get": { "tags": [ "Requisition" ], "summary": "Get a collection of Requisition resources for the Requisition.", "description": "### Response Body\r\n#### Payload\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| isLocked | Approval->IsLocked | boolean | |\r\n| status | Approval->Status | string (Allowed values: [AwaitingApproval, Approved, Rejected, RoleCountReached]) | enum |\r\n| roleCode | Approval->Role_Code | string | |\r\n| roleDescription | Approval->Role_Description | string | |\r\n| remark | Approval->Remark | string | |\r\n| isHistoric | Approval->IsHistoric | boolean | |\r\n| reviewedByUserFullName | Approval->ReviewedByUser_FullName | string | |\r\n| reviewedOn | Approval->ReviewedOn | string | date-time |\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", "operationId": "GetApprovalForRequisitionCollection", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetApprovalForRequisitionCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions": { "get": { "tags": [ "Requisition" ], "summary": "Get a collection of Requisition 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 | Requisition->Id | integer | int64 |\r\n| code | Requisition->Code | string | |\r\n| notes | Requisition->Notes | string | |\r\n| permissionTreeId | Requisition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Requisition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Requisition->PermissionTree_Description | string | |\r\n| workOrderId | Requisition->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | Requisition->WorkOrder_Code | string | |\r\n| workOrderDescription | Requisition->WorkOrder_Description | string | |\r\n| workOrderCostCentreId | Requisition->WorkOrder_CostCentre_Id | integer | int64 |\r\n| workOrderCostCentreCode | Requisition->WorkOrder_CostCentre_Code | string | |\r\n| workOrderCostCentreDescription | Requisition->WorkOrder_CostCentre_Description | string | |\r\n| workOrderGeneralLedgerId | Requisition->WorkOrder_GeneralLedger_Id | integer | int64 |\r\n| workOrderGeneralLedgerCode | Requisition->WorkOrder_GeneralLedger_Code | string | |\r\n| workOrderGeneralLedgerDescription | Requisition->WorkOrder_GeneralLedger_Description | string | |\r\n| workOrderSiteId | Requisition->WorkOrder_Site_Id | integer | int64 |\r\n| workOrderSiteCode | Requisition->WorkOrder_Site_Code | string | |\r\n| workOrderSiteDescription | Requisition->WorkOrder_Site_Description | string | |\r\n| workOrderSiteCurrencyId | Requisition->WorkOrder_Site_Currency_Id | integer | int64 |\r\n| workOrderSiteCurrencyCode | Requisition->WorkOrder_Site_Currency_Code | string | |\r\n| workOrderSiteCurrencyDescription | Requisition->WorkOrder_Site_Currency_Description | string | |\r\n| importanceId | Requisition->Importance_Id | integer | int64 |\r\n| importanceCode | Requisition->Importance_Code | string | |\r\n| importanceDescription | Requisition->Importance_Description | string | |\r\n| requestedOn | Requisition->RequestedOn | string | date-time |\r\n| requester | Requisition->Requester | string | |\r\n| requestTypeId | Requisition->RequestType_Id | integer | int64 |\r\n| requestTypeCode | Requisition->RequestType_Code | string | |\r\n| requestTypeDescription | Requisition->RequestType_Description | string | |\r\n| requesterType | Requisition->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| sequenceNumber | Requisition->SequenceNumber | integer | int32 |\r\n| statusId | Requisition->Status_Id | integer | int64 |\r\n| statusCode | Requisition->Status_Code | string | |\r\n| statusDescription | Requisition->Status_Description | string | |\r\n| statusBaseStatus | Requisition->Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled, AwaitingApprovalWorkflow]) | enum |\r\n| version | Requisition->Version | integer | int32 |\r\n| totalItemCost | Requisition->TotalItemCost | number | decimal |\r\n", "operationId": "GetRequisitionCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Requisition" ], "summary": "Create a new Requisition resource.", "description": "### Request Body\r\n#### 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 | Requisition->Code | string | |\r\n| importanceId | Requisition->Importance_Id | integer | int64 |\r\n| notes | Requisition->Notes | string | |\r\n| permissionTreeId | Requisition->PermissionTree_Id | integer | int64 |\r\n| requestTypeId | Requisition->RequestType_Id | integer | int64 |\r\n| requestedOn | Requisition->RequestedOn | string | date-time |\r\n| requester | Requisition->Requester | string | |\r\n| requesterContactId | Requisition->RequesterContact_Id | integer | int64 |\r\n| requesterType | Requisition->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| sequenceNumber | Requisition->SequenceNumber | integer | int32 |\r\n| workOrderId | Requisition->WorkOrder_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| code | System Generated | true | If no value specified |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| requestedOn | Nullable | False | |\r\n| requester | Nullable | False | Requisition->RequesterType eq 'FreeText' |\r\n| requester | Min Length | >= 1 chars| |\r\n| requesterContactId | Nullable | True | Requisition->RequesterType eq 'User' |\r\n| requesterContactId | Nullable | False | Requisition->RequesterType eq 'Contact' |\r\n| requesterType | Required | True | |\r\n| requesterType | Nullable | False | |\r\n| workOrderId | Required | True | |\r\n| workOrderId | Nullable | False | |\r\n\r\n", "operationId": "CreateRequisition", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateRequisitionResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Lookups/LookupRequisitionChangePermissionTree": { "get": { "tags": [ "Requisition" ], "summary": "Lookup the permission set for changing the Requisition.", "description": "### Response Body\r\n#### Payload\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": "LookupRequisitionChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Lookups/LookupIssueReturnAllFinancialYearPeriod": { "get": { "tags": [ "Requisition" ], "summary": "Lookup the Financial Year Period for the Requisition.", "description": "### Response Body\r\n#### Payload\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", "operationId": "LookupIssueReturnAllFinancialYearPeriod", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Financial Year Period collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionFinancialYearPeriodLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Lookups/LookupRequisitionInsertPermissionTree": { "get": { "tags": [ "Requisition" ], "summary": "Lookup the permission set for creating the Requisition.", "description": "### Response Body\r\n#### Payload\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": "LookupRequisitionInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Lookups/LookupRequisitionRequestType": { "get": { "tags": [ "Requisition" ], "summary": "Lookup the Request Type for the Requisition.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response 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| code | RequestType->Code | string | |\r\n| description | RequestType->Description | string | |\r\n", "operationId": "LookupRequisitionRequestType", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Request Type collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionRequestTypeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Lookups/LookupRequisitionWorkOrderImportance": { "get": { "tags": [ "Requisition" ], "summary": "Lookup the Work Order Importance for the Requisition.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrderImportance->Id | integer | int64 |\r\n| code | WorkOrderImportance->Code | string | |\r\n| description | WorkOrderImportance->Description | string | |\r\n", "operationId": "LookupRequisitionWorkOrderImportance", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Work Order Importance collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionWorkOrderImportanceLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Lookups/LookupRequisitionWorkOrder": { "get": { "tags": [ "Requisition" ], "summary": "Lookup the Work Order for the Requisition.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrder->Id | integer | int64 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n| siteId | WorkOrder->Site_Id | integer | int64 |\r\n| siteCode | WorkOrder->Site_Code | string | |\r\n| siteDescription | WorkOrder->Site_Description | string | |\r\n| costCentreId | WorkOrder->CostCentre_Id | integer | int64 |\r\n| costCentreCode | WorkOrder->CostCentre_Code | string | |\r\n| generalLedgerId | WorkOrder->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | WorkOrder->GeneralLedger_Code | string | |\r\n", "operationId": "LookupRequisitionWorkOrder", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Work Order collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionWorkOrderLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Lookups/LookupRequisitionRequesterContact": { "get": { "tags": [ "Requisition" ], "summary": "Lookup up the Requester Contact for the Requisition", "description": "### Response Body\r\n#### Payload\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| contactDetailFullName | Resource->ContactDetailFullName | string | |\r\n", "operationId": "LookupRequisitionRequesterContact", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Resource collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionRequesterContactLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Lookups/LookupRequisitionStatus": { "get": { "tags": [ "Requisition" ], "summary": "Lookup the Requisition Status for the Requisition.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RequisitionStatus->Id | integer | int64 |\r\n| code | RequisitionStatus->Code | string | |\r\n| description | RequisitionStatus->Description | string | |\r\n| baseStatus | RequisitionStatus->BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled, AwaitingApprovalWorkflow]) | enum |\r\n", "operationId": "LookupRequisitionStatus", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition Status collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionStatusLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Batch/{ids}": { "get": { "tags": [ "Requisition" ], "summary": "Get a collection of Requisition 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 | Requisition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Requisition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Requisition->CreatedByUser_FullName | string | |\r\n| createdOn | Requisition->CreatedOn | string | date-time |\r\n| modifiedByUserId | Requisition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Requisition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Requisition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Requisition->ModifiedOn | string | date-time |\r\n| version | Requisition->Version | integer | int32 |\r\n| permissionTreeId | Requisition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Requisition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Requisition->PermissionTree_Description | string | |\r\n| code | Requisition->Code | string | |\r\n| codeCounter | Requisition->CodeCounter | integer | int64 |\r\n| codePrefix | Requisition->CodePrefix | string | |\r\n| requester | Requisition->Requester | string | |\r\n| requesterContactId | Requisition->RequesterContact_Id | integer | int64 |\r\n| requesterContactCode | Requisition->RequesterContact_Code | string | |\r\n| id | Requisition->Id | integer | int64 |\r\n| approvalWorkflowInterceptedStatusId | Requisition->ApprovalWorkflowInterceptedStatus_Id | integer | int64 |\r\n| approvalWorkflowInterceptedStatusBaseStatus | Requisition->ApprovalWorkflowInterceptedStatus_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled, AwaitingApprovalWorkflow]) | enum |\r\n| approvalWorkflowInterceptedStatusCode | Requisition->ApprovalWorkflowInterceptedStatus_Code | string | |\r\n| approvalWorkflowInterceptedStatusDescription | Requisition->ApprovalWorkflowInterceptedStatus_Description | string | |\r\n| approvalWorkflowProgress | Requisition->ApprovalWorkflowProgress | string (Allowed values: [NotStarted, Rejected, InProgress, Approved]) | enum |\r\n| codedNonStockItemCost | Requisition->CodedNonStockItemCost | number | decimal |\r\n| contractorItemCost | Requisition->ContractorItemCost | number | decimal |\r\n| directPurchaseItemCost | Requisition->DirectPurchaseItemCost | number | decimal |\r\n| importanceId | Requisition->Importance_Id | integer | int64 |\r\n| importanceCode | Requisition->Importance_Code | string | |\r\n| importanceDescription | Requisition->Importance_Description | string | |\r\n| notes | Requisition->Notes | string | |\r\n| requestedOn | Requisition->RequestedOn | string | date-time |\r\n| requesterType | Requisition->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| requestTypeId | Requisition->RequestType_Id | integer | int64 |\r\n| requestTypeDescription | Requisition->RequestType_Description | string | |\r\n| requestTypeCode | Requisition->RequestType_Code | string | |\r\n| latestRequisitionStatusChangeId | Requisition->LatestRequisitionStatusChange_Id | integer | int64 |\r\n| latestRequisitionStatusChangeRemark | Requisition->LatestRequisitionStatusChange_Remark | string | |\r\n| sequenceNumber | Requisition->SequenceNumber | integer | int32 |\r\n| statusId | Requisition->Status_Id | integer | int64 |\r\n| statusBaseStatus | Requisition->Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled, AwaitingApprovalWorkflow]) | enum |\r\n| statusCode | Requisition->Status_Code | string | |\r\n| statusDescription | Requisition->Status_Description | string | |\r\n| stockItemCost | Requisition->StockItemCost | number | decimal |\r\n| totalItemCost | Requisition->TotalItemCost | number | decimal |\r\n| totalTransactionCost | Requisition->TotalTransactionCost | number | decimal |\r\n| workOrderId | Requisition->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | Requisition->WorkOrder_Code | string | |\r\n| workOrderDescription | Requisition->WorkOrder_Description | string | |\r\n| workOrderCostCentreId | Requisition->WorkOrder_CostCentre_Id | integer | int64 |\r\n| workOrderCostCentreCode | Requisition->WorkOrder_CostCentre_Code | string | |\r\n| workOrderCostCentreDescription | Requisition->WorkOrder_CostCentre_Description | string | |\r\n| workOrderGeneralLedgerId | Requisition->WorkOrder_GeneralLedger_Id | integer | int64 |\r\n| workOrderGeneralLedgerCode | Requisition->WorkOrder_GeneralLedger_Code | string | |\r\n| workOrderGeneralLedgerDescription | Requisition->WorkOrder_GeneralLedger_Description | string | |\r\n| workOrderSiteId | Requisition->WorkOrder_Site_Id | integer | int64 |\r\n| workOrderSiteCode | Requisition->WorkOrder_Site_Code | string | |\r\n| workOrderSiteDescription | Requisition->WorkOrder_Site_Description | string | |\r\n", "operationId": "BatchGetRequisition", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Requisition id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Requisition collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetRequisitionResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Batch": { "post": { "tags": [ "Requisition" ], "summary": "Create a new collection of Requisition resources.", "description": "### Request Body\r\n#### 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 | Requisition->Code | string | |\r\n| importanceId | Requisition->Importance_Id | integer | int64 |\r\n| notes | Requisition->Notes | string | |\r\n| permissionTreeId | Requisition->PermissionTree_Id | integer | int64 |\r\n| requestTypeId | Requisition->RequestType_Id | integer | int64 |\r\n| requestedOn | Requisition->RequestedOn | string | date-time |\r\n| requester | Requisition->Requester | string | |\r\n| requesterContactId | Requisition->RequesterContact_Id | integer | int64 |\r\n| requesterType | Requisition->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| sequenceNumber | Requisition->SequenceNumber | integer | int32 |\r\n| workOrderId | Requisition->WorkOrder_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| code | System Generated | true | If no value specified |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| requestedOn | Nullable | False | |\r\n| requester | Nullable | False | Requisition->RequesterType eq 'FreeText' |\r\n| requester | Min Length | >= 1 chars| |\r\n| requesterContactId | Nullable | True | Requisition->RequesterType eq 'User' |\r\n| requesterContactId | Nullable | False | Requisition->RequesterType eq 'Contact' |\r\n| requesterType | Required | True | |\r\n| requesterType | Nullable | False | |\r\n| workOrderId | Required | True | |\r\n| workOrderId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRequisition", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateRequisitionResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Requisition batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Requisition" ], "summary": "Update a collection of existing Requisition resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Requisition->Id | integer | int64 |\r\n| version | Requisition->Version | integer | int32 |\r\n| code | Requisition->Code | string | |\r\n| notes | Requisition->Notes | string | |\r\n| importanceId | Requisition->Importance_Id | integer | int64 |\r\n| requestTypeId | Requisition->RequestType_Id | integer | int64 |\r\n| requestedOn | Requisition->RequestedOn | string | date-time |\r\n| requester | Requisition->Requester | string | |\r\n| requesterContactId | Requisition->RequesterContact_Id | integer | int64 |\r\n| requesterType | Requisition->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| sequenceNumber | Requisition->SequenceNumber | integer | int32 |\r\n| workOrderId | Requisition->WorkOrder_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| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| requestedOn | Nullable | False | |\r\n| requester | Nullable | False | Requisition->RequesterType eq 'FreeText' |\r\n| requester | Min Length | >= 1 chars| |\r\n| requesterContactId | Nullable | True | Requisition->RequesterType eq 'User' |\r\n| requesterContactId | Nullable | False | Requisition->RequesterType eq 'Contact' |\r\n| requesterType | Nullable | False | |\r\n| workOrderId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRequisition", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateRequisitionResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Requisition batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Requisition" ], "summary": "Delete a collection of existing Requisition resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Requisition->Id | integer | int64 |\r\n| version | Requisition->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": "BatchDeleteRequisition", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteRequisitionResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Requisition batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Batch/IssueAll": { "post": { "tags": [ "Requisition" ], "summary": "Issue all Items for collection of Requisition resource", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| entityIds | IssueReturnAll->EntityIds | array | array |\r\n| permissionId | IssueReturnAll->Permission_Id | integer | int64 |\r\n| financialYearPeriodId | IssueReturnAll->FinancialYearPeriod_Id | integer | int64 |\r\n| transactedOn | IssueReturnAll->TransactedOn | string | date-time |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| entityIds | Required | True | |\r\n| entityIds | Nullable | False | |\r\n| permissionId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| transactedOn | System Generated | true | If no value specified |\r\n\r\n", "operationId": "BatchIssueAllRequisition", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/BatchIssueAllRequisitionResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Batch/ReturnAll": { "post": { "tags": [ "Requisition" ], "summary": "Return all Items for collection of Requisition resource", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| entityIds | IssueReturnAll->EntityIds | array | array |\r\n| permissionId | IssueReturnAll->Permission_Id | integer | int64 |\r\n| financialYearPeriodId | IssueReturnAll->FinancialYearPeriod_Id | integer | int64 |\r\n| transactedOn | IssueReturnAll->TransactedOn | string | date-time |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| entityIds | Required | True | |\r\n| entityIds | Nullable | False | |\r\n| permissionId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| transactedOn | System Generated | true | If no value specified |\r\n\r\n", "operationId": "BatchReturnAllRequisition", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/BatchReturnAllRequisitionResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/{id}/PermissionTree": { "patch": { "tags": [ "Requisition" ], "summary": "Change the PermissionTree for an existing Requisition resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Requisition->Version | integer | int32 |\r\n| permissionTreeId | Requisition->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": "ChangeRequisitionPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeRequisitionPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/{id}/IssueAll": { "post": { "tags": [ "Requisition" ], "summary": "Issue all Items for Requisition resource", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionId | IssueReturnAll->Permission_Id | integer | int64 |\r\n| financialYearPeriodId | IssueReturnAll->FinancialYearPeriod_Id | integer | int64 |\r\n| transactedOn | IssueReturnAll->TransactedOn | string | date-time |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| transactedOn | System Generated | true | If no value specified |\r\n\r\n", "operationId": "IssueAllRequisition", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/IssueAllRequisitionResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/{id}/ReturnAll": { "post": { "tags": [ "Requisition" ], "summary": "Return all Items for Requisition resource", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionId | IssueReturnAll->Permission_Id | integer | int64 |\r\n| financialYearPeriodId | IssueReturnAll->FinancialYearPeriod_Id | integer | int64 |\r\n| transactedOn | IssueReturnAll->TransactedOn | string | date-time |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| transactedOn | System Generated | true | If no value specified |\r\n\r\n", "operationId": "ReturnAllRequisition", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/ReturnAllRequisitionResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Status/Batch": { "post": { "tags": [ "Requisition" ], "summary": "Change the status for a collection of Requisition resources", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| requisitionId | RequisitionStatusChange->Requisition_Id | integer | int64 |\r\n| version | RequisitionStatusChange->Version | integer | int32 |\r\n| statusId | RequisitionStatusChange->Status_Id | integer | int64 |\r\n| statusChangedOn | RequisitionStatusChange->StatusChangedOn | string | date-time |\r\n| remark | RequisitionStatusChange->Remark | 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| requisitionId | Required | True | |\r\n| requisitionId | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| statusId | Required | True | |\r\n| statusId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeRequisitionStatus", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeRequisitionStatusResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Status": { "post": { "tags": [ "Requisition" ], "summary": "Change the status for the Requisition resource", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| requisitionId | RequisitionStatusChange->Requisition_Id | integer | int64 |\r\n| version | RequisitionStatusChange->Version | integer | int32 |\r\n| statusId | RequisitionStatusChange->Status_Id | integer | int64 |\r\n| statusChangedOn | RequisitionStatusChange->StatusChangedOn | string | date-time |\r\n| remark | RequisitionStatusChange->Remark | 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| requisitionId | Required | True | |\r\n| requisitionId | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| statusId | Required | True | |\r\n| statusId | Nullable | False | |\r\n\r\n", "operationId": "ChangeRequisitionStatus", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/ChangeRequisitionStatusResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Batch/PermissionTree": { "patch": { "tags": [ "Requisition" ], "summary": "Change the PermissionTree status for a collection of existing Requisition resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Requisition->Id | integer | int64 |\r\n| version | Requisition->Version | integer | int32 |\r\n| permissionTreeId | Requisition->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": "BatchChangeRequisitionPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeRequisitionPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Attributes/{id}": { "get": { "tags": [ "Requisition Attribute" ], "summary": "Get a Requisition 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| requisitionId | RequisitionAttribute->Requisition_Id | integer | int64 |\r\n| requisitionCode | RequisitionAttribute->Requisition_Code | string | |\r\n| createdByUserId | RequisitionAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RequisitionAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RequisitionAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | RequisitionAttribute->CreatedOn | string | date-time |\r\n| isActive | RequisitionAttribute->IsActive | boolean | |\r\n| modifiedByUserId | RequisitionAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RequisitionAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RequisitionAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RequisitionAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | RequisitionAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionAttribute->PermissionTree_Description | string | |\r\n| version | RequisitionAttribute->Version | integer | int32 |\r\n| id | RequisitionAttribute->Id | integer | int64 |\r\n| attributeId | RequisitionAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RequisitionAttribute->Attribute_Code | string | |\r\n| attributeDescription | RequisitionAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | RequisitionAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | RequisitionAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | RequisitionAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | RequisitionAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | RequisitionAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | RequisitionAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | RequisitionAttribute->Notes | string | |\r\n| predefinedValueId | RequisitionAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RequisitionAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RequisitionAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | RequisitionAttribute->SequenceNumber | integer | int32 |\r\n| value | RequisitionAttribute->Value | object | composite |\r\n", "operationId": "GetRequisitionAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Requisition Attribute", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionAttributeResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Requisition Attribute" ], "summary": "Update an existing Requisition 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 | RequisitionAttribute->Version | integer | int32 |\r\n| value | RequisitionAttribute->Value | object | composite |\r\n| predefinedValueId | RequisitionAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | RequisitionAttribute->SequenceNumber | integer | int32 |\r\n| notes | RequisitionAttribute->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": "UpdateRequisitionAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateRequisitionAttributeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Requisition Attribute was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Requisition Attribute" ], "summary": "Delete an existing Requisition 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 | RequisitionAttribute->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": "DeleteRequisitionAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteRequisitionAttributeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Requisition Attribute was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/{requisitionId}/Attributes": { "get": { "tags": [ "Requisition Attribute" ], "summary": "Get a collection of Requisition Attribute resources for the Requisition.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RequisitionAttribute->Id | integer | int64 |\r\n| version | RequisitionAttribute->Version | integer | int32 |\r\n| sequenceNumber | RequisitionAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | RequisitionAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RequisitionAttribute->Attribute_Code | string | |\r\n| attributeDescription | RequisitionAttribute->Attribute_Description | string | |\r\n| attributeDataType | RequisitionAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | RequisitionAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RequisitionAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RequisitionAttribute->PredefinedValue_Value | object | composite |\r\n| value | RequisitionAttribute->Value | object | composite |\r\n| notes | RequisitionAttribute->Notes | string | |\r\n| createdOn | RequisitionAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | RequisitionAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetRequisitionAttributeCollectionForRequisition", "parameters": [ { "name": "requisitionId", "in": "path", "required": true, "description": "Requisition Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionAttributeCollectionForRequisitionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Attributes": { "get": { "tags": [ "Requisition Attribute" ], "summary": "Get a collection of Requisition 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 | RequisitionAttribute->Id | integer | int64 |\r\n| version | RequisitionAttribute->Version | integer | int32 |\r\n| sequenceNumber | RequisitionAttribute->SequenceNumber | integer | int32 |\r\n| requisitionCode | RequisitionAttribute->Requisition_Code | string | |\r\n| attributeId | RequisitionAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RequisitionAttribute->Attribute_Code | string | |\r\n| attributeDescription | RequisitionAttribute->Attribute_Description | string | |\r\n| attributeDataType | RequisitionAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | RequisitionAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RequisitionAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RequisitionAttribute->PredefinedValue_Value | object | composite |\r\n| value | RequisitionAttribute->Value | object | composite |\r\n| notes | RequisitionAttribute->Notes | string | |\r\n| createdOn | RequisitionAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | RequisitionAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetRequisitionAttributeCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionAttributeCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Requisition Attribute" ], "summary": "Create a new Requisition 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| requisitionId | RequisitionAttribute->Requisition_Id | integer | int64 |\r\n| attributeId | RequisitionAttribute->Attribute_Id | integer | int64 |\r\n| value | RequisitionAttribute->Value | object | composite |\r\n| predefinedValueId | RequisitionAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | RequisitionAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RequisitionAttribute->SequenceNumber | integer | int32 |\r\n| notes | RequisitionAttribute->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| requisitionId | Required | True | |\r\n| requisitionId | 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": "CreateRequisitionAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateRequisitionAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Attributes/Lookups/LookupRequisitionAttributeAllowedValue": { "get": { "tags": [ "Requisition Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Requisition 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": "LookupRequisitionAttributeAllowedValue", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Attribute Allowed Value collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionAttributeAttributeAllowedValueLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Attributes/Lookups/LookupRequisitionAttribute": { "get": { "tags": [ "Requisition Attribute" ], "summary": "Lookup the Attribute for the Requisition 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": "LookupRequisitionAttribute", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionAttributeAttributeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Attributes/Lookups/LookupRequisitionAttributeChangePermissionTree": { "get": { "tags": [ "Requisition Attribute" ], "summary": "Lookup the permission set for changing the Requisition 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": "LookupRequisitionAttributeChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionAttributeChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Attributes/Lookups/LookupRequisitionAttributeInsertPermissionTree": { "get": { "tags": [ "Requisition Attribute" ], "summary": "Lookup the permission set for creating the Requisition 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": "LookupRequisitionAttributeInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionAttributeInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Attributes/Lookups/LookupRequisitionAttributeRequisition": { "get": { "tags": [ "Requisition Attribute" ], "summary": "Lookup the Requisition Attribute for the Requisition 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 | Requisition->Id | integer | int64 |\r\n| code | Requisition->Code | string | |\r\n", "operationId": "LookupRequisitionAttributeRequisition", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionAttributeRequisitionLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Attributes/Batch/{ids}": { "get": { "tags": [ "Requisition Attribute" ], "summary": "Get a collection of Requisition 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| requisitionId | RequisitionAttribute->Requisition_Id | integer | int64 |\r\n| requisitionCode | RequisitionAttribute->Requisition_Code | string | |\r\n| createdByUserId | RequisitionAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RequisitionAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RequisitionAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | RequisitionAttribute->CreatedOn | string | date-time |\r\n| isActive | RequisitionAttribute->IsActive | boolean | |\r\n| modifiedByUserId | RequisitionAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RequisitionAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RequisitionAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RequisitionAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | RequisitionAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionAttribute->PermissionTree_Description | string | |\r\n| version | RequisitionAttribute->Version | integer | int32 |\r\n| id | RequisitionAttribute->Id | integer | int64 |\r\n| attributeId | RequisitionAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RequisitionAttribute->Attribute_Code | string | |\r\n| attributeDescription | RequisitionAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | RequisitionAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | RequisitionAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | RequisitionAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | RequisitionAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | RequisitionAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | RequisitionAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | RequisitionAttribute->Notes | string | |\r\n| predefinedValueId | RequisitionAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RequisitionAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RequisitionAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | RequisitionAttribute->SequenceNumber | integer | int32 |\r\n| value | RequisitionAttribute->Value | object | composite |\r\n", "operationId": "BatchGetRequisitionAttribute", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Requisition Attribute id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Requisition Attribute collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetRequisitionAttributeResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Attributes/Batch": { "post": { "tags": [ "Requisition Attribute" ], "summary": "Create a new collection of Requisition 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| requisitionId | RequisitionAttribute->Requisition_Id | integer | int64 |\r\n| attributeId | RequisitionAttribute->Attribute_Id | integer | int64 |\r\n| value | RequisitionAttribute->Value | object | composite |\r\n| predefinedValueId | RequisitionAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | RequisitionAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RequisitionAttribute->SequenceNumber | integer | int32 |\r\n| notes | RequisitionAttribute->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| requisitionId | Required | True | |\r\n| requisitionId | 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": "BatchCreateRequisitionAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateRequisitionAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Requisition Attribute batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Requisition Attribute" ], "summary": "Update a collection of existing Requisition 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 | RequisitionAttribute->Id | integer | int64 |\r\n| version | RequisitionAttribute->Version | integer | int32 |\r\n| value | RequisitionAttribute->Value | object | composite |\r\n| predefinedValueId | RequisitionAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | RequisitionAttribute->SequenceNumber | integer | int32 |\r\n| notes | RequisitionAttribute->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": "BatchUpdateRequisitionAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateRequisitionAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Requisition Attribute batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Requisition Attribute" ], "summary": "Delete a collection of existing Requisition 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 | RequisitionAttribute->Id | integer | int64 |\r\n| version | RequisitionAttribute->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": "BatchDeleteRequisitionAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteRequisitionAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Requisition Attribute batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Attributes/{id}/Active": { "patch": { "tags": [ "Requisition Attribute" ], "summary": "Change the IsActive status for an existing Requisition 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 | RequisitionAttribute->Version | integer | int32 |\r\n| isActive | RequisitionAttribute->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": "ChangeRequisitionAttributeIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeRequisitionAttributeIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Requisition Attribute" ], "summary": "Change the PermissionTree for an existing Requisition 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 | RequisitionAttribute->Version | integer | int32 |\r\n| permissionTreeId | RequisitionAttribute->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": "ChangeRequisitionAttributePermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeRequisitionAttributePermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Requisition Attribute" ], "summary": "Change the PermissionTree status for a collection of existing Requisition 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 | RequisitionAttribute->Id | integer | int64 |\r\n| version | RequisitionAttribute->Version | integer | int32 |\r\n| permissionTreeId | RequisitionAttribute->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": "BatchChangeRequisitionAttributePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeRequisitionAttributePermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Attributes/Batch/Active": { "patch": { "tags": [ "Requisition Attribute" ], "summary": "Change the IsActive status for a collection of existing Requisition 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 | RequisitionAttribute->Id | integer | int64 |\r\n| version | RequisitionAttribute->Version | integer | int32 |\r\n| isActive | RequisitionAttribute->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": "BatchChangeRequisitionAttributeIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeRequisitionAttributeIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Documents/{id}": { "get": { "tags": [ "Requisition Document" ], "summary": "Get a Requisition 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| requisitionId | RequisitionDocument->Requisition_Id | integer | int64 |\r\n| requisitionCode | RequisitionDocument->Requisition_Code | string | |\r\n| isActive | RequisitionDocument->IsActive | boolean | |\r\n| createdByUserId | RequisitionDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RequisitionDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RequisitionDocument->CreatedByUser_FullName | string | |\r\n| createdOn | RequisitionDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | RequisitionDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RequisitionDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RequisitionDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RequisitionDocument->ModifiedOn | string | date-time |\r\n| version | RequisitionDocument->Version | integer | int32 |\r\n| permissionTreeId | RequisitionDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionDocument->PermissionTree_Description | string | |\r\n| id | RequisitionDocument->Id | integer | int64 |\r\n| documentRecordId | RequisitionDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RequisitionDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RequisitionDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RequisitionDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | RequisitionDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | RequisitionDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | RequisitionDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | RequisitionDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | RequisitionDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | RequisitionDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RequisitionDocument->Notes | string | |\r\n| sequenceNumber | RequisitionDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRequisitionDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Requisition Document", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionDocumentResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Requisition Document" ], "summary": "Update an existing Requisition 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 | RequisitionDocument->Version | integer | int32 |\r\n| sequenceNumber | RequisitionDocument->SequenceNumber | integer | int32 |\r\n| notes | RequisitionDocument->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": "UpdateRequisitionDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateRequisitionDocumentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Requisition Document was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Requisition Document" ], "summary": "Delete an existing Requisition 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 | RequisitionDocument->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": "DeleteRequisitionDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteRequisitionDocumentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Requisition Document was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/{id}/Documents": { "get": { "tags": [ "Requisition Document" ], "summary": "Get a collection of Requisition Document resources for the Requisition.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RequisitionDocument->Id | integer | int64 |\r\n| version | RequisitionDocument->Version | integer | int32 |\r\n| sequenceNumber | RequisitionDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | RequisitionDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RequisitionDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RequisitionDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RequisitionDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | RequisitionDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | RequisitionDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | RequisitionDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetRequisitionDocumentCollectionForRequisition", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition Document collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionDocumentCollectionForRequisitionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Documents": { "get": { "tags": [ "Requisition Document" ], "summary": "Get a collection of Requisition 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 | RequisitionDocument->Id | integer | int64 |\r\n| version | RequisitionDocument->Version | integer | int32 |\r\n| requisitionId | RequisitionDocument->Requisition_Id | integer | int64 |\r\n| requisitionCode | RequisitionDocument->Requisition_Code | string | |\r\n| sequenceNumber | RequisitionDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | RequisitionDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RequisitionDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RequisitionDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RequisitionDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | RequisitionDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | RequisitionDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | RequisitionDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetRequisitionDocumentCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition Document collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionDocumentCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Requisition Document" ], "summary": "Create a new Requisition 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| requisitionId | RequisitionDocument->Requisition_Id | integer | int64 |\r\n| documentRecordId | RequisitionDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | RequisitionDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RequisitionDocument->SequenceNumber | integer | int32 |\r\n| notes | RequisitionDocument->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| requisitionId | Required | True | |\r\n| requisitionId | 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": "CreateRequisitionDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateRequisitionDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Documents/Lookups/LookupRequisitionDocumentChangePermissionTree": { "get": { "tags": [ "Requisition Document" ], "summary": "Lookup the permission set for changing the Requisition 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": "LookupRequisitionDocumentChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionDocumentChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Documents/Lookups/LookupRequisitionDocument": { "get": { "tags": [ "Requisition Document" ], "summary": "Requisition 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": "LookupRequisitionDocument", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Document Record collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionDocumentDocumentLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Documents/Lookups/LookupRequisitionDocumentInsertPermissionTree": { "get": { "tags": [ "Requisition Document" ], "summary": "Lookup the permission set for creating the Requisition 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": "LookupRequisitionDocumentInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionDocumentInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Documents/Lookups/LookupRequisitionDocumentRequisition": { "get": { "tags": [ "Requisition Document" ], "summary": "Lookup the Requisition Document for the Requisition 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 | Requisition->Id | integer | int64 |\r\n| code | Requisition->Code | string | |\r\n", "operationId": "LookupRequisitionDocumentRequisition", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionDocumentRequisitionLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Documents/Batch/{ids}": { "get": { "tags": [ "Requisition Document" ], "summary": "Get a collection of Requisition 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| requisitionId | RequisitionDocument->Requisition_Id | integer | int64 |\r\n| requisitionCode | RequisitionDocument->Requisition_Code | string | |\r\n| isActive | RequisitionDocument->IsActive | boolean | |\r\n| createdByUserId | RequisitionDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RequisitionDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RequisitionDocument->CreatedByUser_FullName | string | |\r\n| createdOn | RequisitionDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | RequisitionDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RequisitionDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RequisitionDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RequisitionDocument->ModifiedOn | string | date-time |\r\n| version | RequisitionDocument->Version | integer | int32 |\r\n| permissionTreeId | RequisitionDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionDocument->PermissionTree_Description | string | |\r\n| id | RequisitionDocument->Id | integer | int64 |\r\n| documentRecordId | RequisitionDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RequisitionDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RequisitionDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RequisitionDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | RequisitionDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | RequisitionDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | RequisitionDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | RequisitionDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | RequisitionDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | RequisitionDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RequisitionDocument->Notes | string | |\r\n| sequenceNumber | RequisitionDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetRequisitionDocument", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Requisition Document id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Requisition Document collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetRequisitionDocumentResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Documents/Batch": { "post": { "tags": [ "Requisition Document" ], "summary": "Create a new collection of Requisition 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| requisitionId | RequisitionDocument->Requisition_Id | integer | int64 |\r\n| documentRecordId | RequisitionDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | RequisitionDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RequisitionDocument->SequenceNumber | integer | int32 |\r\n| notes | RequisitionDocument->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| requisitionId | Required | True | |\r\n| requisitionId | 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": "BatchCreateRequisitionDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateRequisitionDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Requisition Document batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Requisition Document" ], "summary": "Update a collection of existing Requisition 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 | RequisitionDocument->Id | integer | int64 |\r\n| version | RequisitionDocument->Version | integer | int32 |\r\n| sequenceNumber | RequisitionDocument->SequenceNumber | integer | int32 |\r\n| notes | RequisitionDocument->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": "BatchUpdateRequisitionDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateRequisitionDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Requisition Document batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Requisition Document" ], "summary": "Delete a collection of existing Requisition 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 | RequisitionDocument->Id | integer | int64 |\r\n| version | RequisitionDocument->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": "BatchDeleteRequisitionDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteRequisitionDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Requisition Document batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Documents/{id}/Active": { "patch": { "tags": [ "Requisition Document" ], "summary": "Change the IsActive status for an existing Requisition 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 | RequisitionDocument->Version | integer | int32 |\r\n| isActive | RequisitionDocument->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": "ChangeRequisitionDocumentIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeRequisitionDocumentIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Requisition Document" ], "summary": "Change the PermissionTree for an existing Requisition 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 | RequisitionDocument->Version | integer | int32 |\r\n| permissionTreeId | RequisitionDocument->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": "ChangeRequisitionDocumentPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeRequisitionDocumentPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Requisition Document" ], "summary": "Change the PermissionTree status for a collection of existing Requisition 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 | RequisitionDocument->Id | integer | int64 |\r\n| version | RequisitionDocument->Version | integer | int32 |\r\n| permissionTreeId | RequisitionDocument->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": "BatchChangeRequisitionDocumentPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeRequisitionDocumentPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Documents/Batch/Active": { "patch": { "tags": [ "Requisition Document" ], "summary": "Change the IsActive status for a collection of existing Requisition 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 | RequisitionDocument->Id | integer | int64 |\r\n| version | RequisitionDocument->Version | integer | int32 |\r\n| isActive | RequisitionDocument->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": "BatchChangeRequisitionDocumentIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeRequisitionDocumentIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/FileAttachments/{id}/Download": { "get": { "tags": [ "Requisition File Attachment" ], "summary": "Download the content for a Requisition File Attachment resource.", "description": "", "operationId": "GetRequisitionFileAttachmentContent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "name": "cv", "in": "query", "description": "Return older version of attachment content", "schema": { "type": "integer", "format": "int32", "nullable": true } } ], "responses": { "200": { "description": "Success response - body contains file content", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/FileAttachments/{id}": { "get": { "tags": [ "Requisition File Attachment" ], "summary": "Get a Requisition 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| requisitionId | RequisitionFileAttachment->Requisition_Id | integer | int64 |\r\n| requisitionCode | RequisitionFileAttachment->Requisition_Code | string | |\r\n| createdByUserId | RequisitionFileAttachment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RequisitionFileAttachment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RequisitionFileAttachment->CreatedByUser_FullName | string | |\r\n| createdOn | RequisitionFileAttachment->CreatedOn | string | date-time |\r\n| contentId | RequisitionFileAttachment->Content_Id | integer | int64 |\r\n| contentFileLocationId | RequisitionFileAttachment->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | RequisitionFileAttachment->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | RequisitionFileAttachment->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | RequisitionFileAttachment->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | RequisitionFileAttachment->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | RequisitionFileAttachment->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | RequisitionFileAttachment->Content_SizeInMb | number | decimal |\r\n| contentVersion | RequisitionFileAttachment->ContentVersion | integer | int32 |\r\n| entityType | RequisitionFileAttachment->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 | RequisitionFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | RequisitionFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | RequisitionFileAttachment->FileCategory_Description | string | |\r\n| fileCategoryAutoIsRestricted | RequisitionFileAttachment->FileCategory_AutoIsRestricted | boolean | |\r\n| fileFullName | RequisitionFileAttachment->FileFullName | string | |\r\n| fileName | RequisitionFileAttachment->FileName | string | |\r\n| fileTypeId | RequisitionFileAttachment->FileType_Id | integer | int64 |\r\n| fileTypeExtension | RequisitionFileAttachment->FileType_Extension | string | |\r\n| isRestricted | RequisitionFileAttachment->IsRestricted | boolean | |\r\n| id | RequisitionFileAttachment->Id | integer | int64 |\r\n| isActive | RequisitionFileAttachment->IsActive | boolean | |\r\n| modifiedByUserId | RequisitionFileAttachment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RequisitionFileAttachment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RequisitionFileAttachment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RequisitionFileAttachment->ModifiedOn | string | date-time |\r\n| permissionTreeId | RequisitionFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionFileAttachment->PermissionTree_Description | string | |\r\n| version | RequisitionFileAttachment->Version | integer | int32 |\r\n", "operationId": "GetRequisitionFileAttachment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Requisition File Attachment", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionFileAttachmentResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Requisition File Attachment" ], "summary": "Update an existing Requisition 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 | RequisitionFileAttachment->Version | integer | int32 |\r\n| fileCategoryId | RequisitionFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileName | RequisitionFileAttachment->FileName | string | |\r\n| isRestricted | RequisitionFileAttachment->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": "UpdateRequisitionFileAttachment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateRequisitionFileAttachmentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Requisition File Attachment was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Requisition File Attachment" ], "summary": "Delete an existing Requisition 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 | RequisitionFileAttachment->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": "DeleteRequisitionFileAttachment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteRequisitionFileAttachmentResourceResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Requisition File Attachment was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/{id}/FileAttachments": { "get": { "tags": [ "Requisition File Attachment" ], "summary": "Get a collection of Requisition File Attachment resources for the Requisition.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RequisitionFileAttachment->Id | integer | int64 |\r\n| version | RequisitionFileAttachment->Version | integer | int32 |\r\n| fileFullName | RequisitionFileAttachment->FileFullName | string | |\r\n| contentSizeInMb | RequisitionFileAttachment->Content_SizeInMb | number | decimal |\r\n| isRestricted | RequisitionFileAttachment->IsRestricted | boolean | |\r\n| fileCategoryId | RequisitionFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | RequisitionFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | RequisitionFileAttachment->FileCategory_Description | string | |\r\n| permissionTreeId | RequisitionFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionFileAttachment->PermissionTree_Description | string | |\r\n| createdOn | RequisitionFileAttachment->CreatedOn | string | date-time |\r\n| modifiedOn | RequisitionFileAttachment->ModifiedOn | string | date-time |\r\n", "operationId": "GetRequisitionFileAttachmentCollectionForRequisition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition File Attachment collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionFileAttachmentCollectionForRequisitionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/FileAttachments": { "get": { "tags": [ "Requisition File Attachment" ], "summary": "Get a collection of Requisition 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 | RequisitionFileAttachment->Id | integer | int64 |\r\n| version | RequisitionFileAttachment->Version | integer | int32 |\r\n| requisitionId | RequisitionFileAttachment->Requisition_Id | integer | int64 |\r\n| requisitionCode | RequisitionFileAttachment->Requisition_Code | string | |\r\n| fileFullName | RequisitionFileAttachment->FileFullName | string | |\r\n| contentSizeInMb | RequisitionFileAttachment->Content_SizeInMb | number | decimal |\r\n| fileTypeExtension | RequisitionFileAttachment->FileType_Extension | string | |\r\n| isRestricted | RequisitionFileAttachment->IsRestricted | boolean | |\r\n| fileCategoryId | RequisitionFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | RequisitionFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | RequisitionFileAttachment->FileCategory_Description | string | |\r\n| permissionTreeId | RequisitionFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionFileAttachment->PermissionTree_Description | string | |\r\n| createdOn | RequisitionFileAttachment->CreatedOn | string | date-time |\r\n| modifiedOn | RequisitionFileAttachment->ModifiedOn | string | date-time |\r\n", "operationId": "GetRequisitionFileAttachmentCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition File Attachment collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionFileAttachmentCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/FileAttachments/Upload": { "post": { "tags": [ "Requisition File Attachment" ], "summary": "Upload and create a new Requisition 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| requisitionId | RequisitionFileAttachment->Requisition_Id | integer | int64 |\r\n| isRestricted | RequisitionFileAttachment->IsRestricted | boolean | |\r\n| fileName | RequisitionFileAttachment->FileName | string | |\r\n| fileCategoryId | RequisitionFileAttachment->FileCategory_Id | integer | int64 |\r\n| permissionTreeId | RequisitionFileAttachment->PermissionTree_Id | integer | int64 |\r\n| bytes | RequisitionFileAttachment->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| requisitionId | Required | True | |\r\n| requisitionId | 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": "CreateRequisitionFileAttachment", "requestBody": { "x-name": "entityPost", "description": "Request Body content", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreateRequisitionFileAttachmentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/FileAttachments/{id}/Upload": { "put": { "tags": [ "Requisition File Attachment" ], "summary": "Upload new content for an existing Requisition 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 | RequisitionFileAttachment->Version | integer | int32 |\r\n| bytes | RequisitionFileAttachment->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": "UpdateRequisitionFileAttachmentContent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 } ], "requestBody": { "x-name": "entityFilePatch", "description": "Request Body content", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UpdateRequisitionFileAttachmentContentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Requisition File Attachment was successfully updated" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/FileAttachments/Batch/{ids}": { "get": { "tags": [ "Requisition File Attachment" ], "summary": "Get a collection of Requisition 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| requisitionId | RequisitionFileAttachment->Requisition_Id | integer | int64 |\r\n| requisitionCode | RequisitionFileAttachment->Requisition_Code | string | |\r\n| createdByUserId | RequisitionFileAttachment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RequisitionFileAttachment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RequisitionFileAttachment->CreatedByUser_FullName | string | |\r\n| createdOn | RequisitionFileAttachment->CreatedOn | string | date-time |\r\n| contentId | RequisitionFileAttachment->Content_Id | integer | int64 |\r\n| contentFileLocationId | RequisitionFileAttachment->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | RequisitionFileAttachment->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | RequisitionFileAttachment->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | RequisitionFileAttachment->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | RequisitionFileAttachment->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | RequisitionFileAttachment->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | RequisitionFileAttachment->Content_SizeInMb | number | decimal |\r\n| contentVersion | RequisitionFileAttachment->ContentVersion | integer | int32 |\r\n| entityType | RequisitionFileAttachment->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 | RequisitionFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | RequisitionFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | RequisitionFileAttachment->FileCategory_Description | string | |\r\n| fileCategoryAutoIsRestricted | RequisitionFileAttachment->FileCategory_AutoIsRestricted | boolean | |\r\n| fileFullName | RequisitionFileAttachment->FileFullName | string | |\r\n| fileName | RequisitionFileAttachment->FileName | string | |\r\n| fileTypeId | RequisitionFileAttachment->FileType_Id | integer | int64 |\r\n| fileTypeExtension | RequisitionFileAttachment->FileType_Extension | string | |\r\n| isRestricted | RequisitionFileAttachment->IsRestricted | boolean | |\r\n| id | RequisitionFileAttachment->Id | integer | int64 |\r\n| isActive | RequisitionFileAttachment->IsActive | boolean | |\r\n| modifiedByUserId | RequisitionFileAttachment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RequisitionFileAttachment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RequisitionFileAttachment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RequisitionFileAttachment->ModifiedOn | string | date-time |\r\n| permissionTreeId | RequisitionFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionFileAttachment->PermissionTree_Description | string | |\r\n| version | RequisitionFileAttachment->Version | integer | int32 |\r\n", "operationId": "BatchGetRequisitionFileAttachment", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Requisition File Attachment id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Requisition File Attachment collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetRequisitionFileAttachmentResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/FileAttachments/{id}/ContentHistory": { "get": { "tags": [ "Requisition File Attachment" ], "summary": "Get a collection of File Attachment Content History resources for the Requisition 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": "GetRequisitionFileAttachmentContentHistory", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Requisition File Attachment collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionFileAttachmentContentHistoryResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/FileAttachments/Upload/Batch": { "post": { "tags": [ "Requisition File Attachment" ], "summary": "Upload and create a new collection of Requisition 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| requisitionId | RequisitionFileAttachment->Requisition_Id | integer | int64 |\r\n| isRestricted | RequisitionFileAttachment->IsRestricted | boolean | |\r\n| fileName | RequisitionFileAttachment->FileName | string | |\r\n| fileCategoryId | RequisitionFileAttachment->FileCategory_Id | integer | int64 |\r\n| permissionTreeId | RequisitionFileAttachment->PermissionTree_Id | integer | int64 |\r\n| bytes | RequisitionFileAttachment->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| requisitionId | Required | True | |\r\n| requisitionId | 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": "BatchCreateRequisitionFileAttachment", "parameters": [ { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "entityPostCollection", "description": "Request Body content", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/BatchCreateRequisitionFileAttachmentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Requisition File Attachment batch was successfully created" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/FileAttachments/Batch": { "patch": { "tags": [ "Requisition File Attachment" ], "summary": "Update a collection of existing Requisition 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 | RequisitionFileAttachment->Id | integer | int64 |\r\n| version | RequisitionFileAttachment->Version | integer | int32 |\r\n| isRestricted | RequisitionFileAttachment->IsRestricted | boolean | |\r\n| fileName | RequisitionFileAttachment->FileName | string | |\r\n| fileCategoryId | RequisitionFileAttachment->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": "BatchUpdateRequisitionFileAttachment", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateRequisitionFileAttachmentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Requisition File Attachment batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Requisition File Attachment" ], "summary": "Delete a collection of existing Requisition 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 | RequisitionFileAttachment->Id | integer | int64 |\r\n| version | RequisitionFileAttachment->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": "BatchDeleteRequisitionFileAttachment", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteRequisitionFileAttachmentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Requisition File Attachment batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/{id}": { "get": { "tags": [ "Requisition Item" ], "summary": "Get a Requisition Item 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 | RequisitionItem->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RequisitionItem->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RequisitionItem->CreatedByUser_FullName | string | |\r\n| createdOn | RequisitionItem->CreatedOn | string | date-time |\r\n| modifiedByUserId | RequisitionItem->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RequisitionItem->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RequisitionItem->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RequisitionItem->ModifiedOn | string | date-time |\r\n| version | RequisitionItem->Version | integer | int32 |\r\n| permissionTreeId | RequisitionItem->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionItem->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionItem->PermissionTree_Description | string | |\r\n| id | RequisitionItem->Id | integer | int64 |\r\n| lineNumber | RequisitionItem->LineNumber | integer | int32 |\r\n| approvalWorkflowProgress | RequisitionItem->ApprovalWorkflowProgress | string (Allowed values: [NotStarted, Rejected, InProgress, Approved]) | enum |\r\n| notes | RequisitionItem->Notes | string | |\r\n| quantityIssued | RequisitionItem->QuantityIssued | number | decimal |\r\n| quantityNotIssued | RequisitionItem->QuantityNotIssued | number | decimal |\r\n| quantityOrdered | RequisitionItem->QuantityOrdered | number | decimal |\r\n| quantityRequired | RequisitionItem->QuantityRequired | number | decimal |\r\n| quantityReserved | RequisitionItem->QuantityReserved | number | decimal |\r\n| requisitionId | RequisitionItem->Requisition_Id | integer | int64 |\r\n| requisitionCode | RequisitionItem->Requisition_Code | string | |\r\n| requisitionRequestedOn | RequisitionItem->Requisition_RequestedOn | string | date-time |\r\n| requisitionStatusId | RequisitionItem->Requisition_Status_Id | integer | int64 |\r\n| requisitionStatusBaseStatus | RequisitionItem->Requisition_Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled, AwaitingApprovalWorkflow]) | enum |\r\n| sequenceNumber | RequisitionItem->SequenceNumber | integer | int32 |\r\n| totalCostInSiteCurrency | RequisitionItem->TotalCostInSiteCurrency | number | decimal |\r\n| totalCostInSpareCurrency | RequisitionItem->TotalCostInSpareCurrency | number | decimal |\r\n| workOrderTaskSpareId | RequisitionItem->WorkOrderTaskSpare_Id | integer | int64 |\r\n| workOrderTaskSpareCode | RequisitionItem->WorkOrderTaskSpare_Code | string | |\r\n| workOrderTaskSpareDescription | RequisitionItem->WorkOrderTaskSpare_Description | string | |\r\n| workOrderTaskSpareSpareType | RequisitionItem->WorkOrderTaskSpare_SpareType | string (Allowed values: [StockItem, CodedNonStockItem, DirectPurchase, Contractor]) | enum |\r\n| workOrderTaskSpareUnitPriceInSpareCurrency | RequisitionItem->WorkOrderTaskSpare_UnitPriceInSpareCurrency | number | decimal |\r\n| workOrderTaskSpareUnitPriceInWorkOrderCurrency | RequisitionItem->WorkOrderTaskSpare_UnitPriceInWorkOrderCurrency | number | decimal |\r\n| workOrderTaskSpareCostCentreId | RequisitionItem->WorkOrderTaskSpare_CostCentre_Id | integer | int64 |\r\n| workOrderTaskSpareCostCentreCode | RequisitionItem->WorkOrderTaskSpare_CostCentre_Code | string | |\r\n| workOrderTaskSpareCostCentreDescription | RequisitionItem->WorkOrderTaskSpare_CostCentre_Description | string | |\r\n| workOrderTaskSpareCostElementId | RequisitionItem->WorkOrderTaskSpare_CostElement_Id | integer | int64 |\r\n| workOrderTaskSpareCostElementCode | RequisitionItem->WorkOrderTaskSpare_CostElement_Code | string | |\r\n| workOrderTaskSpareCostElementDescription | RequisitionItem->WorkOrderTaskSpare_CostElement_Description | string | |\r\n| workOrderTaskSpareGeneralLedgerId | RequisitionItem->WorkOrderTaskSpare_GeneralLedger_Id | integer | int64 |\r\n| workOrderTaskSpareGeneralLedgerCode | RequisitionItem->WorkOrderTaskSpare_GeneralLedger_Code | string | |\r\n| workOrderTaskSpareGeneralLedgerDescription | RequisitionItem->WorkOrderTaskSpare_GeneralLedger_Description | string | |\r\n| workOrderTaskSpareSpareCurrencyId | RequisitionItem->WorkOrderTaskSpare_SpareCurrency_Id | integer | int64 |\r\n| workOrderTaskSpareSpareCurrencyCode | RequisitionItem->WorkOrderTaskSpare_SpareCurrency_Code | string | |\r\n| workOrderTaskSpareSpareCurrencyDescription | RequisitionItem->WorkOrderTaskSpare_SpareCurrency_Description | string | |\r\n| workOrderTaskSpareStockItemId | RequisitionItem->WorkOrderTaskSpare_StockItem_Id | integer | int64 |\r\n| workOrderTaskSpareStockItemMaterialMasterId | RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Id | integer | int64 |\r\n| workOrderTaskSpareStockItemMaterialMasterCode | RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Code | string | |\r\n| workOrderTaskSpareStockItemMaterialMasterDescription | RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Description | string | |\r\n| workOrderTaskSpareStockItemWarehouseId | RequisitionItem->WorkOrderTaskSpare_StockItem_Warehouse_Id | integer | int64 |\r\n| workOrderTaskSpareStockItemWarehouseCode | RequisitionItem->WorkOrderTaskSpare_StockItem_Warehouse_Code | string | |\r\n| workOrderTaskSpareSupplierId | RequisitionItem->WorkOrderTaskSpare_Supplier_Id | integer | int64 |\r\n| workOrderTaskSpareSupplierCode | RequisitionItem->WorkOrderTaskSpare_Supplier_Code | string | |\r\n| workOrderTaskSpareSupplierDescription | RequisitionItem->WorkOrderTaskSpare_Supplier_Description | string | |\r\n| workOrderTaskSpareUnitOfMeasurementId | RequisitionItem->WorkOrderTaskSpare_UnitOfMeasurement_Id | integer | int64 |\r\n| workOrderTaskSpareUnitOfMeasurementCode | RequisitionItem->WorkOrderTaskSpare_UnitOfMeasurement_Code | string | |\r\n| workOrderTaskSpareUnitOfMeasurementDescription | RequisitionItem->WorkOrderTaskSpare_UnitOfMeasurement_Description | string | |\r\n| workOrderTaskSpareWorkOrderCurrencyId | RequisitionItem->WorkOrderTaskSpare_WorkOrderCurrency_Id | integer | int64 |\r\n| workOrderTaskSpareWorkOrderCurrencyCode | RequisitionItem->WorkOrderTaskSpare_WorkOrderCurrency_Code | string | |\r\n| workOrderTaskSpareWorkOrderCurrencyDescription | RequisitionItem->WorkOrderTaskSpare_WorkOrderCurrency_Description | string | |\r\n| workOrderTaskSpareWorkOrderTaskId | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskSpareWorkOrderTaskTaskCode | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskSpareWorkOrderTaskTaskDescription | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskSpareInfoId | RequisitionItem->WorkOrderTaskSpareInfoId | integer | int64 |\r\n| code | RequisitionItem->Code | string | |\r\n| costCentreId | RequisitionItem->CostCentre_Id | integer | int64 |\r\n| costCentreDescription | RequisitionItem->CostCentre_Description | string | |\r\n| costCentreCode | RequisitionItem->CostCentre_Code | string | |\r\n| costElementId | RequisitionItem->CostElement_Id | integer | int64 |\r\n| costElementDescription | RequisitionItem->CostElement_Description | string | |\r\n| costElementCode | RequisitionItem->CostElement_Code | string | |\r\n| description | RequisitionItem->Description | string | |\r\n| financialYearPeriodId | RequisitionItem->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodDescription | RequisitionItem->FinancialYearPeriod_Description | string | |\r\n| financialYearPeriodCode | RequisitionItem->FinancialYearPeriod_Code | string | |\r\n| generalLedgerId | RequisitionItem->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerDescription | RequisitionItem->GeneralLedger_Description | string | |\r\n| generalLedgerCode | RequisitionItem->GeneralLedger_Code | string | |\r\n| requiredOn | RequisitionItem->RequiredOn | string | date-time |\r\n| spareToWorkOrderCurrencyRateValue | RequisitionItem->SpareToWorkOrderCurrencyRateValue | number | decimal |\r\n| spareType | RequisitionItem->SpareType | string (Allowed values: [StockItem, CodedNonStockItem, DirectPurchase, Contractor]) | enum |\r\n| stockItemId | RequisitionItem->StockItem_Id | integer | int64 |\r\n| stockItemAlternativeDescription | RequisitionItem->StockItem_AlternativeDescription | string | |\r\n| stockItemMaterialMasterId | RequisitionItem->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | RequisitionItem->StockItem_MaterialMaster_Code | string | |\r\n| stockItemWarehouseId | RequisitionItem->StockItem_Warehouse_Id | integer | int64 |\r\n| stockItemWarehouseCode | RequisitionItem->StockItem_Warehouse_Code | string | |\r\n| supplierId | RequisitionItem->Supplier_Id | integer | int64 |\r\n| supplierDescription | RequisitionItem->Supplier_Description | string | |\r\n| supplierCode | RequisitionItem->Supplier_Code | string | |\r\n| unitOfMeasurementId | RequisitionItem->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementDescription | RequisitionItem->UnitOfMeasurement_Description | string | |\r\n| unitOfMeasurementCode | RequisitionItem->UnitOfMeasurement_Code | string | |\r\n| unitPriceInSpareCurrency | RequisitionItem->UnitPriceInSpareCurrency | number | decimal |\r\n| workOrderTaskId | RequisitionItem->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | RequisitionItem->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | RequisitionItem->WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskTaskType | RequisitionItem->WorkOrderTask_TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| workOrderTaskWorkOrderId | RequisitionItem->WorkOrderTask_WorkOrder_Id | integer | int64 |\r\n| workOrderTaskWorkOrderCode | RequisitionItem->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskWorkOrderDescription | RequisitionItem->WorkOrderTask_WorkOrder_Description | string | |\r\n", "operationId": "GetRequisitionItem", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Item Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Requisition Item", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionItemResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Requisition Item" ], "summary": "Update an existing Requisition Item resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RequisitionItem->Version | integer | int32 |\r\n| code | RequisitionItem->Code | string | |\r\n| costCentreId | RequisitionItem->CostCentre_Id | integer | int64 |\r\n| costElementId | RequisitionItem->CostElement_Id | integer | int64 |\r\n| description | RequisitionItem->Description | string | |\r\n| financialYearPeriodId | RequisitionItem->FinancialYearPeriod_Id | integer | int64 |\r\n| generalLedgerId | RequisitionItem->GeneralLedger_Id | integer | int64 |\r\n| notes | RequisitionItem->Notes | string | |\r\n| quantityRequired | RequisitionItem->QuantityRequired | number | decimal |\r\n| sequenceNumber | RequisitionItem->SequenceNumber | integer | int32 |\r\n| quantityOrdered | RequisitionItem->QuantityOrdered | number | decimal |\r\n| quantityReserved | RequisitionItem->QuantityReserved | number | decimal |\r\n| requiredOn | RequisitionItem->RequiredOn | string | date-time |\r\n| sequenceNumber | RequisitionItem->SequenceNumber | integer | int32 |\r\n| spareToWorkOrderCurrencyRateValue | RequisitionItem->SpareToWorkOrderCurrencyRateValue | number | decimal |\r\n| supplierId | RequisitionItem->Supplier_Id | integer | int64 |\r\n| unitOfMeasurementId | RequisitionItem->UnitOfMeasurement_Id | integer | int64 |\r\n| unitPriceInSpareCurrency | RequisitionItem->UnitPriceInSpareCurrency | 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| quantityRequired | Nullable | False | |\r\n| quantityRequired | Min Value | >= 0| |\r\n| quantityOrdered | Min Value | >= 0| |\r\n\r\n", "operationId": "UpdateRequisitionItem", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Item Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateRequisitionItemResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Requisition Item was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Requisition Item" ], "summary": "Delete an existing Requisition Item resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RequisitionItem->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": "DeleteRequisitionItem", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Item Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteRequisitionItemResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Requisition Item was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/{id}/Approvals": { "get": { "tags": [ "Requisition Item" ], "summary": "Get a collection of Requisition Item resources for the Requisition Item.", "description": "### Response Body\r\n#### Payload\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| 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| expressionId | Approval->Expression_Id | integer | int64 |\r\n| expressionDescription | Approval->Expression_Description | 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| remark | Approval->Remark | string | |\r\n| roleCode | Approval->Role_Code | string | |\r\n| roleDescription | Approval->Role_Description | string | |\r\n| status | Approval->Status | string (Allowed values: [AwaitingApproval, Approved, Rejected, RoleCountReached]) | enum |\r\n", "operationId": "GetApprovalForRequisitionItemCollection", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Item Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition Item collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetApprovalForRequisitionItemCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items": { "get": { "tags": [ "Requisition Item" ], "summary": "Get a collection of Requisition Item 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 | RequisitionItem->Id | integer | int64 |\r\n| version | RequisitionItem->Version | integer | int32 |\r\n| requisitionId | RequisitionItem->Requisition_Id | integer | int64 |\r\n| requisitionCode | RequisitionItem->Requisition_Code | string | |\r\n| requisitionRequestedOn | RequisitionItem->Requisition_RequestedOn | string | date-time |\r\n| requisitionStatusCode | RequisitionItem->Requisition_Status_Code | string | |\r\n| requisitionStatusBaseStatus | RequisitionItem->Requisition_Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled, AwaitingApprovalWorkflow]) | enum |\r\n| requisitionWorkOrderCode | RequisitionItem->Requisition_WorkOrder_Code | string | |\r\n| requisitionWorkOrderStatusCode | RequisitionItem->Requisition_WorkOrder_Status_Code | string | |\r\n| workOrderTaskSpareId | RequisitionItem->WorkOrderTaskSpare_Id | integer | int64 |\r\n| workOrderTaskSpareCode | RequisitionItem->WorkOrderTaskSpare_Code | string | |\r\n| workOrderTaskSpareDescription | RequisitionItem->WorkOrderTaskSpare_Description | string | |\r\n| workOrderTaskSpareWorkOrderTaskTaskId | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskId | integer | int64 |\r\n| workOrderTaskSpareWorkOrderTaskTaskCode | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskSpareWorkOrderTaskTaskDescription | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskSpareWorkOrderTaskTaskType | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| workOrderTaskSpareWorkOrderTaskWorkOrderGeneralLedgerId | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_WorkOrder_GeneralLedger_Id | integer | int64 |\r\n| workOrderTaskSpareWorkOrderTaskWorkOrderGeneralLedgerCode | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_WorkOrder_GeneralLedger_Code | string | |\r\n| workOrderTaskSpareWorkOrderTaskWorkOrderGeneralLedgerDescription | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_WorkOrder_GeneralLedger_Description | string | |\r\n| workOrderTaskSpareWorkOrderTaskWorkOrderCostCentreId | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_WorkOrder_CostCentre_Id | integer | int64 |\r\n| workOrderTaskSpareWorkOrderTaskWorkOrderCostCentreCode | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_WorkOrder_CostCentre_Code | string | |\r\n| workOrderTaskSpareWorkOrderTaskWorkOrderCostCentreDescription | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_WorkOrder_CostCentre_Description | string | |\r\n| workOrderTaskSpareSpareType | RequisitionItem->WorkOrderTaskSpare_SpareType | string (Allowed values: [StockItem, CodedNonStockItem, DirectPurchase, Contractor]) | enum |\r\n| workOrderTaskSpareStockItemMaterialMasterId | RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Id | integer | int64 |\r\n| workOrderTaskSpareStockItemMaterialMasterCode | RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Code | string | |\r\n| workOrderTaskSpareStockItemMaterialMasterDescription | RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Description | string | |\r\n| workOrderTaskSpareStockItemAverageItemCost | RequisitionItem->WorkOrderTaskSpare_StockItem_AverageItemCost | number | decimal |\r\n| workOrderTaskSpareStockItemQuantityOnHand | RequisitionItem->WorkOrderTaskSpare_StockItem_QuantityOnHand | number | decimal |\r\n| workOrderTaskSpareStockItemWarehouseCode | RequisitionItem->WorkOrderTaskSpare_StockItem_Warehouse_Code | string | |\r\n| workOrderTaskSpareStockItemWarehouseDescription | RequisitionItem->WorkOrderTaskSpare_StockItem_Warehouse_Description | string | |\r\n| workOrderTaskSpareStockItemCostElementId | RequisitionItem->WorkOrderTaskSpare_StockItem_CostElement_Id | integer | int64 |\r\n| workOrderTaskSpareStockItemCostElementCode | RequisitionItem->WorkOrderTaskSpare_StockItem_CostElement_Code | string | |\r\n| workOrderTaskSpareStockItemCostElementDescription | RequisitionItem->WorkOrderTaskSpare_StockItem_CostElement_Description | string | |\r\n| workOrderTaskSpareUnitOfMeasurementCode | RequisitionItem->WorkOrderTaskSpare_UnitOfMeasurement_Code | string | |\r\n| workOrderTaskSpareUnitOfMeasurementDescription | RequisitionItem->WorkOrderTaskSpare_UnitOfMeasurement_Description | string | |\r\n| workOrderTaskSpareSupplierCode | RequisitionItem->WorkOrderTaskSpare_Supplier_Code | string | |\r\n| workOrderTaskSpareSupplierDescription | RequisitionItem->WorkOrderTaskSpare_Supplier_Description | string | |\r\n| workOrderTaskSpareSpareCurrencyId | RequisitionItem->WorkOrderTaskSpare_SpareCurrency_Id | integer | int64 |\r\n| workOrderTaskSpareSpareCurrencyCode | RequisitionItem->WorkOrderTaskSpare_SpareCurrency_Code | string | |\r\n| workOrderTaskSpareSpareCurrencyDescription | RequisitionItem->WorkOrderTaskSpare_SpareCurrency_Description | string | |\r\n| workOrderTaskSpareTotalUsedInWorkOrderCurrency | RequisitionItem->WorkOrderTaskSpare_TotalUsedInWorkOrderCurrency | number | decimal |\r\n| workOrderTaskSpareWorkOrderCurrencyId | RequisitionItem->WorkOrderTaskSpare_WorkOrderCurrency_Id | integer | int64 |\r\n| workOrderTaskSpareWorkOrderCurrencyCode | RequisitionItem->WorkOrderTaskSpare_WorkOrderCurrency_Code | string | |\r\n| workOrderTaskSpareWorkOrderCurrencyDescription | RequisitionItem->WorkOrderTaskSpare_WorkOrderCurrency_Description | string | |\r\n| workOrderTaskSpareUnitPriceInSpareCurrency | RequisitionItem->WorkOrderTaskSpare_UnitPriceInSpareCurrency | number | decimal |\r\n| workOrderTaskSpareUnitPriceInWorkOrderCurrency | RequisitionItem->WorkOrderTaskSpare_UnitPriceInWorkOrderCurrency | number | decimal |\r\n| quantityRequired | RequisitionItem->QuantityRequired | number | decimal |\r\n| quantityIssued | RequisitionItem->QuantityIssued | number | decimal |\r\n| quantityOrdered | RequisitionItem->QuantityOrdered | number | decimal |\r\n| quantityReserved | RequisitionItem->QuantityReserved | number | decimal |\r\n| quantityNotIssued | RequisitionItem->QuantityNotIssued | number | decimal |\r\n| generalLedgerId | RequisitionItem->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | RequisitionItem->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | RequisitionItem->GeneralLedger_Description | string | |\r\n| costCentreId | RequisitionItem->CostCentre_Id | integer | int64 |\r\n| costCentreCode | RequisitionItem->CostCentre_Code | string | |\r\n| costCentreDescription | RequisitionItem->CostCentre_Description | string | |\r\n| costElementId | RequisitionItem->CostElement_Id | integer | int64 |\r\n| costElementCode | RequisitionItem->CostElement_Code | string | |\r\n| costElementDescription | RequisitionItem->CostElement_Description | string | |\r\n| supplierId | RequisitionItem->Supplier_Id | integer | int64 |\r\n| supplierCode | RequisitionItem->Supplier_Code | string | |\r\n| supplierDescription | RequisitionItem->Supplier_Description | string | |\r\n| financialYearPeriodId | RequisitionItem->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodCode | RequisitionItem->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | RequisitionItem->FinancialYearPeriod_Description | string | |\r\n| unitOfMeasurementId | RequisitionItem->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | RequisitionItem->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | RequisitionItem->UnitOfMeasurement_Description | string | |\r\n| unitPriceInSpareCurrency | RequisitionItem->UnitPriceInSpareCurrency | number | decimal |\r\n| code | RequisitionItem->Code | string | |\r\n| description | RequisitionItem->Description | string | |\r\n", "operationId": "GetRequisitionItemCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition Item collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionItemCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Requisition Item" ], "summary": "Create a new Requisition Item resource.", "description": "### Request Body\r\n#### 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 | RequisitionItem->Code | string | |\r\n| costCentreId | RequisitionItem->CostCentre_Id | integer | int64 |\r\n| costElementId | RequisitionItem->CostElement_Id | integer | int64 |\r\n| description | RequisitionItem->Description | string | |\r\n| financialYearPeriodId | RequisitionItem->FinancialYearPeriod_Id | integer | int64 |\r\n| generalLedgerId | RequisitionItem->GeneralLedger_Id | integer | int64 |\r\n| notes | RequisitionItem->Notes | string | |\r\n| permissionTreeId | RequisitionItem->PermissionTree_Id | integer | int64 |\r\n| quantityRequired | RequisitionItem->QuantityRequired | number | decimal |\r\n| requiredOn | RequisitionItem->RequiredOn | string | date-time |\r\n| requisitionId | RequisitionItem->Requisition_Id | integer | int64 |\r\n| sequenceNumber | RequisitionItem->SequenceNumber | integer | int32 |\r\n| spareToWorkOrderCurrencyRateValue | RequisitionItem->SpareToWorkOrderCurrencyRateValue | number | decimal |\r\n| spareType | RequisitionItem->SpareType | string (Allowed values: [StockItem, CodedNonStockItem, DirectPurchase, Contractor]) | enum |\r\n| stockItemId | RequisitionItem->StockItem_Id | integer | int64 |\r\n| supplierId | RequisitionItem->Supplier_Id | integer | int64 |\r\n| unitOfMeasurementId | RequisitionItem->UnitOfMeasurement_Id | integer | int64 |\r\n| unitPriceInSpareCurrency | RequisitionItem->UnitPriceInSpareCurrency | number | decimal |\r\n| workOrderTaskId | RequisitionItem->WorkOrderTask_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| costCentreId | System Generated | true | If no value specified |\r\n| costElementId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| generalLedgerId | System Generated | true | If no value specified |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| quantityRequired | Required | True | |\r\n| quantityRequired | Nullable | False | |\r\n| quantityRequired | Min Value | >= 0| |\r\n| requiredOn | Required | True | |\r\n| requiredOn | Nullable | False | |\r\n| requisitionId | Required | True | |\r\n| requisitionId | Nullable | False | |\r\n| spareToWorkOrderCurrencyRateValue | System Generated | true | If no value specified |\r\n| spareType | Required | True | |\r\n| spareType | Nullable | False | |\r\n\r\n", "operationId": "CreateRequisitionItem", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateRequisitionItemResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/{requisitionId}/Items": { "get": { "tags": [ "Requisition Item" ], "summary": "Get a collection of Requisition Item resources for the Requisition.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RequisitionItem->Id | integer | int64 |\r\n| version | RequisitionItem->Version | integer | int32 |\r\n| requisitionCode | RequisitionItem->Requisition_Code | string | |\r\n| quantityRequired | RequisitionItem->QuantityRequired | number | decimal |\r\n| workOrderTaskSpareCode | RequisitionItem->WorkOrderTaskSpare_Code | string | |\r\n| workOrderTaskSpareDescription | RequisitionItem->WorkOrderTaskSpare_Description | string | |\r\n| workOrderTaskSpareWorkOrderTaskWorkOrderCode | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskSpareWorkOrderTaskTaskCode | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskSpareWorkOrderTaskTaskDescription | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskSpareSpareType | RequisitionItem->WorkOrderTaskSpare_SpareType | string (Allowed values: [StockItem, CodedNonStockItem, DirectPurchase, Contractor]) | enum |\r\n| workOrderTaskSpareStockItemMaterialMasterId | RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Id | integer | int64 |\r\n| workOrderTaskSpareStockItemMaterialMasterCode | RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Code | string | |\r\n| workOrderTaskSpareStockItemMaterialMasterDescription | RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Description | string | |\r\n| workOrderTaskSpareStockItemWarehouseCode | RequisitionItem->WorkOrderTaskSpare_StockItem_Warehouse_Code | string | |\r\n| workOrderTaskSpareStockItemWarehouseDescription | RequisitionItem->WorkOrderTaskSpare_StockItem_Warehouse_Description | string | |\r\n| workOrderTaskSpareStockItemAverageItemCost | RequisitionItem->WorkOrderTaskSpare_StockItem_AverageItemCost | number | decimal |\r\n| workOrderTaskSpareStockItemQuantityOnHand | RequisitionItem->WorkOrderTaskSpare_StockItem_QuantityOnHand | number | decimal |\r\n| workOrderTaskSpareSupplierCode | RequisitionItem->WorkOrderTaskSpare_Supplier_Code | string | |\r\n| workOrderTaskSpareSupplierDescription | RequisitionItem->WorkOrderTaskSpare_Supplier_Description | string | |\r\n| workOrderTaskSpareUnitPriceInSpareCurrency | RequisitionItem->WorkOrderTaskSpare_UnitPriceInSpareCurrency | number | decimal |\r\n| workOrderTaskSpareUnitPriceInWorkOrderCurrency | RequisitionItem->WorkOrderTaskSpare_UnitPriceInWorkOrderCurrency | number | decimal |\r\n| workOrderTaskSpareTotalUsedInWorkOrderCurrency | RequisitionItem->WorkOrderTaskSpare_TotalUsedInWorkOrderCurrency | number | decimal |\r\n| quantityIssued | RequisitionItem->QuantityIssued | number | decimal |\r\n| quantityNotIssued | RequisitionItem->QuantityNotIssued | number | decimal |\r\n", "operationId": "GetRequisitionItemForRequisitionCollection", "parameters": [ { "name": "requisitionId", "in": "path", "required": true, "description": "Requisition Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition Item collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionItemForRequisitionCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Lookups/LookupRequisitionItemChangePermissionTree": { "get": { "tags": [ "Requisition Item" ], "summary": "Lookup the permission set for changing the Requisition Item.", "description": "### Response Body\r\n#### Payload\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": "LookupRequisitionItemChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionItemChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Lookups/LookupRequisitionItemCodedNonStockItemForSite": { "get": { "tags": [ "Requisition Item" ], "summary": "Lookup the Stock Item for the Requisition Item.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItem->Id | integer | int64 |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| warehouseCode | StockItem->Warehouse_Code | string | |\r\n| warehouseDescription | StockItem->Warehouse_Description | string | |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| materialMasterDescription | StockItem->MaterialMaster_Description | string | |\r\n| defaultStockItemSupplierSupplierId | StockItem->DefaultStockItemSupplier_Supplier_Id | integer | int64 |\r\n| defaultStockItemSupplierSupplierCode | StockItem->DefaultStockItemSupplier_Supplier_Code | string | |\r\n| defaultStockItemSupplierSupplierDescription | StockItem->DefaultStockItemSupplier_Supplier_Description | string | |\r\n| defaultStockItemSupplierSupplierSiteCurrencyId | StockItem->DefaultStockItemSupplier_Supplier_Site_Currency_Id | integer | int64 |\r\n| defaultStockItemSupplierSupplierSiteCurrencyCode | StockItem->DefaultStockItemSupplier_Supplier_Site_Currency_Code | string | |\r\n| defaultStockItemSupplierSupplierSiteCurrencyDescription | StockItem->DefaultStockItemSupplier_Supplier_Site_Currency_Description | string | |\r\n| unitOfMeasurementId | StockItem->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | StockItem->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | StockItem->UnitOfMeasurement_Description | string | |\r\n| averageItemCost | StockItem->AverageItemCost | number | decimal |\r\n| quantityOnHand | StockItem->QuantityOnHand | number | decimal |\r\n", "operationId": "LookupRequisitionItemCodedNonStockItemForSite", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Stock Item collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionItemCodedNonStockItemForSiteLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Lookups/LookupRequisitionItemCodedNonStockItem": { "get": { "tags": [ "Requisition Item" ], "summary": "Lookup the Stock Item for the Requisition Item.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItem->Id | integer | int64 |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| warehouseCode | StockItem->Warehouse_Code | string | |\r\n| warehouseDescription | StockItem->Warehouse_Description | string | |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| materialMasterDescription | StockItem->MaterialMaster_Description | string | |\r\n| defaultStockItemSupplierSupplierId | StockItem->DefaultStockItemSupplier_Supplier_Id | integer | int64 |\r\n| defaultStockItemSupplierSupplierCode | StockItem->DefaultStockItemSupplier_Supplier_Code | string | |\r\n| defaultStockItemSupplierSupplierDescription | StockItem->DefaultStockItemSupplier_Supplier_Description | string | |\r\n| defaultStockItemSupplierSupplierSiteCurrencyId | StockItem->DefaultStockItemSupplier_Supplier_Site_Currency_Id | integer | int64 |\r\n| defaultStockItemSupplierSupplierSiteCurrencyCode | StockItem->DefaultStockItemSupplier_Supplier_Site_Currency_Code | string | |\r\n| defaultStockItemSupplierSupplierSiteCurrencyDescription | StockItem->DefaultStockItemSupplier_Supplier_Site_Currency_Description | string | |\r\n| unitOfMeasurementId | StockItem->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | StockItem->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | StockItem->UnitOfMeasurement_Description | string | |\r\n| averageItemCost | StockItem->AverageItemCost | number | decimal |\r\n| quantityOnHand | StockItem->QuantityOnHand | number | decimal |\r\n", "operationId": "LookupRequisitionItemCodedNonStockItem", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Stock Item collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionItemCodedNonStockItemLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Lookups/LookupRequisitionItemCostCentre": { "get": { "tags": [ "Requisition Item" ], "summary": "Lookup the Cost Centre for the Requisition Item.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentre->Id | integer | int64 |\r\n| code | CostCentre->Code | string | |\r\n| description | CostCentre->Description | string | |\r\n", "operationId": "LookupRequisitionItemCostCentre", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Cost Centre collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionItemCostCentreLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Lookups/LookupRequisitionItemCostElement": { "get": { "tags": [ "Requisition Item" ], "summary": "Lookup the Cost Element for the Requisition Item.", "description": "### Response Body\r\n#### Payload\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": "LookupRequisitionItemCostElement", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Cost Element collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionItemCostElementLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Lookups/LookupRequisitionItemFinancialYearPeriodCode": { "get": { "tags": [ "Requisition Item" ], "summary": "Lookup the Financial Year Period for the Requisition Item.", "description": "### Response Body\r\n#### Payload\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": "LookupRequisitionItemFinancialYearPeriodCode", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Financial Year Period collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionItemFinancialYearPeriodCodeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Lookups/LookupRequisitionItemFinancialYearPeriod": { "get": { "tags": [ "Requisition Item" ], "summary": "Lookup the Financial Year Period for the Requisition Item.", "description": "### Response Body\r\n#### Payload\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": "LookupRequisitionItemFinancialYearPeriod", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Financial Year Period collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionItemFinancialYearPeriodLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Lookups/LookupRequisitionItemGeneralLedger": { "get": { "tags": [ "Requisition Item" ], "summary": "Lookup the General Ledger for the Requisition Item.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedger->Id | integer | int64 |\r\n| code | GeneralLedger->Code | string | |\r\n| description | GeneralLedger->Description | string | |\r\n", "operationId": "LookupRequisitionItemGeneralLedger", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable General Ledger collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionItemGeneralLedgerLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Lookups/LookupRequisitionItemInsertPermissionTree": { "get": { "tags": [ "Requisition Item" ], "summary": "Lookup the permission set for creating the Requisition Item.", "description": "### Response Body\r\n#### Payload\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": "LookupRequisitionItemInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionItemInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Lookups/LookupRequisitionItemRequisition": { "get": { "tags": [ "Requisition Item" ], "summary": "Lookup the Cost Centre for the Requisition Item.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Requisition->Id | integer | int64 |\r\n| code | Requisition->Code | string | |\r\n| requestedOn | Requisition->RequestedOn | string | date-time |\r\n| statusCode | Requisition->Status_Code | string | |\r\n| workOrderId | Requisition->WorkOrder_Id | integer | int64 |\r\n", "operationId": "LookupRequisitionItemRequisition", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionItemRequisitionLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Lookups/LookupRequisitionItemStockItemForAsset": { "get": { "tags": [ "Requisition Item" ], "summary": "Lookup the Stock Item for the Requisition Item.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItem->Id | integer | int64 |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| warehouseCode | StockItem->Warehouse_Code | string | |\r\n| warehouseDescription | StockItem->Warehouse_Description | string | |\r\n| warehouseSiteCurrencyId | StockItem->Warehouse_Site_Currency_Id | integer | int64 |\r\n| warehouseSiteCurrencyCode | StockItem->Warehouse_Site_Currency_Code | string | |\r\n| warehouseSiteCurrencyDescription | StockItem->Warehouse_Site_Currency_Description | string | |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| materialMasterDescription | StockItem->MaterialMaster_Description | string | |\r\n| defaultStockItemSupplierSupplierId | StockItem->DefaultStockItemSupplier_Supplier_Id | integer | int64 |\r\n| defaultStockItemSupplierSupplierCode | StockItem->DefaultStockItemSupplier_Supplier_Code | string | |\r\n| defaultStockItemSupplierSupplierDescription | StockItem->DefaultStockItemSupplier_Supplier_Description | string | |\r\n| unitOfMeasurementId | StockItem->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | StockItem->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | StockItem->UnitOfMeasurement_Description | string | |\r\n| averageItemCost | StockItem->AverageItemCost | number | decimal |\r\n| quantityOnHand | StockItem->QuantityOnHand | number | decimal |\r\n", "operationId": "LookupRequisitionItemStockItemForAsset", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Stock Item collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionItemStockItemForAssetSpareLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Lookups/LookupRequisitionItemStockItemForSite": { "get": { "tags": [ "Requisition Item" ], "summary": "Lookup the Stock Item for the Requisition Item.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItem->Id | integer | int64 |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| warehouseCode | StockItem->Warehouse_Code | string | |\r\n| warehouseDescription | StockItem->Warehouse_Description | string | |\r\n| warehouseSiteCurrencyId | StockItem->Warehouse_Site_Currency_Id | integer | int64 |\r\n| warehouseSiteCurrencyCode | StockItem->Warehouse_Site_Currency_Code | string | |\r\n| warehouseSiteCurrencyDescription | StockItem->Warehouse_Site_Currency_Description | string | |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| materialMasterDescription | StockItem->MaterialMaster_Description | string | |\r\n| defaultStockItemSupplierSupplierId | StockItem->DefaultStockItemSupplier_Supplier_Id | integer | int64 |\r\n| defaultStockItemSupplierSupplierCode | StockItem->DefaultStockItemSupplier_Supplier_Code | string | |\r\n| defaultStockItemSupplierSupplierDescription | StockItem->DefaultStockItemSupplier_Supplier_Description | string | |\r\n| unitOfMeasurementId | StockItem->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | StockItem->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | StockItem->UnitOfMeasurement_Description | string | |\r\n| averageItemCost | StockItem->AverageItemCost | number | decimal |\r\n| quantityOnHand | StockItem->QuantityOnHand | number | decimal |\r\n", "operationId": "LookupRequisitionItemStockItemForSite", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Stock Item collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionItemStockItemForSiteLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Lookups/LookupRequisitionItemStockItemForWorkOrderSite": { "get": { "tags": [ "Requisition Item" ], "summary": "Lookup the Stock Item for the Requisition Item.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItem->Id | integer | int64 |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| warehouseCode | StockItem->Warehouse_Code | string | |\r\n| warehouseDescription | StockItem->Warehouse_Description | string | |\r\n| warehouseSiteCurrencyId | StockItem->Warehouse_Site_Currency_Id | integer | int64 |\r\n| warehouseSiteCurrencyCode | StockItem->Warehouse_Site_Currency_Code | string | |\r\n| warehouseSiteCurrencyDescription | StockItem->Warehouse_Site_Currency_Description | string | |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| materialMasterDescription | StockItem->MaterialMaster_Description | string | |\r\n| defaultStockItemSupplierSupplierId | StockItem->DefaultStockItemSupplier_Supplier_Id | integer | int64 |\r\n| defaultStockItemSupplierSupplierCode | StockItem->DefaultStockItemSupplier_Supplier_Code | string | |\r\n| defaultStockItemSupplierSupplierDescription | StockItem->DefaultStockItemSupplier_Supplier_Description | string | |\r\n| unitOfMeasurementId | StockItem->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | StockItem->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | StockItem->UnitOfMeasurement_Description | string | |\r\n| averageItemCost | StockItem->AverageItemCost | number | decimal |\r\n| quantityOnHand | StockItem->QuantityOnHand | number | decimal |\r\n", "operationId": "LookupRequisitionItemStockItemForWorkOrderSite", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Stock Item collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionItemStockItemForWorkOrderSiteLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Lookups/LookupRequisitionItemStockItem": { "get": { "tags": [ "Requisition Item" ], "summary": "Lookup the Stock Item for the Requisition Item.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItem->Id | integer | int64 |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| warehouseCode | StockItem->Warehouse_Code | string | |\r\n| warehouseDescription | StockItem->Warehouse_Description | string | |\r\n| warehouseSiteCurrencyId | StockItem->Warehouse_Site_Currency_Id | integer | int64 |\r\n| warehouseSiteCurrencyCode | StockItem->Warehouse_Site_Currency_Code | string | |\r\n| warehouseSiteCurrencyDescription | StockItem->Warehouse_Site_Currency_Description | string | |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| materialMasterDescription | StockItem->MaterialMaster_Description | string | |\r\n| defaultStockItemSupplierSupplierId | StockItem->DefaultStockItemSupplier_Supplier_Id | integer | int64 |\r\n| defaultStockItemSupplierSupplierCode | StockItem->DefaultStockItemSupplier_Supplier_Code | string | |\r\n| defaultStockItemSupplierSupplierDescription | StockItem->DefaultStockItemSupplier_Supplier_Description | string | |\r\n| unitOfMeasurementId | StockItem->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | StockItem->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | StockItem->UnitOfMeasurement_Description | string | |\r\n| averageItemCost | StockItem->AverageItemCost | number | decimal |\r\n| quantityOnHand | StockItem->QuantityOnHand | number | decimal |\r\n", "operationId": "LookupRequisitionItemStockItem", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Stock Item collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionItemStockItemLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Lookups/LookupRequisitionItemSupplier": { "get": { "tags": [ "Requisition Item" ], "summary": "Lookup the Supplier for the Requisition Item.", "description": "### Response Body\r\n#### Payload\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| currencyId | Supplier->Currency_Id | integer | int64 |\r\n| currencyCode | Supplier->Currency_Code | string | |\r\n| currencyDescription | Supplier->Currency_Description | string | |\r\n", "operationId": "LookupRequisitionItemSupplier", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Supplier collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionItemSupplierLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Lookups/LookupRequisitionItemUnitOfMeasurement": { "get": { "tags": [ "Requisition Item" ], "summary": "Lookup the Unit Of Measurement for the Requisition Item.", "description": "### Response Body\r\n#### Payload\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": "LookupRequisitionItemUnitOfMeasurement", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Unit Of Measurement collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionItemUnitOfMeasurementLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Lookups/LookupRequisitionItemWorkOrderTask": { "get": { "tags": [ "Requisition Item" ], "summary": "Lookup the Work Order Task for the Requisition Item.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrderTask->Id | integer | int64 |\r\n| workOrderId | WorkOrderTask->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderTask->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderTask->WorkOrder_Description | string | |\r\n| taskCode | WorkOrderTask->TaskCode | string | |\r\n| taskDescription | WorkOrderTask->TaskDescription | string | |\r\n| taskType | WorkOrderTask->TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n", "operationId": "LookupRequisitionItemWorkOrderTask", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Work Order Task collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionItemWorkOrderTaskLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Batch/{ids}": { "get": { "tags": [ "Requisition Item" ], "summary": "Get a collection of Requisition Item 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 | RequisitionItem->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RequisitionItem->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RequisitionItem->CreatedByUser_FullName | string | |\r\n| createdOn | RequisitionItem->CreatedOn | string | date-time |\r\n| modifiedByUserId | RequisitionItem->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RequisitionItem->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RequisitionItem->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RequisitionItem->ModifiedOn | string | date-time |\r\n| version | RequisitionItem->Version | integer | int32 |\r\n| permissionTreeId | RequisitionItem->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionItem->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionItem->PermissionTree_Description | string | |\r\n| id | RequisitionItem->Id | integer | int64 |\r\n| lineNumber | RequisitionItem->LineNumber | integer | int32 |\r\n| approvalWorkflowProgress | RequisitionItem->ApprovalWorkflowProgress | string (Allowed values: [NotStarted, Rejected, InProgress, Approved]) | enum |\r\n| notes | RequisitionItem->Notes | string | |\r\n| quantityIssued | RequisitionItem->QuantityIssued | number | decimal |\r\n| quantityNotIssued | RequisitionItem->QuantityNotIssued | number | decimal |\r\n| quantityOrdered | RequisitionItem->QuantityOrdered | number | decimal |\r\n| quantityRequired | RequisitionItem->QuantityRequired | number | decimal |\r\n| quantityReserved | RequisitionItem->QuantityReserved | number | decimal |\r\n| requisitionId | RequisitionItem->Requisition_Id | integer | int64 |\r\n| requisitionCode | RequisitionItem->Requisition_Code | string | |\r\n| requisitionRequestedOn | RequisitionItem->Requisition_RequestedOn | string | date-time |\r\n| requisitionStatusId | RequisitionItem->Requisition_Status_Id | integer | int64 |\r\n| requisitionStatusBaseStatus | RequisitionItem->Requisition_Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled, AwaitingApprovalWorkflow]) | enum |\r\n| sequenceNumber | RequisitionItem->SequenceNumber | integer | int32 |\r\n| totalCostInSiteCurrency | RequisitionItem->TotalCostInSiteCurrency | number | decimal |\r\n| totalCostInSpareCurrency | RequisitionItem->TotalCostInSpareCurrency | number | decimal |\r\n| workOrderTaskSpareId | RequisitionItem->WorkOrderTaskSpare_Id | integer | int64 |\r\n| workOrderTaskSpareCode | RequisitionItem->WorkOrderTaskSpare_Code | string | |\r\n| workOrderTaskSpareDescription | RequisitionItem->WorkOrderTaskSpare_Description | string | |\r\n| workOrderTaskSpareSpareType | RequisitionItem->WorkOrderTaskSpare_SpareType | string (Allowed values: [StockItem, CodedNonStockItem, DirectPurchase, Contractor]) | enum |\r\n| workOrderTaskSpareUnitPriceInSpareCurrency | RequisitionItem->WorkOrderTaskSpare_UnitPriceInSpareCurrency | number | decimal |\r\n| workOrderTaskSpareUnitPriceInWorkOrderCurrency | RequisitionItem->WorkOrderTaskSpare_UnitPriceInWorkOrderCurrency | number | decimal |\r\n| workOrderTaskSpareCostCentreId | RequisitionItem->WorkOrderTaskSpare_CostCentre_Id | integer | int64 |\r\n| workOrderTaskSpareCostCentreCode | RequisitionItem->WorkOrderTaskSpare_CostCentre_Code | string | |\r\n| workOrderTaskSpareCostCentreDescription | RequisitionItem->WorkOrderTaskSpare_CostCentre_Description | string | |\r\n| workOrderTaskSpareCostElementId | RequisitionItem->WorkOrderTaskSpare_CostElement_Id | integer | int64 |\r\n| workOrderTaskSpareCostElementCode | RequisitionItem->WorkOrderTaskSpare_CostElement_Code | string | |\r\n| workOrderTaskSpareCostElementDescription | RequisitionItem->WorkOrderTaskSpare_CostElement_Description | string | |\r\n| workOrderTaskSpareGeneralLedgerId | RequisitionItem->WorkOrderTaskSpare_GeneralLedger_Id | integer | int64 |\r\n| workOrderTaskSpareGeneralLedgerCode | RequisitionItem->WorkOrderTaskSpare_GeneralLedger_Code | string | |\r\n| workOrderTaskSpareGeneralLedgerDescription | RequisitionItem->WorkOrderTaskSpare_GeneralLedger_Description | string | |\r\n| workOrderTaskSpareSpareCurrencyId | RequisitionItem->WorkOrderTaskSpare_SpareCurrency_Id | integer | int64 |\r\n| workOrderTaskSpareSpareCurrencyCode | RequisitionItem->WorkOrderTaskSpare_SpareCurrency_Code | string | |\r\n| workOrderTaskSpareSpareCurrencyDescription | RequisitionItem->WorkOrderTaskSpare_SpareCurrency_Description | string | |\r\n| workOrderTaskSpareStockItemId | RequisitionItem->WorkOrderTaskSpare_StockItem_Id | integer | int64 |\r\n| workOrderTaskSpareStockItemMaterialMasterId | RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Id | integer | int64 |\r\n| workOrderTaskSpareStockItemMaterialMasterCode | RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Code | string | |\r\n| workOrderTaskSpareStockItemMaterialMasterDescription | RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Description | string | |\r\n| workOrderTaskSpareStockItemWarehouseId | RequisitionItem->WorkOrderTaskSpare_StockItem_Warehouse_Id | integer | int64 |\r\n| workOrderTaskSpareStockItemWarehouseCode | RequisitionItem->WorkOrderTaskSpare_StockItem_Warehouse_Code | string | |\r\n| workOrderTaskSpareSupplierId | RequisitionItem->WorkOrderTaskSpare_Supplier_Id | integer | int64 |\r\n| workOrderTaskSpareSupplierCode | RequisitionItem->WorkOrderTaskSpare_Supplier_Code | string | |\r\n| workOrderTaskSpareSupplierDescription | RequisitionItem->WorkOrderTaskSpare_Supplier_Description | string | |\r\n| workOrderTaskSpareUnitOfMeasurementId | RequisitionItem->WorkOrderTaskSpare_UnitOfMeasurement_Id | integer | int64 |\r\n| workOrderTaskSpareUnitOfMeasurementCode | RequisitionItem->WorkOrderTaskSpare_UnitOfMeasurement_Code | string | |\r\n| workOrderTaskSpareUnitOfMeasurementDescription | RequisitionItem->WorkOrderTaskSpare_UnitOfMeasurement_Description | string | |\r\n| workOrderTaskSpareWorkOrderCurrencyId | RequisitionItem->WorkOrderTaskSpare_WorkOrderCurrency_Id | integer | int64 |\r\n| workOrderTaskSpareWorkOrderCurrencyCode | RequisitionItem->WorkOrderTaskSpare_WorkOrderCurrency_Code | string | |\r\n| workOrderTaskSpareWorkOrderCurrencyDescription | RequisitionItem->WorkOrderTaskSpare_WorkOrderCurrency_Description | string | |\r\n| workOrderTaskSpareWorkOrderTaskId | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskSpareWorkOrderTaskTaskCode | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskSpareWorkOrderTaskTaskDescription | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskSpareInfoId | RequisitionItem->WorkOrderTaskSpareInfoId | integer | int64 |\r\n| code | RequisitionItem->Code | string | |\r\n| costCentreId | RequisitionItem->CostCentre_Id | integer | int64 |\r\n| costCentreDescription | RequisitionItem->CostCentre_Description | string | |\r\n| costCentreCode | RequisitionItem->CostCentre_Code | string | |\r\n| costElementId | RequisitionItem->CostElement_Id | integer | int64 |\r\n| costElementDescription | RequisitionItem->CostElement_Description | string | |\r\n| costElementCode | RequisitionItem->CostElement_Code | string | |\r\n| description | RequisitionItem->Description | string | |\r\n| financialYearPeriodId | RequisitionItem->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodDescription | RequisitionItem->FinancialYearPeriod_Description | string | |\r\n| financialYearPeriodCode | RequisitionItem->FinancialYearPeriod_Code | string | |\r\n| generalLedgerId | RequisitionItem->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerDescription | RequisitionItem->GeneralLedger_Description | string | |\r\n| generalLedgerCode | RequisitionItem->GeneralLedger_Code | string | |\r\n| requiredOn | RequisitionItem->RequiredOn | string | date-time |\r\n| spareToWorkOrderCurrencyRateValue | RequisitionItem->SpareToWorkOrderCurrencyRateValue | number | decimal |\r\n| spareType | RequisitionItem->SpareType | string (Allowed values: [StockItem, CodedNonStockItem, DirectPurchase, Contractor]) | enum |\r\n| stockItemId | RequisitionItem->StockItem_Id | integer | int64 |\r\n| stockItemAlternativeDescription | RequisitionItem->StockItem_AlternativeDescription | string | |\r\n| stockItemMaterialMasterId | RequisitionItem->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | RequisitionItem->StockItem_MaterialMaster_Code | string | |\r\n| stockItemWarehouseId | RequisitionItem->StockItem_Warehouse_Id | integer | int64 |\r\n| stockItemWarehouseCode | RequisitionItem->StockItem_Warehouse_Code | string | |\r\n| supplierId | RequisitionItem->Supplier_Id | integer | int64 |\r\n| supplierDescription | RequisitionItem->Supplier_Description | string | |\r\n| supplierCode | RequisitionItem->Supplier_Code | string | |\r\n| unitOfMeasurementId | RequisitionItem->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementDescription | RequisitionItem->UnitOfMeasurement_Description | string | |\r\n| unitOfMeasurementCode | RequisitionItem->UnitOfMeasurement_Code | string | |\r\n| unitPriceInSpareCurrency | RequisitionItem->UnitPriceInSpareCurrency | number | decimal |\r\n| workOrderTaskId | RequisitionItem->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | RequisitionItem->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | RequisitionItem->WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskTaskType | RequisitionItem->WorkOrderTask_TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| workOrderTaskWorkOrderId | RequisitionItem->WorkOrderTask_WorkOrder_Id | integer | int64 |\r\n| workOrderTaskWorkOrderCode | RequisitionItem->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskWorkOrderDescription | RequisitionItem->WorkOrderTask_WorkOrder_Description | string | |\r\n", "operationId": "BatchGetRequisitionItem", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Requisition Item id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Requisition Item collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetRequisitionItemResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Batch": { "post": { "tags": [ "Requisition Item" ], "summary": "Create a new collection of Requisition Item resources.", "description": "### Request Body\r\n#### 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 | RequisitionItem->Code | string | |\r\n| costCentreId | RequisitionItem->CostCentre_Id | integer | int64 |\r\n| costElementId | RequisitionItem->CostElement_Id | integer | int64 |\r\n| description | RequisitionItem->Description | string | |\r\n| generalLedgerId | RequisitionItem->GeneralLedger_Id | integer | int64 |\r\n| notes | RequisitionItem->Notes | string | |\r\n| permissionTreeId | RequisitionItem->PermissionTree_Id | integer | int64 |\r\n| quantityRequired | RequisitionItem->QuantityRequired | number | decimal |\r\n| requiredOn | RequisitionItem->RequiredOn | string | date-time |\r\n| requisitionId | RequisitionItem->Requisition_Id | integer | int64 |\r\n| sequenceNumber | RequisitionItem->SequenceNumber | integer | int32 |\r\n| spareToWorkOrderCurrencyRateValue | RequisitionItem->SpareToWorkOrderCurrencyRateValue | number | decimal |\r\n| spareType | RequisitionItem->SpareType | string (Allowed values: [StockItem, CodedNonStockItem, DirectPurchase, Contractor]) | enum |\r\n| financialYearPeriodId | RequisitionItem->FinancialYearPeriod_Id | integer | int64 |\r\n| stockItemId | RequisitionItem->StockItem_Id | integer | int64 |\r\n| supplierId | RequisitionItem->Supplier_Id | integer | int64 |\r\n| unitOfMeasurementId | RequisitionItem->UnitOfMeasurement_Id | integer | int64 |\r\n| unitPriceInSpareCurrency | RequisitionItem->UnitPriceInSpareCurrency | number | decimal |\r\n| workOrderTaskId | RequisitionItem->WorkOrderTask_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| costCentreId | System Generated | true | If no value specified |\r\n| costElementId | System Generated | true | If no value specified |\r\n| generalLedgerId | System Generated | true | If no value specified |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| quantityRequired | Required | True | |\r\n| quantityRequired | Nullable | False | |\r\n| quantityRequired | Min Value | >= 0| |\r\n| requiredOn | Required | True | |\r\n| requiredOn | Nullable | False | |\r\n| requisitionId | Required | True | |\r\n| requisitionId | Nullable | False | |\r\n| spareToWorkOrderCurrencyRateValue | System Generated | true | If no value specified |\r\n| spareType | Required | True | |\r\n| spareType | Nullable | False | |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n\r\n", "operationId": "BatchCreateRequisitionItem", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateRequisitionItemResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Requisition Item batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Requisition Item" ], "summary": "Update a collection of existing Requisition Item resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RequisitionItem->Id | integer | int64 |\r\n| version | RequisitionItem->Version | integer | int32 |\r\n| code | RequisitionItem->Code | string | |\r\n| costCentreId | RequisitionItem->CostCentre_Id | integer | int64 |\r\n| costElementId | RequisitionItem->CostElement_Id | integer | int64 |\r\n| description | RequisitionItem->Description | string | |\r\n| financialYearPeriodId | RequisitionItem->FinancialYearPeriod_Id | integer | int64 |\r\n| generalLedgerId | RequisitionItem->GeneralLedger_Id | integer | int64 |\r\n| notes | RequisitionItem->Notes | string | |\r\n| quantityRequired | RequisitionItem->QuantityRequired | number | decimal |\r\n| sequenceNumber | RequisitionItem->SequenceNumber | integer | int32 |\r\n| quantityOrdered | RequisitionItem->QuantityOrdered | number | decimal |\r\n| quantityReserved | RequisitionItem->QuantityReserved | number | decimal |\r\n| requiredOn | RequisitionItem->RequiredOn | string | date-time |\r\n| sequenceNumber | RequisitionItem->SequenceNumber | integer | int32 |\r\n| spareToWorkOrderCurrencyRateValue | RequisitionItem->SpareToWorkOrderCurrencyRateValue | number | decimal |\r\n| supplierId | RequisitionItem->Supplier_Id | integer | int64 |\r\n| unitOfMeasurementId | RequisitionItem->UnitOfMeasurement_Id | integer | int64 |\r\n| unitPriceInSpareCurrency | RequisitionItem->UnitPriceInSpareCurrency | 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| quantityRequired | Nullable | False | |\r\n| quantityRequired | Min Value | >= 0| |\r\n| quantityOrdered | Min Value | >= 0| |\r\n\r\n", "operationId": "BatchUpdateRequisitionItem", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateRequisitionItemResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Requisition Item batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Requisition Item" ], "summary": "Delete a collection of existing Requisition Item resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RequisitionItem->Id | integer | int64 |\r\n| version | RequisitionItem->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": "BatchDeleteRequisitionItem", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteRequisitionItemResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Requisition Item batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Batch/IssueAll": { "post": { "tags": [ "Requisition Item" ], "summary": "Issue all Items for collection of Requisition Item resource", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| entityIds | IssueReturnAll->EntityIds | array | array |\r\n| permissionId | IssueReturnAll->Permission_Id | integer | int64 |\r\n| financialYearPeriodId | IssueReturnAll->FinancialYearPeriod_Id | integer | int64 |\r\n| transactedOn | IssueReturnAll->TransactedOn | string | date-time |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| entityIds | Required | True | |\r\n| entityIds | Nullable | False | |\r\n| permissionId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| transactedOn | System Generated | true | If no value specified |\r\n\r\n", "operationId": "BatchIssueAllRequisitionItem", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/BatchIssueAllRequisitionItemResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Batch/ReturnAll": { "post": { "tags": [ "Requisition Item" ], "summary": "Return all Items for collection of Requisition Item resource", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| entityIds | IssueReturnAll->EntityIds | array | array |\r\n| permissionId | IssueReturnAll->Permission_Id | integer | int64 |\r\n| financialYearPeriodId | IssueReturnAll->FinancialYearPeriod_Id | integer | int64 |\r\n| transactedOn | IssueReturnAll->TransactedOn | string | date-time |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| entityIds | Required | True | |\r\n| entityIds | Nullable | False | |\r\n| permissionId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| transactedOn | System Generated | true | If no value specified |\r\n\r\n", "operationId": "BatchReturnAllRequisitionItem", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/BatchReturnAllRequisitionItemResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/{id}/PermissionTree": { "patch": { "tags": [ "Requisition Item" ], "summary": "Change the PermissionTree for an existing Requisition Item resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RequisitionItem->Version | integer | int32 |\r\n| permissionTreeId | RequisitionItem->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": "ChangeRequisitionItemPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Item Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeRequisitionItemPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/{id}/IssueAll": { "post": { "tags": [ "Requisition Item" ], "summary": "Issue all Items for Requisition Item resource", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionId | IssueReturnAll->Permission_Id | integer | int64 |\r\n| financialYearPeriodId | IssueReturnAll->FinancialYearPeriod_Id | integer | int64 |\r\n| transactedOn | IssueReturnAll->TransactedOn | string | date-time |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| transactedOn | System Generated | true | If no value specified |\r\n\r\n", "operationId": "IssueAllRequisitionItem", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Item Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/IssueAllRequisitionItemResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/{id}/Issue": { "post": { "tags": [ "Requisition Item" ], "summary": "Issue a specific quantity for Requisition Item resource", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| financialYearPeriodId | RequisitionItemTransaction->FinancialYearPeriod_Id | integer | int64 |\r\n| itemCostInSiteCurrency | RequisitionItemTransaction->ItemCostInSiteCurrency | number | decimal |\r\n| permissionTreeId | RequisitionItemTransaction->PermissionTree_Id | integer | int64 |\r\n| quantity | RequisitionItemTransaction->Quantity | number | decimal |\r\n| transactedOn | RequisitionItemTransaction->TransactedOn | string | date-time |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | Nullable | False | |\r\n| itemCostInSiteCurrency | System Generated | true | If no value specified |\r\n| itemCostInSiteCurrency | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| RequisitionItemTransaction->TransactionType eq 'Issue' |\r\n| transactedOn | System Generated | true | If no value specified |\r\n| transactedOn | Nullable | False | |\r\n\r\n", "operationId": "IssueSpecificQuantity", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Item Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/IssueSpecificQuantityResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/{id}/ReturnAll": { "post": { "tags": [ "Requisition Item" ], "summary": "Return all Items for Requisition Item resource", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionId | IssueReturnAll->Permission_Id | integer | int64 |\r\n| financialYearPeriodId | IssueReturnAll->FinancialYearPeriod_Id | integer | int64 |\r\n| transactedOn | IssueReturnAll->TransactedOn | string | date-time |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| transactedOn | System Generated | true | If no value specified |\r\n\r\n", "operationId": "ReturnAllRequisitionItem", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Item Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/ReturnAllRequisitionItemResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/{id}/Return": { "post": { "tags": [ "Requisition Item" ], "summary": "Return a specific quantity for Requisition Item resource", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| financialYearPeriodId | RequisitionItemTransaction->FinancialYearPeriod_Id | integer | int64 |\r\n| itemCostInSiteCurrency | RequisitionItemTransaction->ItemCostInSiteCurrency | number | decimal |\r\n| permissionTreeId | RequisitionItemTransaction->PermissionTree_Id | integer | int64 |\r\n| quantity | RequisitionItemTransaction->Quantity | number | decimal |\r\n| transactedOn | RequisitionItemTransaction->TransactedOn | string | date-time |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | Nullable | False | |\r\n| itemCostInSiteCurrency | System Generated | true | If no value specified |\r\n| itemCostInSiteCurrency | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| RequisitionItemTransaction->TransactionType eq 'Issue' |\r\n| transactedOn | System Generated | true | If no value specified |\r\n| transactedOn | Nullable | False | |\r\n\r\n", "operationId": "ReturnSpecificQuantity", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Item Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/ReturnSpecificQuantityResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Batch/PermissionTree": { "patch": { "tags": [ "Requisition Item" ], "summary": "Change the PermissionTree status for a collection of existing Requisition Item resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RequisitionItem->Id | integer | int64 |\r\n| version | RequisitionItem->Version | integer | int32 |\r\n| permissionTreeId | RequisitionItem->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": "BatchChangeRequisitionItemPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeRequisitionItemPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Issue/Batch": { "post": { "tags": [ "Requisition Item" ], "summary": "Requisition Item", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| financialYearPeriodId | RequisitionItemTransaction->FinancialYearPeriod_Id | integer | int64 |\r\n| itemCostInSiteCurrency | RequisitionItemTransaction->ItemCostInSiteCurrency | number | decimal |\r\n| permissionTreeId | RequisitionItemTransaction->PermissionTree_Id | integer | int64 |\r\n| quantity | RequisitionItemTransaction->Quantity | number | decimal |\r\n| requisitionItemId | RequisitionItemTransaction->RequisitionItem_Id | integer | int64 |\r\n| transactedOn | RequisitionItemTransaction->TransactedOn | string | date-time |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | Nullable | False | |\r\n| itemCostInSiteCurrency | System Generated | true | If no value specified |\r\n| itemCostInSiteCurrency | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| RequisitionItemTransaction->TransactionType eq 'Issue' |\r\n| requisitionItemId | Required | True | |\r\n| requisitionItemId | Nullable | False | |\r\n| transactedOn | System Generated | true | If no value specified |\r\n| transactedOn | Nullable | False | |\r\n\r\n", "operationId": "BatchIssueSpecificQuantity", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchIssueSpecificQuantityRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Return/Batch": { "post": { "tags": [ "Requisition Item" ], "summary": "Requisition Item", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| financialYearPeriodId | RequisitionItemTransaction->FinancialYearPeriod_Id | integer | int64 |\r\n| itemCostInSiteCurrency | RequisitionItemTransaction->ItemCostInSiteCurrency | number | decimal |\r\n| permissionTreeId | RequisitionItemTransaction->PermissionTree_Id | integer | int64 |\r\n| quantity | RequisitionItemTransaction->Quantity | number | decimal |\r\n| requisitionItemId | RequisitionItemTransaction->RequisitionItem_Id | integer | int64 |\r\n| transactedOn | RequisitionItemTransaction->TransactedOn | string | date-time |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | Nullable | False | |\r\n| itemCostInSiteCurrency | System Generated | true | If no value specified |\r\n| itemCostInSiteCurrency | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| RequisitionItemTransaction->TransactionType eq 'Issue' |\r\n| requisitionItemId | Required | True | |\r\n| requisitionItemId | Nullable | False | |\r\n| transactedOn | System Generated | true | If no value specified |\r\n| transactedOn | Nullable | False | |\r\n\r\n", "operationId": "BatchReturnSpecificQuantity", "parameters": [ { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchReturnSpecificQuantityRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/FileAttachments/{id}/Download": { "get": { "tags": [ "Requisition Item File Attachment" ], "summary": "Download the content for a Requisition Item File Attachment resource.", "description": "", "operationId": "GetRequisitionItemFileAttachmentContent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "name": "cv", "in": "query", "description": "Return older version of attachment content", "schema": { "type": "integer", "format": "int32", "nullable": true } } ], "responses": { "200": { "description": "Success response - body contains file content", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/FileAttachments/{id}": { "get": { "tags": [ "Requisition Item File Attachment" ], "summary": "Get a Requisition Item 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| requisitionItemId | RequisitionItemFileAttachment->RequisitionItem_Id | integer | int64 |\r\n| requisitionItemRequisitionId | RequisitionItemFileAttachment->RequisitionItem_Requisition_Id | integer | int64 |\r\n| requisitionItemRequisitionCode | RequisitionItemFileAttachment->RequisitionItem_Requisition_Code | string | |\r\n| requisitionItemRequisitionWorkOrderId | RequisitionItemFileAttachment->RequisitionItem_Requisition_WorkOrder_Id | integer | int64 |\r\n| requisitionItemRequisitionWorkOrderCode | RequisitionItemFileAttachment->RequisitionItem_Requisition_WorkOrder_Code | string | |\r\n| requisitionItemRequisitionWorkOrderDescription | RequisitionItemFileAttachment->RequisitionItem_Requisition_WorkOrder_Description | string | |\r\n| createdByUserId | RequisitionItemFileAttachment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RequisitionItemFileAttachment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RequisitionItemFileAttachment->CreatedByUser_FullName | string | |\r\n| createdOn | RequisitionItemFileAttachment->CreatedOn | string | date-time |\r\n| contentId | RequisitionItemFileAttachment->Content_Id | integer | int64 |\r\n| contentFileLocationId | RequisitionItemFileAttachment->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | RequisitionItemFileAttachment->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | RequisitionItemFileAttachment->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | RequisitionItemFileAttachment->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | RequisitionItemFileAttachment->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | RequisitionItemFileAttachment->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | RequisitionItemFileAttachment->Content_SizeInMb | number | decimal |\r\n| contentVersion | RequisitionItemFileAttachment->ContentVersion | integer | int32 |\r\n| entityType | RequisitionItemFileAttachment->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 | RequisitionItemFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | RequisitionItemFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | RequisitionItemFileAttachment->FileCategory_Description | string | |\r\n| fileCategoryAutoIsRestricted | RequisitionItemFileAttachment->FileCategory_AutoIsRestricted | boolean | |\r\n| fileFullName | RequisitionItemFileAttachment->FileFullName | string | |\r\n| fileName | RequisitionItemFileAttachment->FileName | string | |\r\n| fileTypeId | RequisitionItemFileAttachment->FileType_Id | integer | int64 |\r\n| fileTypeExtension | RequisitionItemFileAttachment->FileType_Extension | string | |\r\n| isRestricted | RequisitionItemFileAttachment->IsRestricted | boolean | |\r\n| id | RequisitionItemFileAttachment->Id | integer | int64 |\r\n| isActive | RequisitionItemFileAttachment->IsActive | boolean | |\r\n| modifiedByUserId | RequisitionItemFileAttachment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RequisitionItemFileAttachment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RequisitionItemFileAttachment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RequisitionItemFileAttachment->ModifiedOn | string | date-time |\r\n| permissionTreeId | RequisitionItemFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionItemFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionItemFileAttachment->PermissionTree_Description | string | |\r\n| version | RequisitionItemFileAttachment->Version | integer | int32 |\r\n", "operationId": "GetRequisitionItemFileAttachment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Requisition Item File Attachment", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionItemFileAttachmentResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Requisition Item File Attachment" ], "summary": "Update an existing Requisition Item 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 | RequisitionItemFileAttachment->Version | integer | int32 |\r\n| fileCategoryId | RequisitionItemFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileName | RequisitionItemFileAttachment->FileName | string | |\r\n| isRestricted | RequisitionItemFileAttachment->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": "UpdateRequisitionItemFileAttachment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateRequisitionItemFileAttachmentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Requisition Item File Attachment was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Requisition Item File Attachment" ], "summary": "Delete an existing Requisition Item 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 | RequisitionItemFileAttachment->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": "DeleteRequisitionItemFileAttachment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteRequisitionItemFileAttachmentResourceResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Requisition Item File Attachment was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/{id}/FileAttachments": { "get": { "tags": [ "Requisition Item File Attachment" ], "summary": "Get a collection of Requisition Item File Attachment resources for the Requisition Item.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RequisitionItemFileAttachment->Id | integer | int64 |\r\n| version | RequisitionItemFileAttachment->Version | integer | int32 |\r\n| fileFullName | RequisitionItemFileAttachment->FileFullName | string | |\r\n| contentSizeInMb | RequisitionItemFileAttachment->Content_SizeInMb | number | decimal |\r\n| isRestricted | RequisitionItemFileAttachment->IsRestricted | boolean | |\r\n| fileCategoryId | RequisitionItemFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | RequisitionItemFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | RequisitionItemFileAttachment->FileCategory_Description | string | |\r\n| permissionTreeId | RequisitionItemFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionItemFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionItemFileAttachment->PermissionTree_Description | string | |\r\n| createdOn | RequisitionItemFileAttachment->CreatedOn | string | date-time |\r\n| modifiedOn | RequisitionItemFileAttachment->ModifiedOn | string | date-time |\r\n", "operationId": "GetRequisitionItemFileAttachmentCollectionForRequisitionItem", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition Item File Attachment collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionItemFileAttachmentCollectionForRequisitionItemResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/FileAttachments": { "get": { "tags": [ "Requisition Item File Attachment" ], "summary": "Get a collection of Requisition Item 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 | RequisitionItemFileAttachment->Id | integer | int64 |\r\n| version | RequisitionItemFileAttachment->Version | integer | int32 |\r\n| requisitionItemId | RequisitionItemFileAttachment->RequisitionItem_Id | integer | int64 |\r\n| requisitionItemRequisitionCode | RequisitionItemFileAttachment->RequisitionItem_Requisition_Code | string | |\r\n| requisitionItemWorkOrderTaskSpareWorkOrderTaskWorkOrderCode | RequisitionItemFileAttachment->RequisitionItem_WorkOrderTaskSpare_WorkOrderTask_WorkOrder_Code | string | |\r\n| requisitionItemWorkOrderTaskSpareWorkOrderTaskTaskCode | RequisitionItemFileAttachment->RequisitionItem_WorkOrderTaskSpare_WorkOrderTask_TaskCode | string | |\r\n| fileFullName | RequisitionItemFileAttachment->FileFullName | string | |\r\n| contentSizeInMb | RequisitionItemFileAttachment->Content_SizeInMb | number | decimal |\r\n| fileTypeExtension | RequisitionItemFileAttachment->FileType_Extension | string | |\r\n| isRestricted | RequisitionItemFileAttachment->IsRestricted | boolean | |\r\n| fileCategoryId | RequisitionItemFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | RequisitionItemFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | RequisitionItemFileAttachment->FileCategory_Description | string | |\r\n| permissionTreeId | RequisitionItemFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionItemFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionItemFileAttachment->PermissionTree_Description | string | |\r\n| createdOn | RequisitionItemFileAttachment->CreatedOn | string | date-time |\r\n| modifiedOn | RequisitionItemFileAttachment->ModifiedOn | string | date-time |\r\n", "operationId": "GetRequisitionItemFileAttachmentCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition Item File Attachment collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionItemFileAttachmentCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/FileAttachments/Upload": { "post": { "tags": [ "Requisition Item File Attachment" ], "summary": "Upload and create a new Requisition Item 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| requisitionItemId | RequisitionItemFileAttachment->RequisitionItem_Id | integer | int64 |\r\n| isRestricted | RequisitionItemFileAttachment->IsRestricted | boolean | |\r\n| fileName | RequisitionItemFileAttachment->FileName | string | |\r\n| fileCategoryId | RequisitionItemFileAttachment->FileCategory_Id | integer | int64 |\r\n| permissionTreeId | RequisitionItemFileAttachment->PermissionTree_Id | integer | int64 |\r\n| bytes | RequisitionItemFileAttachment->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| requisitionItemId | Required | True | |\r\n| requisitionItemId | 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": "CreateRequisitionItemFileAttachment", "requestBody": { "x-name": "entityPost", "description": "Request Body content", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreateRequisitionItemFileAttachmentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/FileAttachments/{id}/Upload": { "put": { "tags": [ "Requisition Item File Attachment" ], "summary": "Upload new content for an existing Requisition Item 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 | RequisitionItemFileAttachment->Version | integer | int32 |\r\n| bytes | RequisitionItemFileAttachment->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": "UpdateRequisitionItemFileAttachmentContent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 } ], "requestBody": { "x-name": "entityFilePatch", "description": "Request Body content", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UpdateRequisitionItemFileAttachmentContentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Requisition Item File Attachment was successfully updated" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/FileAttachments/Batch/{ids}": { "get": { "tags": [ "Requisition Item File Attachment" ], "summary": "Get a collection of Requisition Item 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| requisitionItemId | RequisitionItemFileAttachment->RequisitionItem_Id | integer | int64 |\r\n| requisitionItemRequisitionId | RequisitionItemFileAttachment->RequisitionItem_Requisition_Id | integer | int64 |\r\n| requisitionItemRequisitionCode | RequisitionItemFileAttachment->RequisitionItem_Requisition_Code | string | |\r\n| requisitionItemRequisitionWorkOrderId | RequisitionItemFileAttachment->RequisitionItem_Requisition_WorkOrder_Id | integer | int64 |\r\n| requisitionItemRequisitionWorkOrderCode | RequisitionItemFileAttachment->RequisitionItem_Requisition_WorkOrder_Code | string | |\r\n| requisitionItemRequisitionWorkOrderDescription | RequisitionItemFileAttachment->RequisitionItem_Requisition_WorkOrder_Description | string | |\r\n| createdByUserId | RequisitionItemFileAttachment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RequisitionItemFileAttachment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RequisitionItemFileAttachment->CreatedByUser_FullName | string | |\r\n| createdOn | RequisitionItemFileAttachment->CreatedOn | string | date-time |\r\n| contentId | RequisitionItemFileAttachment->Content_Id | integer | int64 |\r\n| contentFileLocationId | RequisitionItemFileAttachment->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | RequisitionItemFileAttachment->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | RequisitionItemFileAttachment->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | RequisitionItemFileAttachment->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | RequisitionItemFileAttachment->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | RequisitionItemFileAttachment->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | RequisitionItemFileAttachment->Content_SizeInMb | number | decimal |\r\n| contentVersion | RequisitionItemFileAttachment->ContentVersion | integer | int32 |\r\n| entityType | RequisitionItemFileAttachment->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 | RequisitionItemFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | RequisitionItemFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | RequisitionItemFileAttachment->FileCategory_Description | string | |\r\n| fileCategoryAutoIsRestricted | RequisitionItemFileAttachment->FileCategory_AutoIsRestricted | boolean | |\r\n| fileFullName | RequisitionItemFileAttachment->FileFullName | string | |\r\n| fileName | RequisitionItemFileAttachment->FileName | string | |\r\n| fileTypeId | RequisitionItemFileAttachment->FileType_Id | integer | int64 |\r\n| fileTypeExtension | RequisitionItemFileAttachment->FileType_Extension | string | |\r\n| isRestricted | RequisitionItemFileAttachment->IsRestricted | boolean | |\r\n| id | RequisitionItemFileAttachment->Id | integer | int64 |\r\n| isActive | RequisitionItemFileAttachment->IsActive | boolean | |\r\n| modifiedByUserId | RequisitionItemFileAttachment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RequisitionItemFileAttachment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RequisitionItemFileAttachment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RequisitionItemFileAttachment->ModifiedOn | string | date-time |\r\n| permissionTreeId | RequisitionItemFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionItemFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionItemFileAttachment->PermissionTree_Description | string | |\r\n| version | RequisitionItemFileAttachment->Version | integer | int32 |\r\n", "operationId": "BatchGetRequisitionItemFileAttachment", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Requisition Item File Attachment id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Requisition Item File Attachment collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetRequisitionItemFileAttachmentResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/FileAttachments/{id}/ContentHistory": { "get": { "tags": [ "Requisition Item File Attachment" ], "summary": "Get a collection of File Attachment Content History resources for the Requisition Item 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": "GetRequisitionItemFileAttachmentContentHistory", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Requisition Item File Attachment collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionItemFileAttachmentContentHistoryResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/FileAttachments/Upload/Batch": { "post": { "tags": [ "Requisition Item File Attachment" ], "summary": "Upload and create a new collection of Requisition Item 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| requisitionItemId | RequisitionItemFileAttachment->RequisitionItem_Id | integer | int64 |\r\n| isRestricted | RequisitionItemFileAttachment->IsRestricted | boolean | |\r\n| fileName | RequisitionItemFileAttachment->FileName | string | |\r\n| fileCategoryId | RequisitionItemFileAttachment->FileCategory_Id | integer | int64 |\r\n| permissionTreeId | RequisitionItemFileAttachment->PermissionTree_Id | integer | int64 |\r\n| bytes | RequisitionItemFileAttachment->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| requisitionItemId | Required | True | |\r\n| requisitionItemId | 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": "BatchCreateRequisitionItemFileAttachment", "parameters": [ { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "entityPostCollection", "description": "Request Body content", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/BatchCreateRequisitionItemFileAttachmentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Requisition Item File Attachment batch was successfully created" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/FileAttachments/Batch": { "patch": { "tags": [ "Requisition Item File Attachment" ], "summary": "Update a collection of existing Requisition Item 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 | RequisitionItemFileAttachment->Id | integer | int64 |\r\n| version | RequisitionItemFileAttachment->Version | integer | int32 |\r\n| isRestricted | RequisitionItemFileAttachment->IsRestricted | boolean | |\r\n| fileName | RequisitionItemFileAttachment->FileName | string | |\r\n| fileCategoryId | RequisitionItemFileAttachment->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": "BatchUpdateRequisitionItemFileAttachment", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateRequisitionItemFileAttachmentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Requisition Item File Attachment batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Requisition Item File Attachment" ], "summary": "Delete a collection of existing Requisition Item 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 | RequisitionItemFileAttachment->Id | integer | int64 |\r\n| version | RequisitionItemFileAttachment->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": "BatchDeleteRequisitionItemFileAttachment", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteRequisitionItemFileAttachmentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Requisition Item File Attachment batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Transactions/{id}": { "get": { "tags": [ "Requisition Item Transaction" ], "summary": "Get a Requisition Item Transaction 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 | RequisitionItemTransaction->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RequisitionItemTransaction->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RequisitionItemTransaction->CreatedByUser_FullName | string | |\r\n| createdOn | RequisitionItemTransaction->CreatedOn | string | date-time |\r\n| permissionTreeId | RequisitionItemTransaction->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionItemTransaction->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionItemTransaction->PermissionTree_Description | string | |\r\n| id | RequisitionItemTransaction->Id | integer | int64 |\r\n| version | RequisitionItemTransaction->Version | integer | int32 |\r\n| financialYearPeriodId | RequisitionItemTransaction->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodCode | RequisitionItemTransaction->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | RequisitionItemTransaction->FinancialYearPeriod_Description | string | |\r\n| financialYearPeriodFinancialYearId | RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearCode | RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Code | string | |\r\n| financialYearPeriodFinancialYearDescription | RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Description | string | |\r\n| itemCostInSiteCurrency | RequisitionItemTransaction->ItemCostInSiteCurrency | number | decimal |\r\n| quantity | RequisitionItemTransaction->Quantity | number | decimal |\r\n| requisitionItemId | RequisitionItemTransaction->RequisitionItem_Id | integer | int64 |\r\n| requisitionItemRequisitionId | RequisitionItemTransaction->RequisitionItem_Requisition_Id | integer | int64 |\r\n| requisitionItemRequisitionCode | RequisitionItemTransaction->RequisitionItem_Requisition_Code | string | |\r\n| requisitionItemRequisitionWorkOrderId | RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Id | integer | int64 |\r\n| requisitionItemRequisitionWorkOrderCode | RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Code | string | |\r\n| requisitionItemRequisitionWorkOrderDescription | RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Description | string | |\r\n| requisitionItemWorkOrderTaskSpareId | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_Id | integer | int64 |\r\n| requisitionItemWorkOrderTaskSpareSpareType | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_SpareType | string (Allowed values: [StockItem, CodedNonStockItem, DirectPurchase, Contractor]) | enum |\r\n| requisitionItemWorkOrderTaskSpareDescription | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_Description | string | |\r\n| requisitionItemWorkOrderTaskSpareStockItemId | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_StockItem_Id | integer | int64 |\r\n| requisitionItemWorkOrderTaskSpareStockItemMaterialMasterId | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_StockItem_MaterialMaster_Id | integer | int64 |\r\n| requisitionItemWorkOrderTaskSpareStockItemMaterialMasterDescription | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_StockItem_MaterialMaster_Description | string | |\r\n| totalCostInSiteCurrency | RequisitionItemTransaction->TotalCostInSiteCurrency | number | decimal |\r\n| transactedOn | RequisitionItemTransaction->TransactedOn | string | date-time |\r\n| transactionType | RequisitionItemTransaction->TransactionType | string (Allowed values: [Issue, Return]) | enum |\r\n", "operationId": "GetRequisitionItemTransaction", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Item Transaction Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Requisition Item Transaction", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionItemTransactionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Requisition Item Transaction" ], "summary": "Update an existing Requisition Item Transaction resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RequisitionItemTransaction->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": "UpdateRequisitionItemTransaction", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Item Transaction Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateRequisitionItemTransactionResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Requisition Item Transaction was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Transactions/{requisitionItemTransactionId}/Costing": { "get": { "tags": [ "Requisition Item Transaction" ], "summary": "Get a collection of Costing resources for the Requisition Item Transaction.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Costing->Id | integer | int64 |\r\n| description | Costing->Description | string | |\r\n| quantity | Costing->Quantity | number | decimal |\r\n| costElementId | Costing->CostElement_Id | integer | int64 |\r\n| costElementCode | Costing->CostElement_Code | string | |\r\n| costCentreId | Costing->CostCentre_Id | integer | int64 |\r\n| costCentreCode | Costing->CostCentre_Code | string | |\r\n| generalLedgerId | Costing->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | Costing->GeneralLedger_Code | string | |\r\n| totalCostInSiteCurrency | Costing->TotalCostInSiteCurrency | number | decimal |\r\n| siteId | Costing->Site_Id | integer | int64 |\r\n| siteCode | Costing->Site_Code | string | |\r\n", "operationId": "GetCostingForRequisitionItemTransactionCollection", "parameters": [ { "name": "requisitionItemTransactionId", "in": "path", "required": true, "description": "Requisition Item Transaction Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition Item Transaction collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetCostingCollectionForRequisitionItemTransactionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/{requisitionItemId}/Transactions": { "get": { "tags": [ "Requisition Item Transaction" ], "summary": "Get a collection of Requisition Item Transaction resources for the Requisition Item.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RequisitionItemTransaction->Id | integer | int64 |\r\n| permissionTreeId | RequisitionItemTransaction->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionItemTransaction->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionItemTransaction->PermissionTree_Description | string | |\r\n| requisitionItemId | RequisitionItemTransaction->RequisitionItem_Id | integer | int64 |\r\n| requisitionItemRequisitionId | RequisitionItemTransaction->RequisitionItem_Requisition_Id | integer | int64 |\r\n| requisitionItemRequisitionCode | RequisitionItemTransaction->RequisitionItem_Requisition_Code | string | |\r\n| requisitionItemRequisitionWorkOrderId | RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Id | integer | int64 |\r\n| requisitionItemRequisitionWorkOrderCode | RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Code | string | |\r\n| requisitionItemRequisitionWorkOrderDescription | RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Description | string | |\r\n| requisitionItemWorkOrderTaskSpareStockItemMaterialMasterCode | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_StockItem_MaterialMaster_Code | string | |\r\n| transactedOn | RequisitionItemTransaction->TransactedOn | string | date-time |\r\n| quantity | RequisitionItemTransaction->Quantity | number | decimal |\r\n| itemCostInSiteCurrency | RequisitionItemTransaction->ItemCostInSiteCurrency | number | decimal |\r\n| transactionType | RequisitionItemTransaction->TransactionType | string (Allowed values: [Issue, Return]) | enum |\r\n| createdOn | RequisitionItemTransaction->CreatedOn | string | date-time |\r\n| createdByUserCode | RequisitionItemTransaction->CreatedByUser_Code | string | |\r\n| totalCostInSiteCurrency | RequisitionItemTransaction->TotalCostInSiteCurrency | number | decimal |\r\n| financialYearPeriodId | RequisitionItemTransaction->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearId | RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearCode | RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Code | string | |\r\n| financialYearPeriodFinancialYearDescription | RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Description | string | |\r\n| financialYearPeriodCode | RequisitionItemTransaction->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | RequisitionItemTransaction->FinancialYearPeriod_Description | string | |\r\n", "operationId": "GetRequisitionItemTransactionCollectionForRequisitionItemCollection", "parameters": [ { "name": "requisitionItemId", "in": "path", "required": true, "description": "Requisition Item Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition Item Transaction collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionItemTransactionCollectionForRequisitionItemResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/{requisitionItemRequisitionId}/Transaction": { "get": { "tags": [ "Requisition Item Transaction" ], "summary": "Get a collection of Requisition Item Transaction 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 | RequisitionItemTransaction->Id | integer | int64 |\r\n| permissionTreeId | RequisitionItemTransaction->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionItemTransaction->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionItemTransaction->PermissionTree_Description | string | |\r\n| requisitionItemId | RequisitionItemTransaction->RequisitionItem_Id | integer | int64 |\r\n| requisitionItemRequisitionId | RequisitionItemTransaction->RequisitionItem_Requisition_Id | integer | int64 |\r\n| requisitionItemRequisitionCode | RequisitionItemTransaction->RequisitionItem_Requisition_Code | string | |\r\n| requisitionItemRequisitionWorkOrderId | RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Id | integer | int64 |\r\n| requisitionItemRequisitionWorkOrderCode | RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Code | string | |\r\n| requisitionItemRequisitionWorkOrderDescription | RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Description | string | |\r\n| requisitionItemWorkOrderTaskSpareStockItemMaterialMasterId | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_StockItem_MaterialMaster_Id | integer | int64 |\r\n| requisitionItemWorkOrderTaskSpareStockItemMaterialMasterCode | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_StockItem_MaterialMaster_Code | string | |\r\n| requisitionItemWorkOrderTaskSpareStockItemMaterialMasterDescription | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_StockItem_MaterialMaster_Description | string | |\r\n| requisitionItemWorkOrderTaskSpareSpareType | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_SpareType | string (Allowed values: [StockItem, CodedNonStockItem, DirectPurchase, Contractor]) | enum |\r\n| requisitionItemWorkOrderTaskSpareCode | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_Code | string | |\r\n| requisitionItemWorkOrderTaskSpareDescription | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_Description | string | |\r\n| transactedOn | RequisitionItemTransaction->TransactedOn | string | date-time |\r\n| quantity | RequisitionItemTransaction->Quantity | number | decimal |\r\n| itemCostInSiteCurrency | RequisitionItemTransaction->ItemCostInSiteCurrency | number | decimal |\r\n| transactionType | RequisitionItemTransaction->TransactionType | string (Allowed values: [Issue, Return]) | enum |\r\n| createdOn | RequisitionItemTransaction->CreatedOn | string | date-time |\r\n| createdByUserCode | RequisitionItemTransaction->CreatedByUser_Code | string | |\r\n| totalCostInSiteCurrency | RequisitionItemTransaction->TotalCostInSiteCurrency | number | decimal |\r\n| financialYearPeriodId | RequisitionItemTransaction->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearId | RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearCode | RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Code | string | |\r\n| financialYearPeriodFinancialYearDescription | RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Description | string | |\r\n| financialYearPeriodCode | RequisitionItemTransaction->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | RequisitionItemTransaction->FinancialYearPeriod_Description | string | |\r\n", "operationId": "GetRequisitionItemTransactionCollectionForRequisitionCollection", "parameters": [ { "name": "requisitionItemRequisitionId", "in": "path", "required": true, "description": "Requisition Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition Item Transaction collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionItemTransactionCollectionForRequisitionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Transactions": { "get": { "tags": [ "Requisition Item Transaction" ], "summary": "Get a collection of Requisition Item Transaction 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 | RequisitionItemTransaction->Id | integer | int64 |\r\n| permissionTreeId | RequisitionItemTransaction->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionItemTransaction->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionItemTransaction->PermissionTree_Description | string | |\r\n| requisitionItemId | RequisitionItemTransaction->RequisitionItem_Id | integer | int64 |\r\n| requisitionItemRequisitionId | RequisitionItemTransaction->RequisitionItem_Requisition_Id | integer | int64 |\r\n| requisitionItemRequisitionCode | RequisitionItemTransaction->RequisitionItem_Requisition_Code | string | |\r\n| requisitionItemRequisitionWorkOrderId | RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Id | integer | int64 |\r\n| requisitionItemRequisitionWorkOrderCode | RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Code | string | |\r\n| requisitionItemRequisitionWorkOrderDescription | RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Description | string | |\r\n| requisitionItemWorkOrderTaskSpareDescription | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_Description | string | |\r\n| requisitionItemWorkOrderTaskSpareStockItemMaterialMasterId | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_StockItem_MaterialMaster_Id | integer | int64 |\r\n| requisitionItemWorkOrderTaskSpareStockItemMaterialMasterCode | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_StockItem_MaterialMaster_Code | string | |\r\n| requisitionItemWorkOrderTaskSpareStockItemMaterialMasterDescription | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_StockItem_MaterialMaster_Description | string | |\r\n| requisitionItemWorkOrderTaskSpareSpareType | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_SpareType | string (Allowed values: [StockItem, CodedNonStockItem, DirectPurchase, Contractor]) | enum |\r\n| requisitionItemWorkOrderTaskSpareCode | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_Code | string | |\r\n| financialYearPeriodId | RequisitionItemTransaction->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearId | RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearCode | RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Code | string | |\r\n| financialYearPeriodFinancialYearDescription | RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Description | string | |\r\n| financialYearPeriodCode | RequisitionItemTransaction->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | RequisitionItemTransaction->FinancialYearPeriod_Description | string | |\r\n| transactedOn | RequisitionItemTransaction->TransactedOn | string | date-time |\r\n| quantity | RequisitionItemTransaction->Quantity | number | decimal |\r\n| itemCostInSiteCurrency | RequisitionItemTransaction->ItemCostInSiteCurrency | number | decimal |\r\n| totalCostInSiteCurrency | RequisitionItemTransaction->TotalCostInSiteCurrency | number | decimal |\r\n| transactionType | RequisitionItemTransaction->TransactionType | string (Allowed values: [Issue, Return]) | enum |\r\n| createdOn | RequisitionItemTransaction->CreatedOn | string | date-time |\r\n| createdByUserId | RequisitionItemTransaction->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RequisitionItemTransaction->CreatedByUser_Code | string | |\r\n", "operationId": "GetRequisitionItemTransactionCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition Item Transaction collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionItemTransactionCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Transactions/Batch/{ids}": { "get": { "tags": [ "Requisition Item Transaction" ], "summary": "Get a collection of Requisition Item Transaction 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 | RequisitionItemTransaction->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RequisitionItemTransaction->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RequisitionItemTransaction->CreatedByUser_FullName | string | |\r\n| createdOn | RequisitionItemTransaction->CreatedOn | string | date-time |\r\n| permissionTreeId | RequisitionItemTransaction->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionItemTransaction->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionItemTransaction->PermissionTree_Description | string | |\r\n| id | RequisitionItemTransaction->Id | integer | int64 |\r\n| version | RequisitionItemTransaction->Version | integer | int32 |\r\n| financialYearPeriodId | RequisitionItemTransaction->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodCode | RequisitionItemTransaction->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | RequisitionItemTransaction->FinancialYearPeriod_Description | string | |\r\n| financialYearPeriodFinancialYearId | RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearCode | RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Code | string | |\r\n| financialYearPeriodFinancialYearDescription | RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Description | string | |\r\n| itemCostInSiteCurrency | RequisitionItemTransaction->ItemCostInSiteCurrency | number | decimal |\r\n| quantity | RequisitionItemTransaction->Quantity | number | decimal |\r\n| requisitionItemId | RequisitionItemTransaction->RequisitionItem_Id | integer | int64 |\r\n| requisitionItemRequisitionId | RequisitionItemTransaction->RequisitionItem_Requisition_Id | integer | int64 |\r\n| requisitionItemRequisitionCode | RequisitionItemTransaction->RequisitionItem_Requisition_Code | string | |\r\n| requisitionItemRequisitionWorkOrderId | RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Id | integer | int64 |\r\n| requisitionItemRequisitionWorkOrderCode | RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Code | string | |\r\n| requisitionItemRequisitionWorkOrderDescription | RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Description | string | |\r\n| requisitionItemWorkOrderTaskSpareId | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_Id | integer | int64 |\r\n| requisitionItemWorkOrderTaskSpareSpareType | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_SpareType | string (Allowed values: [StockItem, CodedNonStockItem, DirectPurchase, Contractor]) | enum |\r\n| requisitionItemWorkOrderTaskSpareDescription | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_Description | string | |\r\n| requisitionItemWorkOrderTaskSpareStockItemId | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_StockItem_Id | integer | int64 |\r\n| requisitionItemWorkOrderTaskSpareStockItemMaterialMasterId | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_StockItem_MaterialMaster_Id | integer | int64 |\r\n| requisitionItemWorkOrderTaskSpareStockItemMaterialMasterDescription | RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_StockItem_MaterialMaster_Description | string | |\r\n| totalCostInSiteCurrency | RequisitionItemTransaction->TotalCostInSiteCurrency | number | decimal |\r\n| transactedOn | RequisitionItemTransaction->TransactedOn | string | date-time |\r\n| transactionType | RequisitionItemTransaction->TransactionType | string (Allowed values: [Issue, Return]) | enum |\r\n", "operationId": "BatchGetRequisitionItemTransaction", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Requisition Item Transaction id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Requisition Item Transaction collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetRequisitionItemTransactionResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/Items/Transactions/Batch": { "patch": { "tags": [ "Requisition Item Transaction" ], "summary": "Update a collection of existing Requisition Item Transaction resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RequisitionItemTransaction->Id | integer | int64 |\r\n| version | RequisitionItemTransaction->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": "BatchUpdateRequisitionItemTransaction", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateRequisitionItemTransactionResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Requisition Item Transaction batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/{id}": { "get": { "tags": [ "Requisition Status" ], "summary": "Get a Requisition Status 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 | RequisitionStatus->Code | string | |\r\n| isActive | RequisitionStatus->IsActive | boolean | |\r\n| createdByUserId | RequisitionStatus->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RequisitionStatus->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RequisitionStatus->CreatedByUser_FullName | string | |\r\n| createdOn | RequisitionStatus->CreatedOn | string | date-time |\r\n| modifiedByUserId | RequisitionStatus->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RequisitionStatus->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RequisitionStatus->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RequisitionStatus->ModifiedOn | string | date-time |\r\n| version | RequisitionStatus->Version | integer | int32 |\r\n| permissionTreeId | RequisitionStatus->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionStatus->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionStatus->PermissionTree_Description | string | |\r\n| id | RequisitionStatus->Id | integer | int64 |\r\n| applyStatusRestrictions | RequisitionStatus->ApplyStatusRestrictions | boolean | |\r\n| baseStatus | RequisitionStatus->BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled, AwaitingApprovalWorkflow]) | enum |\r\n| description | RequisitionStatus->Description | string | |\r\n| notes | RequisitionStatus->Notes | string | |\r\n| sequenceNumber | RequisitionStatus->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRequisitionStatus", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Status Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Requisition Status", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionStatusResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Requisition Status" ], "summary": "Update an existing Requisition Status resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RequisitionStatus->Version | integer | int32 |\r\n| code | RequisitionStatus->Code | string | |\r\n| description | RequisitionStatus->Description | string | |\r\n| sequenceNumber | RequisitionStatus->SequenceNumber | integer | int32 |\r\n| notes | RequisitionStatus->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": "UpdateRequisitionStatus", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Status Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateRequisitionStatusResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Requisition Status was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Requisition Status" ], "summary": "Delete an existing Requisition Status resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RequisitionStatus->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": "DeleteRequisitionStatus", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Status Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteRequisitionStatusResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Requisition Status was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses": { "get": { "tags": [ "Requisition Status" ], "summary": "Get a collection of Requisition Status 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 | RequisitionStatus->Id | integer | int64 |\r\n| version | RequisitionStatus->Version | integer | int32 |\r\n| code | RequisitionStatus->Code | string | |\r\n| description | RequisitionStatus->Description | string | |\r\n| sequenceNumber | RequisitionStatus->SequenceNumber | integer | int32 |\r\n| baseStatus | RequisitionStatus->BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled, AwaitingApprovalWorkflow]) | enum |\r\n| applyStatusRestrictions | RequisitionStatus->ApplyStatusRestrictions | boolean | |\r\n| isActive | RequisitionStatus->IsActive | boolean | |\r\n", "operationId": "GetRequisitionStatusCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition Status collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionStatusCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Requisition Status" ], "summary": "Create a new Requisition Status resource.", "description": "### Request Body\r\n#### 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 | RequisitionStatus->PermissionTree_Id | integer | int64 |\r\n| code | RequisitionStatus->Code | string | |\r\n| description | RequisitionStatus->Description | string | |\r\n| sequenceNumber | RequisitionStatus->SequenceNumber | integer | int32 |\r\n| baseStatus | RequisitionStatus->BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled, AwaitingApprovalWorkflow]) | enum |\r\n| notes | RequisitionStatus->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| baseStatus | Required | True | |\r\n| baseStatus | Nullable | False | |\r\n\r\n", "operationId": "CreateRequisitionStatus", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateRequisitionStatusResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Lookups/LookupRequisitionStatusChangePermissionTree": { "get": { "tags": [ "Requisition Status" ], "summary": "Lookup the permission set for changing the Requisition Status.", "description": "### Response Body\r\n#### Payload\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": "LookupRequisitionStatusChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionStatusChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Lookups/LookupRequisitionStatusInsertPermissionTree": { "get": { "tags": [ "Requisition Status" ], "summary": "Lookup the permission set for creating the Requisition Status.", "description": "### Response Body\r\n#### Payload\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": "LookupRequisitionStatusInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionStatusInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Batch/{ids}": { "get": { "tags": [ "Requisition Status" ], "summary": "Get a collection of Requisition Status 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 | RequisitionStatus->Code | string | |\r\n| isActive | RequisitionStatus->IsActive | boolean | |\r\n| createdByUserId | RequisitionStatus->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RequisitionStatus->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RequisitionStatus->CreatedByUser_FullName | string | |\r\n| createdOn | RequisitionStatus->CreatedOn | string | date-time |\r\n| modifiedByUserId | RequisitionStatus->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RequisitionStatus->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RequisitionStatus->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RequisitionStatus->ModifiedOn | string | date-time |\r\n| version | RequisitionStatus->Version | integer | int32 |\r\n| permissionTreeId | RequisitionStatus->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionStatus->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionStatus->PermissionTree_Description | string | |\r\n| id | RequisitionStatus->Id | integer | int64 |\r\n| applyStatusRestrictions | RequisitionStatus->ApplyStatusRestrictions | boolean | |\r\n| baseStatus | RequisitionStatus->BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled, AwaitingApprovalWorkflow]) | enum |\r\n| description | RequisitionStatus->Description | string | |\r\n| notes | RequisitionStatus->Notes | string | |\r\n| sequenceNumber | RequisitionStatus->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetRequisitionStatus", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Requisition Status id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Requisition Status collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetRequisitionStatusResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Batch": { "post": { "tags": [ "Requisition Status" ], "summary": "Create a new collection of Requisition Status resources.", "description": "### Request Body\r\n#### 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 | RequisitionStatus->PermissionTree_Id | integer | int64 |\r\n| code | RequisitionStatus->Code | string | |\r\n| description | RequisitionStatus->Description | string | |\r\n| notes | RequisitionStatus->Notes | string | |\r\n| sequenceNumber | RequisitionStatus->SequenceNumber | integer | int32 |\r\n| baseStatus | RequisitionStatus->BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled, AwaitingApprovalWorkflow]) | enum |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| 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| baseStatus | Required | True | |\r\n| baseStatus | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRequisitionStatus", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateRequisitionStatusResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Requisition Status batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Requisition Status" ], "summary": "Update a collection of existing Requisition Status resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RequisitionStatus->Id | integer | int64 |\r\n| version | RequisitionStatus->Version | integer | int32 |\r\n| code | RequisitionStatus->Code | string | |\r\n| description | RequisitionStatus->Description | string | |\r\n| sequenceNumber | RequisitionStatus->SequenceNumber | integer | int32 |\r\n| notes | RequisitionStatus->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": "BatchUpdateRequisitionStatus", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateRequisitionStatusResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Requisition Status batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Requisition Status" ], "summary": "Delete a collection of existing Requisition Status resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RequisitionStatus->Id | integer | int64 |\r\n| version | RequisitionStatus->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": "BatchDeleteRequisitionStatus", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteRequisitionStatusResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Requisition Status batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/{id}/Active": { "patch": { "tags": [ "Requisition Status" ], "summary": "Change the IsActive status for an existing Requisition Status resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RequisitionStatus->Version | integer | int32 |\r\n| isActive | RequisitionStatus->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": "ChangeRequisitionStatusIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Status Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeRequisitionStatusIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/{id}/PermissionTree": { "patch": { "tags": [ "Requisition Status" ], "summary": "Change the PermissionTree for an existing Requisition Status resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RequisitionStatus->Version | integer | int32 |\r\n| permissionTreeId | RequisitionStatus->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": "ChangeRequisitionStatusPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Status Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeRequisitionStatusPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Batch/Active": { "patch": { "tags": [ "Requisition Status" ], "summary": "Change the IsActive status for a collection of existing Requisition Status resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RequisitionStatus->Id | integer | int64 |\r\n| version | RequisitionStatus->Version | integer | int32 |\r\n| isActive | RequisitionStatus->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": "BatchChangeRequisitionStatusIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeRequisitionStatusIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Batch/PermissionTree": { "patch": { "tags": [ "Requisition Status" ], "summary": "Change the PermissionTree status for a collection of existing Requisition Status resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RequisitionStatus->Id | integer | int64 |\r\n| version | RequisitionStatus->Version | integer | int32 |\r\n| permissionTreeId | RequisitionStatus->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": "BatchChangeRequisitionStatusPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeRequisitionStatusPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Attributes/{id}": { "get": { "tags": [ "Requisition Status Attribute" ], "summary": "Get a collection of Requisition Status Attribute resources for the Requisition Status.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| requisitionStatusId | RequisitionStatusAttribute->RequisitionStatus_Id | integer | int64 |\r\n| requisitionStatusCode | RequisitionStatusAttribute->RequisitionStatus_Code | string | |\r\n| requisitionStatusDescription | RequisitionStatusAttribute->RequisitionStatus_Description | string | |\r\n| createdByUserId | RequisitionStatusAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RequisitionStatusAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RequisitionStatusAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | RequisitionStatusAttribute->CreatedOn | string | date-time |\r\n| isActive | RequisitionStatusAttribute->IsActive | boolean | |\r\n| modifiedByUserId | RequisitionStatusAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RequisitionStatusAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RequisitionStatusAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RequisitionStatusAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | RequisitionStatusAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionStatusAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionStatusAttribute->PermissionTree_Description | string | |\r\n| version | RequisitionStatusAttribute->Version | integer | int32 |\r\n| id | RequisitionStatusAttribute->Id | integer | int64 |\r\n| attributeId | RequisitionStatusAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RequisitionStatusAttribute->Attribute_Code | string | |\r\n| attributeDescription | RequisitionStatusAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | RequisitionStatusAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | RequisitionStatusAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | RequisitionStatusAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | RequisitionStatusAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | RequisitionStatusAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | RequisitionStatusAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | RequisitionStatusAttribute->Notes | string | |\r\n| predefinedValueId | RequisitionStatusAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RequisitionStatusAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RequisitionStatusAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | RequisitionStatusAttribute->SequenceNumber | integer | int32 |\r\n| value | RequisitionStatusAttribute->Value | object | composite |\r\n", "operationId": "GetRequisitionStatusAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Status Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Requisition Status Attribute", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionStatusAttributeResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Requisition Status Attribute" ], "summary": "Update an existing Requisition Status 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 | RequisitionStatusAttribute->Version | integer | int32 |\r\n| value | RequisitionStatusAttribute->Value | object | composite |\r\n| predefinedValueId | RequisitionStatusAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | RequisitionStatusAttribute->SequenceNumber | integer | int32 |\r\n| notes | RequisitionStatusAttribute->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": "UpdateRequisitionStatusAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Status Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateRequisitionStatusAttributeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Requisition Status Attribute was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Requisition Status Attribute" ], "summary": "Delete an existing Requisition Status 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 | RequisitionStatusAttribute->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": "DeleteRequisitionStatusAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Status Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteRequisitionStatusAttributeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Requisition Status Attribute was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/{requisitionStatusId}/Attributes": { "get": { "tags": [ "Requisition Status Attribute" ], "summary": "Get a collection of Requisition Status Attribute resources for the Requisition Status.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RequisitionStatusAttribute->Id | integer | int64 |\r\n| version | RequisitionStatusAttribute->Version | integer | int32 |\r\n| sequenceNumber | RequisitionStatusAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | RequisitionStatusAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RequisitionStatusAttribute->Attribute_Code | string | |\r\n| attributeDescription | RequisitionStatusAttribute->Attribute_Description | string | |\r\n| attributeDataType | RequisitionStatusAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | RequisitionStatusAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RequisitionStatusAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RequisitionStatusAttribute->PredefinedValue_Value | object | composite |\r\n| value | RequisitionStatusAttribute->Value | object | composite |\r\n| notes | RequisitionStatusAttribute->Notes | string | |\r\n| createdOn | RequisitionStatusAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | RequisitionStatusAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetRequisitionStatusAttributeCollectionForRequisitionStatus", "parameters": [ { "name": "requisitionStatusId", "in": "path", "required": true, "description": "Requisition Status Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition Status Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionStatusAttributeCollectionForRequisitionStatusResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Attributes": { "get": { "tags": [ "Requisition Status Attribute" ], "summary": "Get a collection of Requisition Status 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 | RequisitionStatusAttribute->Id | integer | int64 |\r\n| version | RequisitionStatusAttribute->Version | integer | int32 |\r\n| sequenceNumber | RequisitionStatusAttribute->SequenceNumber | integer | int32 |\r\n| requisitionStatusCode | RequisitionStatusAttribute->RequisitionStatus_Code | string | |\r\n| requisitionStatusDescription | RequisitionStatusAttribute->RequisitionStatus_Description | string | |\r\n| attributeId | RequisitionStatusAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RequisitionStatusAttribute->Attribute_Code | string | |\r\n| attributeDescription | RequisitionStatusAttribute->Attribute_Description | string | |\r\n| attributeDataType | RequisitionStatusAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | RequisitionStatusAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RequisitionStatusAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RequisitionStatusAttribute->PredefinedValue_Value | object | composite |\r\n| value | RequisitionStatusAttribute->Value | object | composite |\r\n| notes | RequisitionStatusAttribute->Notes | string | |\r\n| createdOn | RequisitionStatusAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | RequisitionStatusAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetRequisitionStatusAttributeCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition Status Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionStatusAttributeCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Requisition Status Attribute" ], "summary": "Create a new Requisition Status 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| requisitionStatusId | RequisitionStatusAttribute->RequisitionStatus_Id | integer | int64 |\r\n| attributeId | RequisitionStatusAttribute->Attribute_Id | integer | int64 |\r\n| value | RequisitionStatusAttribute->Value | object | composite |\r\n| predefinedValueId | RequisitionStatusAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | RequisitionStatusAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RequisitionStatusAttribute->SequenceNumber | integer | int32 |\r\n| notes | RequisitionStatusAttribute->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| requisitionStatusId | Required | True | |\r\n| requisitionStatusId | 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": "CreateRequisitionStatusAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateRequisitionStatusAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Attributes/Lookups/LookupRequisitionStatusAttributeAllowedValue": { "get": { "tags": [ "Requisition Status Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Requisition Status 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": "LookupRequisitionStatusAttributeAllowedValue", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Attribute Allowed Value collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionStatusAttributeAttributeAllowedValueLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Attributes/Lookups/LookupRequisitionStatusAttribute": { "get": { "tags": [ "Requisition Status Attribute" ], "summary": "Lookup the Attribute for the Requisition Status 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": "LookupRequisitionStatusAttribute", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionStatusAttributeAttributeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Attributes/Lookups/LookupRequisitionStatusAttributeChangePermissionTree": { "get": { "tags": [ "Requisition Status Attribute" ], "summary": "Lookup the permission set for changing the Requisition Status 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": "LookupRequisitionStatusAttributeChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionStatusAttributeChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Attributes/Lookups/LookupRequisitionStatusAttributeInsertPermissionTree": { "get": { "tags": [ "Requisition Status Attribute" ], "summary": "Lookup the permission set for creating the Requisition Status 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": "LookupRequisitionStatusAttributeInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionStatusAttributeInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Attributes/Lookups/LookupRequisitionStatusAttributeRequisitionStatus": { "get": { "tags": [ "Requisition Status Attribute" ], "summary": "Lookup the Requisition Status Attribute for the Requisition Status 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 | RequisitionStatus->Id | integer | int64 |\r\n| code | RequisitionStatus->Code | string | |\r\n| description | RequisitionStatus->Description | string | |\r\n", "operationId": "LookupRequisitionStatusAttributeRequisitionStatus", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition Status collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionStatusAttributeRequisitionStatusLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Attributes/Batch/{ids}": { "get": { "tags": [ "Requisition Status Attribute" ], "summary": "Get a collection of Requisition Status 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| requisitionStatusId | RequisitionStatusAttribute->RequisitionStatus_Id | integer | int64 |\r\n| requisitionStatusCode | RequisitionStatusAttribute->RequisitionStatus_Code | string | |\r\n| requisitionStatusDescription | RequisitionStatusAttribute->RequisitionStatus_Description | string | |\r\n| createdByUserId | RequisitionStatusAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RequisitionStatusAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RequisitionStatusAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | RequisitionStatusAttribute->CreatedOn | string | date-time |\r\n| isActive | RequisitionStatusAttribute->IsActive | boolean | |\r\n| modifiedByUserId | RequisitionStatusAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RequisitionStatusAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RequisitionStatusAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RequisitionStatusAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | RequisitionStatusAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionStatusAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionStatusAttribute->PermissionTree_Description | string | |\r\n| version | RequisitionStatusAttribute->Version | integer | int32 |\r\n| id | RequisitionStatusAttribute->Id | integer | int64 |\r\n| attributeId | RequisitionStatusAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RequisitionStatusAttribute->Attribute_Code | string | |\r\n| attributeDescription | RequisitionStatusAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | RequisitionStatusAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | RequisitionStatusAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | RequisitionStatusAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | RequisitionStatusAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | RequisitionStatusAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | RequisitionStatusAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | RequisitionStatusAttribute->Notes | string | |\r\n| predefinedValueId | RequisitionStatusAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RequisitionStatusAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RequisitionStatusAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | RequisitionStatusAttribute->SequenceNumber | integer | int32 |\r\n| value | RequisitionStatusAttribute->Value | object | composite |\r\n", "operationId": "BatchGetRequisitionStatusAttribute", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Requisition Status Attribute id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Requisition Status Attribute collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetRequisitionStatusAttributeResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Attributes/Batch": { "post": { "tags": [ "Requisition Status Attribute" ], "summary": "Create a new collection of Requisition Status 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| requisitionStatusId | RequisitionStatusAttribute->RequisitionStatus_Id | integer | int64 |\r\n| attributeId | RequisitionStatusAttribute->Attribute_Id | integer | int64 |\r\n| value | RequisitionStatusAttribute->Value | object | composite |\r\n| predefinedValueId | RequisitionStatusAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | RequisitionStatusAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RequisitionStatusAttribute->SequenceNumber | integer | int32 |\r\n| notes | RequisitionStatusAttribute->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| requisitionStatusId | Required | True | |\r\n| requisitionStatusId | 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": "BatchCreateRequisitionStatusAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateRequisitionStatusAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Requisition Status Attribute batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Requisition Status Attribute" ], "summary": "Update a collection of existing Requisition Status 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 | RequisitionStatusAttribute->Id | integer | int64 |\r\n| version | RequisitionStatusAttribute->Version | integer | int32 |\r\n| value | RequisitionStatusAttribute->Value | object | composite |\r\n| predefinedValueId | RequisitionStatusAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | RequisitionStatusAttribute->SequenceNumber | integer | int32 |\r\n| notes | RequisitionStatusAttribute->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": "BatchUpdateRequisitionStatusAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateRequisitionStatusAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Requisition Status Attribute batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Requisition Status Attribute" ], "summary": "Delete a collection of existing Requisition Status 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 | RequisitionStatusAttribute->Id | integer | int64 |\r\n| version | RequisitionStatusAttribute->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": "BatchDeleteRequisitionStatusAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteRequisitionStatusAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Requisition Status Attribute batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Attributes/{id}/Active": { "patch": { "tags": [ "Requisition Status Attribute" ], "summary": "Change the IsActive status for an existing Requisition Status 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 | RequisitionStatusAttribute->Version | integer | int32 |\r\n| isActive | RequisitionStatusAttribute->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": "ChangeRequisitionStatusAttributeIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Status Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeRequisitionStatusAttributeIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Requisition Status Attribute" ], "summary": "Change the PermissionTree for an existing Requisition Status 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 | RequisitionStatusAttribute->Version | integer | int32 |\r\n| permissionTreeId | RequisitionStatusAttribute->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": "ChangeRequisitionStatusAttributePermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Status Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeRequisitionStatusAttributePermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Attributes/Batch/Active": { "patch": { "tags": [ "Requisition Status Attribute" ], "summary": "Change the IsActive status for a collection of existing Requisition Status 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 | RequisitionStatusAttribute->Id | integer | int64 |\r\n| version | RequisitionStatusAttribute->Version | integer | int32 |\r\n| isActive | RequisitionStatusAttribute->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": "BatchChangeRequisitionStatusAttributeIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeRequisitionStatusAttributeIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Requisition Status Attribute" ], "summary": "Change the PermissionTree status for a collection of existing Requisition Status 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 | RequisitionStatusAttribute->Id | integer | int64 |\r\n| version | RequisitionStatusAttribute->Version | integer | int32 |\r\n| permissionTreeId | RequisitionStatusAttribute->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": "BatchChangeRequisitionStatusAttributePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeRequisitionStatusAttributePermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/StatusChangeHistory/{id}": { "get": { "tags": [ "Requisition Status Change History" ], "summary": "Get a Requisition Status Change History 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 | RequisitionStatusChangeHistory->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RequisitionStatusChangeHistory->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RequisitionStatusChangeHistory->CreatedByUser_FullName | string | |\r\n| createdOn | RequisitionStatusChangeHistory->CreatedOn | string | date-time |\r\n| id | RequisitionStatusChangeHistory->Id | integer | int64 |\r\n| version | RequisitionStatusChangeHistory->Version | integer | int32 |\r\n| elapsedTime | RequisitionStatusChangeHistory->ElapsedTime | string | duration |\r\n| isLatest | RequisitionStatusChangeHistory->IsLatest | boolean | |\r\n| newStatusId | RequisitionStatusChangeHistory->NewStatus_Id | integer | int64 |\r\n| newStatusCode | RequisitionStatusChangeHistory->NewStatus_Code | string | |\r\n| newStatusDescription | RequisitionStatusChangeHistory->NewStatus_Description | string | |\r\n| oldStatusId | RequisitionStatusChangeHistory->OldStatus_Id | integer | int64 |\r\n| oldStatusCode | RequisitionStatusChangeHistory->OldStatus_Code | string | |\r\n| oldStatusDescription | RequisitionStatusChangeHistory->OldStatus_Description | string | |\r\n| predecessorId | RequisitionStatusChangeHistory->Predecessor_Id | integer | int64 |\r\n| predecessorRequisitionId | RequisitionStatusChangeHistory->Predecessor_Requisition_Id | integer | int64 |\r\n| predecessorRequisitionCode | RequisitionStatusChangeHistory->Predecessor_Requisition_Code | string | |\r\n| remark | RequisitionStatusChangeHistory->Remark | string | |\r\n| requisitionId | RequisitionStatusChangeHistory->Requisition_Id | integer | int64 |\r\n| requisitionCode | RequisitionStatusChangeHistory->Requisition_Code | string | |\r\n| requisitionRequestedOn | RequisitionStatusChangeHistory->Requisition_RequestedOn | string | date-time |\r\n| requisitionPermissionTreeId | RequisitionStatusChangeHistory->Requisition_PermissionTree_Id | integer | int64 |\r\n| requisitionPermissionTreeCode | RequisitionStatusChangeHistory->Requisition_PermissionTree_Code | string | |\r\n| requisitionPermissionTreeDescription | RequisitionStatusChangeHistory->Requisition_PermissionTree_Description | string | |\r\n| statusChangedOn | RequisitionStatusChangeHistory->StatusChangedOn | string | date-time |\r\n", "operationId": "GetRequisitionStatusChangeHistory", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Status Change History Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Requisition Status Change History", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionStatusChangeHistoryResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/{requisitionId}/StatusChangeHistory": { "get": { "tags": [ "Requisition Status Change History" ], "summary": "Get a collection of Requisition Status Change History resources for the Requisition.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RequisitionStatusChangeHistory->Id | integer | int64 |\r\n| elapsedTime | RequisitionStatusChangeHistory->ElapsedTime | string | duration |\r\n| isLatest | RequisitionStatusChangeHistory->IsLatest | boolean | |\r\n| newStatusId | RequisitionStatusChangeHistory->NewStatus_Id | integer | int64 |\r\n| newStatusCode | RequisitionStatusChangeHistory->NewStatus_Code | string | |\r\n| newStatusDescription | RequisitionStatusChangeHistory->NewStatus_Description | string | |\r\n| oldStatusId | RequisitionStatusChangeHistory->OldStatus_Id | integer | int64 |\r\n| oldStatusCode | RequisitionStatusChangeHistory->OldStatus_Code | string | |\r\n| oldStatusDescription | RequisitionStatusChangeHistory->OldStatus_Description | string | |\r\n| predecessorId | RequisitionStatusChangeHistory->Predecessor_Id | integer | int64 |\r\n| predecessorRequisitionCode | RequisitionStatusChangeHistory->Predecessor_Requisition_Code | string | |\r\n| remark | RequisitionStatusChangeHistory->Remark | string | |\r\n| createdOn | RequisitionStatusChangeHistory->CreatedOn | string | date-time |\r\n| createdByUserCode | RequisitionStatusChangeHistory->CreatedByUser_Code | string | |\r\n", "operationId": "GetRequisitionStatusChangeHistoryCollectionForRequisitionCollection", "parameters": [ { "name": "requisitionId", "in": "path", "required": true, "description": "Requisition Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition Status Change History collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionStatusChangeHistoryCollectionForRequisitionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/StatusChangeHistory": { "get": { "tags": [ "Requisition Status Change History" ], "summary": "Get a collection of Requisition Status Change History 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 | RequisitionStatusChangeHistory->Id | integer | int64 |\r\n| elapsedTime | RequisitionStatusChangeHistory->ElapsedTime | string | duration |\r\n| isLatest | RequisitionStatusChangeHistory->IsLatest | boolean | |\r\n| newStatusId | RequisitionStatusChangeHistory->NewStatus_Id | integer | int64 |\r\n| newStatusCode | RequisitionStatusChangeHistory->NewStatus_Code | string | |\r\n| newStatusDescription | RequisitionStatusChangeHistory->NewStatus_Description | string | |\r\n| oldStatusId | RequisitionStatusChangeHistory->OldStatus_Id | integer | int64 |\r\n| oldStatusCode | RequisitionStatusChangeHistory->OldStatus_Code | string | |\r\n| oldStatusDescription | RequisitionStatusChangeHistory->OldStatus_Description | string | |\r\n| predecessorId | RequisitionStatusChangeHistory->Predecessor_Id | integer | int64 |\r\n| predecessorRequisitionCode | RequisitionStatusChangeHistory->Predecessor_Requisition_Code | string | |\r\n| remark | RequisitionStatusChangeHistory->Remark | string | |\r\n| createdOn | RequisitionStatusChangeHistory->CreatedOn | string | date-time |\r\n| createdByUserCode | RequisitionStatusChangeHistory->CreatedByUser_Code | string | |\r\n| requisitionId | RequisitionStatusChangeHistory->Requisition_Id | integer | int64 |\r\n| requisitionCode | RequisitionStatusChangeHistory->Requisition_Code | string | |\r\n| requisitionRequestedOn | RequisitionStatusChangeHistory->Requisition_RequestedOn | string | date-time |\r\n| requisitionPermissionTreeCode | RequisitionStatusChangeHistory->Requisition_PermissionTree_Code | string | |\r\n| requisitionPermissionTreeDescription | RequisitionStatusChangeHistory->Requisition_PermissionTree_Description | string | |\r\n| requisitionWorkOrderCode | RequisitionStatusChangeHistory->Requisition_WorkOrder_Code | string | |\r\n| requisitionWorkOrderDescription | RequisitionStatusChangeHistory->Requisition_WorkOrder_Description | string | |\r\n", "operationId": "GetRequisitionStatusChangeHistoryCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition Status Change History collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionStatusChangeHistoryCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Requisitions/StatusChangeHistory/Batch/{ids}": { "get": { "tags": [ "Requisition Status Change History" ], "summary": "Get a collection of Requisition Status Change History 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 | RequisitionStatusChangeHistory->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RequisitionStatusChangeHistory->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RequisitionStatusChangeHistory->CreatedByUser_FullName | string | |\r\n| createdOn | RequisitionStatusChangeHistory->CreatedOn | string | date-time |\r\n| id | RequisitionStatusChangeHistory->Id | integer | int64 |\r\n| version | RequisitionStatusChangeHistory->Version | integer | int32 |\r\n| elapsedTime | RequisitionStatusChangeHistory->ElapsedTime | string | duration |\r\n| isLatest | RequisitionStatusChangeHistory->IsLatest | boolean | |\r\n| newStatusId | RequisitionStatusChangeHistory->NewStatus_Id | integer | int64 |\r\n| newStatusCode | RequisitionStatusChangeHistory->NewStatus_Code | string | |\r\n| newStatusDescription | RequisitionStatusChangeHistory->NewStatus_Description | string | |\r\n| oldStatusId | RequisitionStatusChangeHistory->OldStatus_Id | integer | int64 |\r\n| oldStatusCode | RequisitionStatusChangeHistory->OldStatus_Code | string | |\r\n| oldStatusDescription | RequisitionStatusChangeHistory->OldStatus_Description | string | |\r\n| predecessorId | RequisitionStatusChangeHistory->Predecessor_Id | integer | int64 |\r\n| predecessorRequisitionId | RequisitionStatusChangeHistory->Predecessor_Requisition_Id | integer | int64 |\r\n| predecessorRequisitionCode | RequisitionStatusChangeHistory->Predecessor_Requisition_Code | string | |\r\n| remark | RequisitionStatusChangeHistory->Remark | string | |\r\n| requisitionId | RequisitionStatusChangeHistory->Requisition_Id | integer | int64 |\r\n| requisitionCode | RequisitionStatusChangeHistory->Requisition_Code | string | |\r\n| requisitionRequestedOn | RequisitionStatusChangeHistory->Requisition_RequestedOn | string | date-time |\r\n| requisitionPermissionTreeId | RequisitionStatusChangeHistory->Requisition_PermissionTree_Id | integer | int64 |\r\n| requisitionPermissionTreeCode | RequisitionStatusChangeHistory->Requisition_PermissionTree_Code | string | |\r\n| requisitionPermissionTreeDescription | RequisitionStatusChangeHistory->Requisition_PermissionTree_Description | string | |\r\n| statusChangedOn | RequisitionStatusChangeHistory->StatusChangedOn | string | date-time |\r\n", "operationId": "BatchGetRequisitionStatusChangeHistory", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Requisition Status Change History id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Requisition Status Change History collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetRequisitionStatusChangeHistoryResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Documents/{id}": { "get": { "tags": [ "Requisition Status Document" ], "summary": "Get a Requisition Status 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| requisitionStatusId | RequisitionStatusDocument->RequisitionStatus_Id | integer | int64 |\r\n| requisitionStatusCode | RequisitionStatusDocument->RequisitionStatus_Code | string | |\r\n| requisitionStatusDescription | RequisitionStatusDocument->RequisitionStatus_Description | string | |\r\n| isActive | RequisitionStatusDocument->IsActive | boolean | |\r\n| createdByUserId | RequisitionStatusDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RequisitionStatusDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RequisitionStatusDocument->CreatedByUser_FullName | string | |\r\n| createdOn | RequisitionStatusDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | RequisitionStatusDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RequisitionStatusDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RequisitionStatusDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RequisitionStatusDocument->ModifiedOn | string | date-time |\r\n| version | RequisitionStatusDocument->Version | integer | int32 |\r\n| permissionTreeId | RequisitionStatusDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionStatusDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionStatusDocument->PermissionTree_Description | string | |\r\n| id | RequisitionStatusDocument->Id | integer | int64 |\r\n| documentRecordId | RequisitionStatusDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RequisitionStatusDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RequisitionStatusDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RequisitionStatusDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | RequisitionStatusDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | RequisitionStatusDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | RequisitionStatusDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | RequisitionStatusDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | RequisitionStatusDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | RequisitionStatusDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RequisitionStatusDocument->Notes | string | |\r\n| sequenceNumber | RequisitionStatusDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRequisitionStatusDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Status Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Requisition Status Document", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionStatusDocumentResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Requisition Status Document" ], "summary": "Update an existing Requisition Status 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 | RequisitionStatusDocument->Version | integer | int32 |\r\n| sequenceNumber | RequisitionStatusDocument->SequenceNumber | integer | int32 |\r\n| notes | RequisitionStatusDocument->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": "UpdateRequisitionStatusDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Status Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateRequisitionStatusDocumentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Requisition Status Document was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Requisition Status Document" ], "summary": "Delete an existing Requisition Status 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 | RequisitionStatusDocument->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": "DeleteRequisitionStatusDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Status Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteRequisitionStatusDocumentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Requisition Status Document was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/{id}/Documents": { "get": { "tags": [ "Requisition Status Document" ], "summary": "Get a collection of Requisition Status Document resources for the Requisition Status.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RequisitionStatusDocument->Id | integer | int64 |\r\n| version | RequisitionStatusDocument->Version | integer | int32 |\r\n| sequenceNumber | RequisitionStatusDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | RequisitionStatusDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RequisitionStatusDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RequisitionStatusDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RequisitionStatusDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | RequisitionStatusDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | RequisitionStatusDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | RequisitionStatusDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetRequisitionStatusDocumentCollectionForRequisitionStatus", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Status Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition Status Document collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionStatusDocumentCollectionForRequisitionStatusResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Documents": { "get": { "tags": [ "Requisition Status Document" ], "summary": "Get a collection of Requisition Status 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 | RequisitionStatusDocument->Id | integer | int64 |\r\n| version | RequisitionStatusDocument->Version | integer | int32 |\r\n| requisitionStatusId | RequisitionStatusDocument->RequisitionStatus_Id | integer | int64 |\r\n| requisitionStatusCode | RequisitionStatusDocument->RequisitionStatus_Code | string | |\r\n| requisitionStatusDescription | RequisitionStatusDocument->RequisitionStatus_Description | string | |\r\n| sequenceNumber | RequisitionStatusDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | RequisitionStatusDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RequisitionStatusDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RequisitionStatusDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RequisitionStatusDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | RequisitionStatusDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | RequisitionStatusDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | RequisitionStatusDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetRequisitionStatusDocumentCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition Status Document collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetRequisitionStatusDocumentCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Requisition Status Document" ], "summary": "Create a new Requisition Status 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| requisitionStatusId | RequisitionStatusDocument->RequisitionStatus_Id | integer | int64 |\r\n| documentRecordId | RequisitionStatusDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | RequisitionStatusDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RequisitionStatusDocument->SequenceNumber | integer | int32 |\r\n| notes | RequisitionStatusDocument->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| requisitionStatusId | Required | True | |\r\n| requisitionStatusId | 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": "CreateRequisitionStatusDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateRequisitionStatusDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Documents/Lookups/LookupRequisitionStatusDocumentChangePermissionTree": { "get": { "tags": [ "Requisition Status Document" ], "summary": "Lookup the permission set for changing the Requisition Status 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": "LookupRequisitionStatusDocumentChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionStatusDocumentChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Documents/Lookups/LookupRequisitionStatusDocument": { "get": { "tags": [ "Requisition Status Document" ], "summary": "Requisition Status 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": "LookupRequisitionStatusDocument", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Document Record collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionStatusDocumentDocumentLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Documents/Lookups/LookupRequisitionStatusDocumentInsertPermissionTree": { "get": { "tags": [ "Requisition Status Document" ], "summary": "Lookup the permission set for creating the Requisition Status 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": "LookupRequisitionStatusDocumentInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionStatusDocumentInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Documents/Lookups/LookupRequisitionStatusDocumentRequisitionStatus": { "get": { "tags": [ "Requisition Status Document" ], "summary": "Lookup the Requisition Status Document for the Requisition Status 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 | RequisitionStatus->Id | integer | int64 |\r\n| code | RequisitionStatus->Code | string | |\r\n| description | RequisitionStatus->Description | string | |\r\n", "operationId": "LookupRequisitionStatusDocumentRequisitionStatus", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Requisition Status collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/RequisitionStatusDocumentRequisitionStatusLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Documents/Batch/{ids}": { "get": { "tags": [ "Requisition Status Document" ], "summary": "Get a collection of Requisition Status 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| requisitionStatusId | RequisitionStatusDocument->RequisitionStatus_Id | integer | int64 |\r\n| requisitionStatusCode | RequisitionStatusDocument->RequisitionStatus_Code | string | |\r\n| requisitionStatusDescription | RequisitionStatusDocument->RequisitionStatus_Description | string | |\r\n| isActive | RequisitionStatusDocument->IsActive | boolean | |\r\n| createdByUserId | RequisitionStatusDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RequisitionStatusDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RequisitionStatusDocument->CreatedByUser_FullName | string | |\r\n| createdOn | RequisitionStatusDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | RequisitionStatusDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RequisitionStatusDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RequisitionStatusDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RequisitionStatusDocument->ModifiedOn | string | date-time |\r\n| version | RequisitionStatusDocument->Version | integer | int32 |\r\n| permissionTreeId | RequisitionStatusDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequisitionStatusDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequisitionStatusDocument->PermissionTree_Description | string | |\r\n| id | RequisitionStatusDocument->Id | integer | int64 |\r\n| documentRecordId | RequisitionStatusDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RequisitionStatusDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RequisitionStatusDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RequisitionStatusDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | RequisitionStatusDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | RequisitionStatusDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | RequisitionStatusDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | RequisitionStatusDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | RequisitionStatusDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | RequisitionStatusDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RequisitionStatusDocument->Notes | string | |\r\n| sequenceNumber | RequisitionStatusDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetRequisitionStatusDocument", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Requisition Status Document id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Requisition Status Document collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetRequisitionStatusDocumentResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Documents/Batch": { "post": { "tags": [ "Requisition Status Document" ], "summary": "Create a new collection of Requisition Status 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| requisitionStatusId | RequisitionStatusDocument->RequisitionStatus_Id | integer | int64 |\r\n| documentRecordId | RequisitionStatusDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | RequisitionStatusDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RequisitionStatusDocument->SequenceNumber | integer | int32 |\r\n| notes | RequisitionStatusDocument->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| requisitionStatusId | Required | True | |\r\n| requisitionStatusId | 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": "BatchCreateRequisitionStatusDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateRequisitionStatusDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Requisition Status Document batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Requisition Status Document" ], "summary": "Update a collection of existing Requisition Status 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 | RequisitionStatusDocument->Id | integer | int64 |\r\n| version | RequisitionStatusDocument->Version | integer | int32 |\r\n| sequenceNumber | RequisitionStatusDocument->SequenceNumber | integer | int32 |\r\n| notes | RequisitionStatusDocument->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": "BatchUpdateRequisitionStatusDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateRequisitionStatusDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Requisition Status Document batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Requisition Status Document" ], "summary": "Delete a collection of existing Requisition Status 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 | RequisitionStatusDocument->Id | integer | int64 |\r\n| version | RequisitionStatusDocument->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": "BatchDeleteRequisitionStatusDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteRequisitionStatusDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Requisition Status Document batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Documents/{id}/Active": { "patch": { "tags": [ "Requisition Status Document" ], "summary": "Change the IsActive status for an existing Requisition Status 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 | RequisitionStatusDocument->Version | integer | int32 |\r\n| isActive | RequisitionStatusDocument->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": "ChangeRequisitionStatusDocumentIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Status Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeRequisitionStatusDocumentIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Requisition Status Document" ], "summary": "Change the PermissionTree for an existing Requisition Status 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 | RequisitionStatusDocument->Version | integer | int32 |\r\n| permissionTreeId | RequisitionStatusDocument->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": "ChangeRequisitionStatusDocumentPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Requisition Status Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeRequisitionStatusDocumentPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Requisition Status Document" ], "summary": "Change the PermissionTree status for a collection of existing Requisition Status 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 | RequisitionStatusDocument->Id | integer | int64 |\r\n| version | RequisitionStatusDocument->Version | integer | int32 |\r\n| permissionTreeId | RequisitionStatusDocument->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": "BatchChangeRequisitionStatusDocumentPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeRequisitionStatusDocumentPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/RequisitionStatuses/Documents/Batch/Active": { "patch": { "tags": [ "Requisition Status Document" ], "summary": "Change the IsActive status for a collection of existing Requisition Status 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 | RequisitionStatusDocument->Id | integer | int64 |\r\n| version | RequisitionStatusDocument->Version | integer | int32 |\r\n| isActive | RequisitionStatusDocument->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": "BatchChangeRequisitionStatusDocumentIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeRequisitionStatusDocumentIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/{id}": { "get": { "tags": [ "Stock Item" ], "summary": "Get a Stock Item 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 | StockItem->IsActive | boolean | |\r\n| createdByUserId | StockItem->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | StockItem->CreatedByUser_Code | string | |\r\n| createdByUserFullName | StockItem->CreatedByUser_FullName | string | |\r\n| createdOn | StockItem->CreatedOn | string | date-time |\r\n| modifiedByUserId | StockItem->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | StockItem->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | StockItem->ModifiedByUser_FullName | string | |\r\n| modifiedOn | StockItem->ModifiedOn | string | date-time |\r\n| version | StockItem->Version | integer | int32 |\r\n| permissionTreeId | StockItem->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StockItem->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StockItem->PermissionTree_Description | string | |\r\n| id | StockItem->Id | integer | int64 |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| averageItemCost | StockItem->AverageItemCost | number | decimal |\r\n| barcode | StockItem->Barcode | string | |\r\n| categoryId | StockItem->Category_Id | integer | int64 |\r\n| categoryCode | StockItem->Category_Code | string | |\r\n| categoryDescription | StockItem->Category_Description | string | |\r\n| classification | StockItem->Classification | string | |\r\n| costElementId | StockItem->CostElement_Id | integer | int64 |\r\n| costElementCode | StockItem->CostElement_Code | string | |\r\n| costElementDescription | StockItem->CostElement_Description | string | |\r\n| defaultStockItemBinId | StockItem->DefaultStockItemBin_Id | integer | int64 |\r\n| defaultStockItemBinCode | StockItem->DefaultStockItemBin_Code | string | |\r\n| defaultStockItemSupplierId | StockItem->DefaultStockItemSupplier_Id | integer | int64 |\r\n| defaultStockItemSupplierSupplierId | StockItem->DefaultStockItemSupplier_Supplier_Id | integer | int64 |\r\n| defaultStockItemSupplierSupplierCode | StockItem->DefaultStockItemSupplier_Supplier_Code | string | |\r\n| defaultStockItemSupplierSupplierDescription | StockItem->DefaultStockItemSupplier_Supplier_Description | string | |\r\n| highLifeExpectancy | StockItem->HighLifeExpectancy | string | duration |\r\n| isInsuranceItem | StockItem->IsInsuranceItem | boolean | |\r\n| isStockItem | StockItem->IsStockItem | boolean | |\r\n| itemSize | StockItem->ItemSize | string | |\r\n| leadTime | StockItem->LeadTime | string | duration |\r\n| lowLifeExpectancy | StockItem->LowLifeExpectancy | string | duration |\r\n| materialMasterId | StockItem->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| materialMasterDescription | StockItem->MaterialMaster_Description | string | |\r\n| materialMasterCommodityId | StockItem->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | StockItem->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | StockItem->MaterialMaster_Commodity_Description | string | |\r\n| maximumLevel | StockItem->MaximumLevel | number | decimal |\r\n| mediumLifeExpectancy | StockItem->MediumLifeExpectancy | string | duration |\r\n| minimumLevel | StockItem->MinimumLevel | number | decimal |\r\n| notes | StockItem->Notes | string | |\r\n| quantityOnHand | StockItem->QuantityOnHand | number | decimal |\r\n| replaceByDate | StockItem->ReplaceByDate | string | date-time |\r\n| replacedOnDate | StockItem->ReplacedOnDate | string | date-time |\r\n| replaceWithStockItemId | StockItem->ReplaceWithStockItem_Id | integer | int64 |\r\n| replaceWithStockItemMaterialMasterId | StockItem->ReplaceWithStockItem_MaterialMaster_Id | integer | int64 |\r\n| replaceWithStockItemMaterialMasterCode | StockItem->ReplaceWithStockItem_MaterialMaster_Code | string | |\r\n| replaceWithStockItemMaterialMasterDescription | StockItem->ReplaceWithStockItem_MaterialMaster_Description | string | |\r\n| replaceWithStockItemWarehouseId | StockItem->ReplaceWithStockItem_Warehouse_Id | integer | int64 |\r\n| replaceWithStockItemWarehouseCode | StockItem->ReplaceWithStockItem_Warehouse_Code | string | |\r\n| replaceWithStockItemWarehouseDescription | StockItem->ReplaceWithStockItem_Warehouse_Description | string | |\r\n| sequenceNumber | StockItem->SequenceNumber | integer | int32 |\r\n| unitOfMeasurementId | StockItem->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | StockItem->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | StockItem->UnitOfMeasurement_Description | string | |\r\n| warehouseId | StockItem->Warehouse_Id | integer | int64 |\r\n| warehouseCode | StockItem->Warehouse_Code | string | |\r\n| warehouseDescription | StockItem->Warehouse_Description | string | |\r\n| warehouseSiteId | StockItem->Warehouse_Site_Id | integer | int64 |\r\n| warehouseSiteCode | StockItem->Warehouse_Site_Code | string | |\r\n| warehouseSiteDescription | StockItem->Warehouse_Site_Description | string | |\r\n", "operationId": "GetStockItem", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Stock Item", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetStockItemResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Stock Item" ], "summary": "Update an existing Stock Item resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | StockItem->Version | integer | int32 |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| barcode | StockItem->Barcode | string | |\r\n| categoryId | StockItem->Category_Id | integer | int64 |\r\n| classification | StockItem->Classification | string | |\r\n| costElementId | StockItem->CostElement_Id | integer | int64 |\r\n| defaultStockItemBinId | StockItem->DefaultStockItemBin_Id | integer | int64 |\r\n| defaultStockItemSupplierId | StockItem->DefaultStockItemSupplier_Id | integer | int64 |\r\n| highLifeExpectancy | StockItem->HighLifeExpectancy | string | duration |\r\n| itemSize | StockItem->ItemSize | string | |\r\n| isInsuranceItem | StockItem->IsInsuranceItem | boolean | |\r\n| isStockItem | StockItem->IsStockItem | boolean | |\r\n| leadTime | StockItem->LeadTime | string | duration |\r\n| lowLifeExpectancy | StockItem->LowLifeExpectancy | string | duration |\r\n| maximumLevel | StockItem->MaximumLevel | number | decimal |\r\n| mediumLifeExpectancy | StockItem->MediumLifeExpectancy | string | duration |\r\n| minimumLevel | StockItem->MinimumLevel | number | decimal |\r\n| notes | StockItem->Notes | string | |\r\n| quantityOnHand | StockItem->QuantityOnHand | number | decimal |\r\n| sequenceNumber | StockItem->SequenceNumber | integer | int32 |\r\n| unitOfMeasurementId | StockItem->UnitOfMeasurement_Id | integer | int64 |\r\n| replaceWithStockItemId | StockItem->ReplaceWithStockItem_Id | integer | int64 |\r\n| replaceByDate | StockItem->ReplaceByDate | string | date-time |\r\n| replacedOnDate | StockItem->ReplacedOnDate | string | date-time |\r\n| averageItemCost | StockItem->AverageItemCost | 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| barcode | Min Length | >= 1 chars| |\r\n| barcode | Max Length | <= 50 chars| |\r\n| classification | Min Length | >= 1 chars| |\r\n| classification | Max Length | <= 50 chars| |\r\n| costElementId | Nullable | False | |\r\n| highLifeExpectancy | Min Value | >= 00:00:00| |\r\n| itemSize | Min Length | >= 1 chars| |\r\n| itemSize | Max Length | <= 50 chars| |\r\n| isInsuranceItem | Nullable | False | |\r\n| isStockItem | Nullable | False | |\r\n| leadTime | Min Value | >= 00:00:00| |\r\n| lowLifeExpectancy | Min Value | >= 00:00:00| |\r\n| maximumLevel | Min Value | >= 0| |\r\n| minimumLevel | Min Value | >= 0| |\r\n| notes | Min Length | >= 1 chars| |\r\n| quantityOnHand | Min Value | >= 0| |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "UpdateStockItem", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateStockItemResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Stock Item was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Stock Item" ], "summary": "Delete an existing Stock Item resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | StockItem->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": "DeleteStockItem", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteStockItemResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Stock Item was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems": { "get": { "tags": [ "Stock Item" ], "summary": "Get a collection of Stock Item 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 | StockItem->Id | integer | int64 |\r\n| version | StockItem->Version | integer | int32 |\r\n| materialMasterId | StockItem->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| materialMasterDescription | StockItem->MaterialMaster_Description | string | |\r\n| materialMasterCommodityId | StockItem->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | StockItem->MaterialMaster_Commodity_Code | string | |\r\n| warehouseId | StockItem->Warehouse_Id | integer | int64 |\r\n| warehouseCode | StockItem->Warehouse_Code | string | |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| averageItemCost | StockItem->AverageItemCost | number | decimal |\r\n| quantityOnHand | StockItem->QuantityOnHand | number | decimal |\r\n| unitOfMeasurementId | StockItem->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | StockItem->UnitOfMeasurement_Code | string | |\r\n| categoryId | StockItem->Category_Id | integer | int64 |\r\n| categoryCode | StockItem->Category_Code | string | |\r\n| costElementId | StockItem->CostElement_Id | integer | int64 |\r\n| costElementCode | StockItem->CostElement_Code | string | |\r\n| defaultStockItemBinId | StockItem->DefaultStockItemBin_Id | integer | int64 |\r\n| defaultStockItemBinCode | StockItem->DefaultStockItemBin_Code | string | |\r\n| defaultStockItemSupplierId | StockItem->DefaultStockItemSupplier_Id | integer | int64 |\r\n| defaultStockItemSupplierSupplierCode | StockItem->DefaultStockItemSupplier_Supplier_Code | string | |\r\n| defaultStockItemSupplierSupplierDescription | StockItem->DefaultStockItemSupplier_Supplier_Description | string | |\r\n| replaceWithStockItemMaterialMasterCode | StockItem->ReplaceWithStockItem_MaterialMaster_Code | string | |\r\n| replaceWithStockItemMaterialMasterDescription | StockItem->ReplaceWithStockItem_MaterialMaster_Description | string | |\r\n| replaceWithStockItemWarehouseCode | StockItem->ReplaceWithStockItem_Warehouse_Code | string | |\r\n", "operationId": "GetStockItemCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Stock Item collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetStockItemCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Stock Item" ], "summary": "Create a new Stock Item resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| warehouseId | StockItem->Warehouse_Id | integer | int64 |\r\n| materialMasterId | StockItem->MaterialMaster_Id | integer | int64 |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| barcode | StockItem->Barcode | string | |\r\n| categoryId | StockItem->Category_Id | integer | int64 |\r\n| classification | StockItem->Classification | string | |\r\n| costElementId | StockItem->CostElement_Id | integer | int64 |\r\n| highLifeExpectancy | StockItem->HighLifeExpectancy | string | duration |\r\n| itemSize | StockItem->ItemSize | string | |\r\n| isInsuranceItem | StockItem->IsInsuranceItem | boolean | |\r\n| isStockItem | StockItem->IsStockItem | boolean | |\r\n| leadTime | StockItem->LeadTime | string | duration |\r\n| lowLifeExpectancy | StockItem->LowLifeExpectancy | string | duration |\r\n| maximumLevel | StockItem->MaximumLevel | number | decimal |\r\n| mediumLifeExpectancy | StockItem->MediumLifeExpectancy | string | duration |\r\n| minimumLevel | StockItem->MinimumLevel | number | decimal |\r\n| notes | StockItem->Notes | string | |\r\n| permissionTreeId | StockItem->PermissionTree_Id | integer | int64 |\r\n| quantityOnHand | StockItem->QuantityOnHand | number | decimal |\r\n| sequenceNumber | StockItem->SequenceNumber | integer | int32 |\r\n| unitOfMeasurementId | StockItem->UnitOfMeasurement_Id | integer | int64 |\r\n| replaceWithStockItemId | StockItem->ReplaceWithStockItem_Id | integer | int64 |\r\n| replaceByDate | StockItem->ReplaceByDate | string | date-time |\r\n| replacedOnDate | StockItem->ReplacedOnDate | string | date-time |\r\n| averageItemCost | StockItem->AverageItemCost | 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| warehouseId | Required | True | |\r\n| warehouseId | Nullable | False | |\r\n| materialMasterId | Required | True | |\r\n| materialMasterId | Nullable | False | |\r\n| barcode | Min Length | >= 1 chars| |\r\n| barcode | Max Length | <= 50 chars| |\r\n| classification | Min Length | >= 1 chars| |\r\n| classification | Max Length | <= 50 chars| |\r\n| costElementId | Required | True | |\r\n| costElementId | Nullable | False | |\r\n| highLifeExpectancy | Min Value | >= 00:00:00| |\r\n| itemSize | Min Length | >= 1 chars| |\r\n| itemSize | Max Length | <= 50 chars| |\r\n| isInsuranceItem | Required | True | |\r\n| isInsuranceItem | Nullable | False | |\r\n| isStockItem | Required | True | |\r\n| isStockItem | Nullable | False | |\r\n| leadTime | Min Value | >= 00:00:00| |\r\n| lowLifeExpectancy | Min Value | >= 00:00:00| |\r\n| maximumLevel | Min Value | >= 0| |\r\n| minimumLevel | Min Value | >= 0| |\r\n| notes | Min Length | >= 1 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| quantityOnHand | Min Value | >= 0| |\r\n| unitOfMeasurementId | Required | True | |\r\n| unitOfMeasurementId | Nullable | False | |\r\n| averageItemCost | Required | True | |\r\n| averageItemCost | Nullable | False | |\r\n\r\n", "operationId": "CreateStockItem", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateStockItemResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Lookups/LookupStockItemCategory": { "get": { "tags": [ "Stock Item" ], "summary": "Lookup the Category for the Stock Item.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Category->Id | integer | int64 |\r\n| code | Category->Code | string | |\r\n| description | Category->Description | string | |\r\n", "operationId": "LookupStockItemCategory", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Category collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemCategoryLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Lookups/LookupStockItemChangePermissionTree": { "get": { "tags": [ "Stock Item" ], "summary": "Lookup the permission set for changing the Stock Item.", "description": "### Response Body\r\n#### Payload\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": "LookupStockItemChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Lookups/LookupStockItemCostElement": { "get": { "tags": [ "Stock Item" ], "summary": "Lookup the Cost Element for the Stock Item.", "description": "### Response Body\r\n#### Payload\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": "LookupStockItemCostElement", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Cost Element collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemCostElementLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Lookups/LookupStockItemDefaultBin": { "get": { "tags": [ "Stock Item" ], "summary": "Lookup the Stock Item Bin for the Stock Item.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItemBin->Id | integer | int64 |\r\n| code | StockItemBin->Code | string | |\r\n", "operationId": "LookupStockItemDefaultBin", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Stock Item Bin collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemDefaultBinLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Lookups/LookupStockItemDefaultSupplier": { "get": { "tags": [ "Stock Item" ], "summary": "Lookup the Stock Item Supplier for the Stock Item.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItemSupplier->Id | integer | int64 |\r\n| supplierCode | StockItemSupplier->Supplier_Code | string | |\r\n| supplierDescription | StockItemSupplier->Supplier_Description | string | |\r\n", "operationId": "LookupStockItemDefaultSupplier", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Stock Item Supplier collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemDefaultSupplierLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Lookups/LookupStockItemInsertPermissionTree": { "get": { "tags": [ "Stock Item" ], "summary": "Lookup the permission set for creating the Stock Item.", "description": "### Response Body\r\n#### Payload\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": "LookupStockItemInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Lookups/LookupStockItemMaterialMaster": { "get": { "tags": [ "Stock Item" ], "summary": "Lookup the Material Master for the Stock Item.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MaterialMaster->Id | integer | int64 |\r\n| code | MaterialMaster->Code | string | |\r\n| description | MaterialMaster->Description | string | |\r\n| alternativeDescription | MaterialMaster->AlternativeDescription | string | |\r\n| barcode | MaterialMaster->Barcode | string | |\r\n| isStockItem | MaterialMaster->IsStockItem | boolean | |\r\n| isInsuranceItem | MaterialMaster->IsInsuranceItem | boolean | |\r\n| itemSize | MaterialMaster->ItemSize | string | |\r\n| leadTime | MaterialMaster->LeadTime | string | duration |\r\n| lowLifeExpectancy | MaterialMaster->LowLifeExpectancy | string | duration |\r\n| mediumLifeExpectancy | MaterialMaster->MediumLifeExpectancy | string | duration |\r\n| highLifeExpectancy | MaterialMaster->HighLifeExpectancy | string | duration |\r\n| minimumLevel | MaterialMaster->MinimumLevel | number | float |\r\n| maximumLevel | MaterialMaster->MaximumLevel | number | float |\r\n| categoryId | MaterialMaster->Category_Id | integer | int64 |\r\n| categoryCode | MaterialMaster->Category_Code | string | |\r\n| categoryDescription | MaterialMaster->Category_Description | string | |\r\n| commodityId | MaterialMaster->Commodity_Id | integer | int64 |\r\n| commodityCode | MaterialMaster->Commodity_Code | string | |\r\n| commodityDescription | MaterialMaster->Commodity_Description | string | |\r\n| classification | MaterialMaster->Classification | string | |\r\n| costElementId | MaterialMaster->CostElement_Id | integer | int64 |\r\n| costElementCode | MaterialMaster->CostElement_Code | string | |\r\n| costElementDescription | MaterialMaster->CostElement_Description | string | |\r\n| notes | MaterialMaster->Notes | string | |\r\n| sequenceNumber | MaterialMaster->SequenceNumber | integer | int32 |\r\n| unitOfMeasurementId | MaterialMaster->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | MaterialMaster->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | MaterialMaster->UnitOfMeasurement_Description | string | |\r\n", "operationId": "LookupStockItemMaterialMaster", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Material Master collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemMaterialMasterLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Lookups/LookupStockItemReplaceWithStockItem": { "get": { "tags": [ "Stock Item" ], "summary": "Lookup the Stock Item for the Stock Item.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItem->Id | integer | int64 |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| warehouseId | StockItem->Warehouse_Id | integer | int64 |\r\n| warehouseCode | StockItem->Warehouse_Code | string | |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| materialMasterDescription | StockItem->MaterialMaster_Description | string | |\r\n", "operationId": "LookupStockItemReplaceWithStockItem", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Stock Item collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemWithReplaceWithStockItemLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Lookups/LookupStockItemUnitOfMeasurement": { "get": { "tags": [ "Stock Item" ], "summary": "Lookup the Unit Of Measurement for the Stock Item.", "description": "### Response Body\r\n#### Payload\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": "LookupStockItemUnitOfMeasurement", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Unit Of Measurement collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemUnitOfMeasurementLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Lookups/LookupStockItemWarehouse": { "get": { "tags": [ "Stock Item" ], "summary": "Lookup the Warehouse for the Stock Item.", "description": "### Response Body\r\n#### Payload\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": "LookupStockItemWarehouse", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Warehouse collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemWarehouseLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Batch/{ids}": { "get": { "tags": [ "Stock Item" ], "summary": "Get a collection of Stock Item 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 | StockItem->IsActive | boolean | |\r\n| createdByUserId | StockItem->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | StockItem->CreatedByUser_Code | string | |\r\n| createdByUserFullName | StockItem->CreatedByUser_FullName | string | |\r\n| createdOn | StockItem->CreatedOn | string | date-time |\r\n| modifiedByUserId | StockItem->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | StockItem->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | StockItem->ModifiedByUser_FullName | string | |\r\n| modifiedOn | StockItem->ModifiedOn | string | date-time |\r\n| version | StockItem->Version | integer | int32 |\r\n| permissionTreeId | StockItem->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StockItem->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StockItem->PermissionTree_Description | string | |\r\n| id | StockItem->Id | integer | int64 |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| averageItemCost | StockItem->AverageItemCost | number | decimal |\r\n| barcode | StockItem->Barcode | string | |\r\n| categoryId | StockItem->Category_Id | integer | int64 |\r\n| categoryCode | StockItem->Category_Code | string | |\r\n| categoryDescription | StockItem->Category_Description | string | |\r\n| classification | StockItem->Classification | string | |\r\n| costElementId | StockItem->CostElement_Id | integer | int64 |\r\n| costElementCode | StockItem->CostElement_Code | string | |\r\n| costElementDescription | StockItem->CostElement_Description | string | |\r\n| defaultStockItemBinId | StockItem->DefaultStockItemBin_Id | integer | int64 |\r\n| defaultStockItemBinCode | StockItem->DefaultStockItemBin_Code | string | |\r\n| defaultStockItemSupplierId | StockItem->DefaultStockItemSupplier_Id | integer | int64 |\r\n| defaultStockItemSupplierSupplierId | StockItem->DefaultStockItemSupplier_Supplier_Id | integer | int64 |\r\n| defaultStockItemSupplierSupplierCode | StockItem->DefaultStockItemSupplier_Supplier_Code | string | |\r\n| defaultStockItemSupplierSupplierDescription | StockItem->DefaultStockItemSupplier_Supplier_Description | string | |\r\n| highLifeExpectancy | StockItem->HighLifeExpectancy | string | duration |\r\n| isInsuranceItem | StockItem->IsInsuranceItem | boolean | |\r\n| isStockItem | StockItem->IsStockItem | boolean | |\r\n| itemSize | StockItem->ItemSize | string | |\r\n| leadTime | StockItem->LeadTime | string | duration |\r\n| lowLifeExpectancy | StockItem->LowLifeExpectancy | string | duration |\r\n| materialMasterId | StockItem->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| materialMasterDescription | StockItem->MaterialMaster_Description | string | |\r\n| materialMasterCommodityId | StockItem->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | StockItem->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | StockItem->MaterialMaster_Commodity_Description | string | |\r\n| maximumLevel | StockItem->MaximumLevel | number | decimal |\r\n| mediumLifeExpectancy | StockItem->MediumLifeExpectancy | string | duration |\r\n| minimumLevel | StockItem->MinimumLevel | number | decimal |\r\n| notes | StockItem->Notes | string | |\r\n| quantityOnHand | StockItem->QuantityOnHand | number | decimal |\r\n| replaceByDate | StockItem->ReplaceByDate | string | date-time |\r\n| replacedOnDate | StockItem->ReplacedOnDate | string | date-time |\r\n| replaceWithStockItemId | StockItem->ReplaceWithStockItem_Id | integer | int64 |\r\n| replaceWithStockItemMaterialMasterId | StockItem->ReplaceWithStockItem_MaterialMaster_Id | integer | int64 |\r\n| replaceWithStockItemMaterialMasterCode | StockItem->ReplaceWithStockItem_MaterialMaster_Code | string | |\r\n| replaceWithStockItemMaterialMasterDescription | StockItem->ReplaceWithStockItem_MaterialMaster_Description | string | |\r\n| replaceWithStockItemWarehouseId | StockItem->ReplaceWithStockItem_Warehouse_Id | integer | int64 |\r\n| replaceWithStockItemWarehouseCode | StockItem->ReplaceWithStockItem_Warehouse_Code | string | |\r\n| replaceWithStockItemWarehouseDescription | StockItem->ReplaceWithStockItem_Warehouse_Description | string | |\r\n| sequenceNumber | StockItem->SequenceNumber | integer | int32 |\r\n| unitOfMeasurementId | StockItem->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | StockItem->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | StockItem->UnitOfMeasurement_Description | string | |\r\n| warehouseId | StockItem->Warehouse_Id | integer | int64 |\r\n| warehouseCode | StockItem->Warehouse_Code | string | |\r\n| warehouseDescription | StockItem->Warehouse_Description | string | |\r\n| warehouseSiteId | StockItem->Warehouse_Site_Id | integer | int64 |\r\n| warehouseSiteCode | StockItem->Warehouse_Site_Code | string | |\r\n| warehouseSiteDescription | StockItem->Warehouse_Site_Description | string | |\r\n", "operationId": "BatchGetStockItem", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Stock Item id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Stock Item collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetStockItemResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Batch": { "post": { "tags": [ "Stock Item" ], "summary": "Create a new collection of Stock Item resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| warehouseId | StockItem->Warehouse_Id | integer | int64 |\r\n| materialMasterId | StockItem->MaterialMaster_Id | integer | int64 |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| barcode | StockItem->Barcode | string | |\r\n| categoryId | StockItem->Category_Id | integer | int64 |\r\n| classification | StockItem->Classification | string | |\r\n| costElementId | StockItem->CostElement_Id | integer | int64 |\r\n| highLifeExpectancy | StockItem->HighLifeExpectancy | string | duration |\r\n| itemSize | StockItem->ItemSize | string | |\r\n| isInsuranceItem | StockItem->IsInsuranceItem | boolean | |\r\n| isStockItem | StockItem->IsStockItem | boolean | |\r\n| leadTime | StockItem->LeadTime | string | duration |\r\n| lowLifeExpectancy | StockItem->LowLifeExpectancy | string | duration |\r\n| maximumLevel | StockItem->MaximumLevel | number | decimal |\r\n| mediumLifeExpectancy | StockItem->MediumLifeExpectancy | string | duration |\r\n| minimumLevel | StockItem->MinimumLevel | number | decimal |\r\n| notes | StockItem->Notes | string | |\r\n| permissionTreeId | StockItem->PermissionTree_Id | integer | int64 |\r\n| quantityOnHand | StockItem->QuantityOnHand | number | decimal |\r\n| sequenceNumber | StockItem->SequenceNumber | integer | int32 |\r\n| unitOfMeasurementId | StockItem->UnitOfMeasurement_Id | integer | int64 |\r\n| replaceWithStockItemId | StockItem->ReplaceWithStockItem_Id | integer | int64 |\r\n| replaceByDate | StockItem->ReplaceByDate | string | date-time |\r\n| replacedOnDate | StockItem->ReplacedOnDate | string | date-time |\r\n| averageItemCost | StockItem->AverageItemCost | 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| warehouseId | Required | True | |\r\n| warehouseId | Nullable | False | |\r\n| materialMasterId | Required | True | |\r\n| materialMasterId | Nullable | False | |\r\n| barcode | Min Length | >= 1 chars| |\r\n| barcode | Max Length | <= 50 chars| |\r\n| classification | Min Length | >= 1 chars| |\r\n| classification | Max Length | <= 50 chars| |\r\n| costElementId | Required | True | |\r\n| costElementId | Nullable | False | |\r\n| highLifeExpectancy | Min Value | >= 00:00:00| |\r\n| itemSize | Min Length | >= 1 chars| |\r\n| itemSize | Max Length | <= 50 chars| |\r\n| isInsuranceItem | Required | True | |\r\n| isInsuranceItem | Nullable | False | |\r\n| isStockItem | Required | True | |\r\n| isStockItem | Nullable | False | |\r\n| leadTime | Min Value | >= 00:00:00| |\r\n| lowLifeExpectancy | Min Value | >= 00:00:00| |\r\n| maximumLevel | Min Value | >= 0| |\r\n| minimumLevel | Min Value | >= 0| |\r\n| notes | Min Length | >= 1 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| quantityOnHand | Min Value | >= 0| |\r\n| unitOfMeasurementId | Required | True | |\r\n| unitOfMeasurementId | Nullable | False | |\r\n| averageItemCost | Required | True | |\r\n| averageItemCost | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateStockItem", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateStockItemResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Stock Item batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Stock Item" ], "summary": "Update a collection of existing Stock Item resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItem->Id | integer | int64 |\r\n| version | StockItem->Version | integer | int32 |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| barcode | StockItem->Barcode | string | |\r\n| categoryId | StockItem->Category_Id | integer | int64 |\r\n| classification | StockItem->Classification | string | |\r\n| costElementId | StockItem->CostElement_Id | integer | int64 |\r\n| defaultStockItemBinId | StockItem->DefaultStockItemBin_Id | integer | int64 |\r\n| defaultStockItemSupplierId | StockItem->DefaultStockItemSupplier_Id | integer | int64 |\r\n| highLifeExpectancy | StockItem->HighLifeExpectancy | string | duration |\r\n| itemSize | StockItem->ItemSize | string | |\r\n| isInsuranceItem | StockItem->IsInsuranceItem | boolean | |\r\n| isStockItem | StockItem->IsStockItem | boolean | |\r\n| leadTime | StockItem->LeadTime | string | duration |\r\n| lowLifeExpectancy | StockItem->LowLifeExpectancy | string | duration |\r\n| maximumLevel | StockItem->MaximumLevel | number | decimal |\r\n| mediumLifeExpectancy | StockItem->MediumLifeExpectancy | string | duration |\r\n| minimumLevel | StockItem->MinimumLevel | number | decimal |\r\n| notes | StockItem->Notes | string | |\r\n| quantityOnHand | StockItem->QuantityOnHand | number | decimal |\r\n| sequenceNumber | StockItem->SequenceNumber | integer | int32 |\r\n| unitOfMeasurementId | StockItem->UnitOfMeasurement_Id | integer | int64 |\r\n| replaceWithStockItemId | StockItem->ReplaceWithStockItem_Id | integer | int64 |\r\n| replaceByDate | StockItem->ReplaceByDate | string | date-time |\r\n| replacedOnDate | StockItem->ReplacedOnDate | string | date-time |\r\n| averageItemCost | StockItem->AverageItemCost | 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| barcode | Min Length | >= 1 chars| |\r\n| barcode | Max Length | <= 50 chars| |\r\n| classification | Min Length | >= 1 chars| |\r\n| classification | Max Length | <= 50 chars| |\r\n| costElementId | Nullable | False | |\r\n| highLifeExpectancy | Min Value | >= 00:00:00| |\r\n| itemSize | Min Length | >= 1 chars| |\r\n| itemSize | Max Length | <= 50 chars| |\r\n| isInsuranceItem | Nullable | False | |\r\n| isStockItem | Nullable | False | |\r\n| leadTime | Min Value | >= 00:00:00| |\r\n| lowLifeExpectancy | Min Value | >= 00:00:00| |\r\n| maximumLevel | Min Value | >= 0| |\r\n| minimumLevel | Min Value | >= 0| |\r\n| notes | Min Length | >= 1 chars| |\r\n| quantityOnHand | Min Value | >= 0| |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateStockItem", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateStockItemResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Stock Item batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Stock Item" ], "summary": "Delete a collection of existing Stock Item resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItem->Id | integer | int64 |\r\n| version | StockItem->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": "BatchDeleteStockItem", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteStockItemResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Stock Item batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/{id}/Active": { "patch": { "tags": [ "Stock Item" ], "summary": "Change the IsActive status for an existing Stock Item resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | StockItem->Version | integer | int32 |\r\n| isActive | StockItem->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": "ChangeStockItemIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeStockItemIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/{id}/PermissionTree": { "patch": { "tags": [ "Stock Item" ], "summary": "Change the PermissionTree for an existing Stock Item resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | StockItem->Version | integer | int32 |\r\n| permissionTreeId | StockItem->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": "ChangeStockItemPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeStockItemPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Batch/Active": { "patch": { "tags": [ "Stock Item" ], "summary": "Change the IsActive status for a collection of existing Stock Item resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItem->Id | integer | int64 |\r\n| version | StockItem->Version | integer | int32 |\r\n| isActive | StockItem->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": "BatchChangeStockItemIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeStockItemIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Batch/PermissionTree": { "patch": { "tags": [ "Stock Item" ], "summary": "Change the PermissionTree status for a collection of existing Stock Item resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItem->Id | integer | int64 |\r\n| version | StockItem->Version | integer | int32 |\r\n| permissionTreeId | StockItem->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": "BatchChangeStockItemPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeStockItemPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/MatchBatch": { "patch": { "tags": [ "Stock Item" ], "summary": "Update a collection of existing Stock Item 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 | StockItem->Id | integer | int64 |\r\n| version | StockItem->Version | integer | int32 |\r\n| categoryId | StockItem->Category_Id | integer | int64 |\r\n| classification | StockItem->Classification | string | |\r\n| costElementId | StockItem->CostElement_Id | integer | int64 |\r\n| minimumLevel | StockItem->MinimumLevel | number | decimal |\r\n| maximumLevel | StockItem->MaximumLevel | 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| classification | Min Length | >= 1 chars| |\r\n| classification | Max Length | <= 50 chars| |\r\n| costElementId | Nullable | False | |\r\n| minimumLevel | Min Value | >= 0| |\r\n| maximumLevel | Min Value | >= 0| |\r\n\r\n", "operationId": "MatchUpdateStockItem", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "matchUpdate", "description": "Request Body content", "content": { "application/vnd.onkey.entitymatchupdatecollection+json": { "schema": { "$ref": "#/components/schemas/MatchUpdateStockItemResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Stock Item batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Attributes/{id}": { "get": { "tags": [ "Stock Item Attribute" ], "summary": "Get a collection of Stock Item Attribute resources for the Stock Item.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| stockItemId | StockItemAttribute->StockItem_Id | integer | int64 |\r\n| stockItemMaterialMasterId | StockItemAttribute->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | StockItemAttribute->StockItem_MaterialMaster_Code | string | |\r\n| stockItemMaterialMasterDescription | StockItemAttribute->StockItem_MaterialMaster_Description | string | |\r\n| createdByUserId | StockItemAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | StockItemAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | StockItemAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | StockItemAttribute->CreatedOn | string | date-time |\r\n| isActive | StockItemAttribute->IsActive | boolean | |\r\n| modifiedByUserId | StockItemAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | StockItemAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | StockItemAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | StockItemAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | StockItemAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StockItemAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StockItemAttribute->PermissionTree_Description | string | |\r\n| version | StockItemAttribute->Version | integer | int32 |\r\n| id | StockItemAttribute->Id | integer | int64 |\r\n| attributeId | StockItemAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | StockItemAttribute->Attribute_Code | string | |\r\n| attributeDescription | StockItemAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | StockItemAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | StockItemAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | StockItemAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | StockItemAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | StockItemAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | StockItemAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | StockItemAttribute->Notes | string | |\r\n| predefinedValueId | StockItemAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | StockItemAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | StockItemAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | StockItemAttribute->SequenceNumber | integer | int32 |\r\n| value | StockItemAttribute->Value | object | composite |\r\n", "operationId": "GetStockItemAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Stock Item Attribute", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetStockItemAttributeResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Stock Item Attribute" ], "summary": "Update an existing Stock Item 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 | StockItemAttribute->Version | integer | int32 |\r\n| value | StockItemAttribute->Value | object | composite |\r\n| predefinedValueId | StockItemAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | StockItemAttribute->SequenceNumber | integer | int32 |\r\n| notes | StockItemAttribute->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": "UpdateStockItemAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateStockItemAttributeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Stock Item Attribute was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Stock Item Attribute" ], "summary": "Delete an existing Stock Item 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 | StockItemAttribute->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": "DeleteStockItemAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteStockItemAttributeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Stock Item Attribute was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/{stockItemId}/Attributes": { "get": { "tags": [ "Stock Item Attribute" ], "summary": "Get a collection of Stock Item Attribute resources for the Stock Item.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItemAttribute->Id | integer | int64 |\r\n| version | StockItemAttribute->Version | integer | int32 |\r\n| sequenceNumber | StockItemAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | StockItemAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | StockItemAttribute->Attribute_Code | string | |\r\n| attributeDescription | StockItemAttribute->Attribute_Description | string | |\r\n| attributeDataType | StockItemAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | StockItemAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | StockItemAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | StockItemAttribute->PredefinedValue_Value | object | composite |\r\n| value | StockItemAttribute->Value | object | composite |\r\n| notes | StockItemAttribute->Notes | string | |\r\n| createdOn | StockItemAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | StockItemAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetStockItemAttributeCollectionForStockItem", "parameters": [ { "name": "stockItemId", "in": "path", "required": true, "description": "Stock Item Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Stock Item Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetStockItemAttributeCollectionForStockItemResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Attributes": { "get": { "tags": [ "Stock Item Attribute" ], "summary": "Get a collection of Stock Item 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 | StockItemAttribute->Id | integer | int64 |\r\n| version | StockItemAttribute->Version | integer | int32 |\r\n| sequenceNumber | StockItemAttribute->SequenceNumber | integer | int32 |\r\n| stockItemBarcode | StockItemAttribute->StockItem_Barcode | string | |\r\n| stockItemMaterialMasterCode | StockItemAttribute->StockItem_MaterialMaster_Code | string | |\r\n| stockItemMaterialMasterDescription | StockItemAttribute->StockItem_MaterialMaster_Description | string | |\r\n| attributeId | StockItemAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | StockItemAttribute->Attribute_Code | string | |\r\n| attributeDescription | StockItemAttribute->Attribute_Description | string | |\r\n| attributeDataType | StockItemAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | StockItemAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | StockItemAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | StockItemAttribute->PredefinedValue_Value | object | composite |\r\n| value | StockItemAttribute->Value | object | composite |\r\n| notes | StockItemAttribute->Notes | string | |\r\n| createdOn | StockItemAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | StockItemAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetStockItemAttributeCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Stock Item Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetStockItemAttributeCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Stock Item Attribute" ], "summary": "Create a new Stock Item 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| stockItemId | StockItemAttribute->StockItem_Id | integer | int64 |\r\n| attributeId | StockItemAttribute->Attribute_Id | integer | int64 |\r\n| value | StockItemAttribute->Value | object | composite |\r\n| predefinedValueId | StockItemAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | StockItemAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | StockItemAttribute->SequenceNumber | integer | int32 |\r\n| notes | StockItemAttribute->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| stockItemId | Required | True | |\r\n| stockItemId | 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": "CreateStockItemAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateStockItemAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Attributes/Lookups/LookupStockItemAttributeAllowedValue": { "get": { "tags": [ "Stock Item Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Stock Item 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": "LookupStockItemAttributeAllowedValue", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Attribute Allowed Value collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemAttributeAttributeAllowedValueLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Attributes/Lookups/LookupStockItemAttribute": { "get": { "tags": [ "Stock Item Attribute" ], "summary": "Lookup the Attribute for the Stock Item 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": "LookupStockItemAttribute", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemAttributeAttributeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Attributes/Lookups/LookupStockItemAttributeChangePermissionTree": { "get": { "tags": [ "Stock Item Attribute" ], "summary": "Lookup the permission set for changing the Stock Item 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": "LookupStockItemAttributeChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemAttributeChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Attributes/Lookups/LookupStockItemAttributeInsertPermissionTree": { "get": { "tags": [ "Stock Item Attribute" ], "summary": "Lookup the permission set for creating the Stock Item 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": "LookupStockItemAttributeInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemAttributeInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Attributes/Lookups/LookupStockItemAttributeStockItem": { "get": { "tags": [ "Stock Item Attribute" ], "summary": "Lookup the Stock Item Attribute for the Stock Item 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 | StockItem->Id | integer | int64 |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| materialMasterDescription | StockItem->MaterialMaster_Description | string | |\r\n", "operationId": "LookupStockItemAttributeStockItem", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Stock Item collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemAttributeStockItemLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Attributes/Batch/{ids}": { "get": { "tags": [ "Stock Item Attribute" ], "summary": "Get a collection of Stock Item 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| stockItemId | StockItemAttribute->StockItem_Id | integer | int64 |\r\n| stockItemMaterialMasterId | StockItemAttribute->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | StockItemAttribute->StockItem_MaterialMaster_Code | string | |\r\n| stockItemMaterialMasterDescription | StockItemAttribute->StockItem_MaterialMaster_Description | string | |\r\n| createdByUserId | StockItemAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | StockItemAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | StockItemAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | StockItemAttribute->CreatedOn | string | date-time |\r\n| isActive | StockItemAttribute->IsActive | boolean | |\r\n| modifiedByUserId | StockItemAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | StockItemAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | StockItemAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | StockItemAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | StockItemAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StockItemAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StockItemAttribute->PermissionTree_Description | string | |\r\n| version | StockItemAttribute->Version | integer | int32 |\r\n| id | StockItemAttribute->Id | integer | int64 |\r\n| attributeId | StockItemAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | StockItemAttribute->Attribute_Code | string | |\r\n| attributeDescription | StockItemAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | StockItemAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | StockItemAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | StockItemAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | StockItemAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | StockItemAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | StockItemAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | StockItemAttribute->Notes | string | |\r\n| predefinedValueId | StockItemAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | StockItemAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | StockItemAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | StockItemAttribute->SequenceNumber | integer | int32 |\r\n| value | StockItemAttribute->Value | object | composite |\r\n", "operationId": "BatchGetStockItemAttribute", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Stock Item Attribute id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Stock Item Attribute collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetStockItemAttributeResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Attributes/Batch": { "post": { "tags": [ "Stock Item Attribute" ], "summary": "Create a new collection of Stock Item 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| stockItemId | StockItemAttribute->StockItem_Id | integer | int64 |\r\n| attributeId | StockItemAttribute->Attribute_Id | integer | int64 |\r\n| value | StockItemAttribute->Value | object | composite |\r\n| predefinedValueId | StockItemAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | StockItemAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | StockItemAttribute->SequenceNumber | integer | int32 |\r\n| notes | StockItemAttribute->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| stockItemId | Required | True | |\r\n| stockItemId | 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": "BatchCreateStockItemAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateStockItemAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Stock Item Attribute batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Stock Item Attribute" ], "summary": "Update a collection of existing Stock Item 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 | StockItemAttribute->Id | integer | int64 |\r\n| version | StockItemAttribute->Version | integer | int32 |\r\n| value | StockItemAttribute->Value | object | composite |\r\n| predefinedValueId | StockItemAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | StockItemAttribute->SequenceNumber | integer | int32 |\r\n| notes | StockItemAttribute->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": "BatchUpdateStockItemAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateStockItemAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Stock Item Attribute batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Stock Item Attribute" ], "summary": "Delete a collection of existing Stock Item 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 | StockItemAttribute->Id | integer | int64 |\r\n| version | StockItemAttribute->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": "BatchDeleteStockItemAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteStockItemAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Stock Item Attribute batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Attributes/{id}/Active": { "patch": { "tags": [ "Stock Item Attribute" ], "summary": "Change the IsActive status for an existing Stock Item 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 | StockItemAttribute->Version | integer | int32 |\r\n| isActive | StockItemAttribute->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": "ChangeStockItemAttributeIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeStockItemAttributeIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Stock Item Attribute" ], "summary": "Change the PermissionTree for an existing Stock Item 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 | StockItemAttribute->Version | integer | int32 |\r\n| permissionTreeId | StockItemAttribute->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": "ChangeStockItemAttributePermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeStockItemAttributePermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Attributes/Batch/Active": { "patch": { "tags": [ "Stock Item Attribute" ], "summary": "Change the IsActive status for a collection of existing Stock Item 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 | StockItemAttribute->Id | integer | int64 |\r\n| version | StockItemAttribute->Version | integer | int32 |\r\n| isActive | StockItemAttribute->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": "BatchChangeStockItemAttributeIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeStockItemAttributeIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Stock Item Attribute" ], "summary": "Change the PermissionTree status for a collection of existing Stock Item 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 | StockItemAttribute->Id | integer | int64 |\r\n| version | StockItemAttribute->Version | integer | int32 |\r\n| permissionTreeId | StockItemAttribute->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": "BatchChangeStockItemAttributePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeStockItemAttributePermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Bins/{id}": { "get": { "tags": [ "Stock Item Bin" ], "summary": "Get a Stock Item Bin 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 | StockItemBin->Code | string | |\r\n| isActive | StockItemBin->IsActive | boolean | |\r\n| createdByUserId | StockItemBin->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | StockItemBin->CreatedByUser_Code | string | |\r\n| createdByUserFullName | StockItemBin->CreatedByUser_FullName | string | |\r\n| createdOn | StockItemBin->CreatedOn | string | date-time |\r\n| modifiedByUserId | StockItemBin->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | StockItemBin->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | StockItemBin->ModifiedByUser_FullName | string | |\r\n| modifiedOn | StockItemBin->ModifiedOn | string | date-time |\r\n| version | StockItemBin->Version | integer | int32 |\r\n| permissionTreeId | StockItemBin->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StockItemBin->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StockItemBin->PermissionTree_Description | string | |\r\n| id | StockItemBin->Id | integer | int64 |\r\n| notes | StockItemBin->Notes | string | |\r\n| sequenceNumber | StockItemBin->SequenceNumber | integer | int32 |\r\n| stockItemId | StockItemBin->StockItem_Id | integer | int64 |\r\n| stockItemMaterialMasterId | StockItemBin->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | StockItemBin->StockItem_MaterialMaster_Code | string | |\r\n| stockItemAlternativeDescription | StockItemBin->StockItem_AlternativeDescription | string | |\r\n", "operationId": "GetStockItemBin", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Bin Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Stock Item Bin", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetStockItemBinResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Stock Item Bin" ], "summary": "Update an existing Stock Item Bin resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | StockItemBin->Version | integer | int32 |\r\n| code | StockItemBin->Code | string | |\r\n| sequenceNumber | StockItemBin->SequenceNumber | integer | int32 |\r\n| notes | StockItemBin->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\r\n", "operationId": "UpdateStockItemBin", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Bin Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateStockItemBinResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Stock Item Bin was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Stock Item Bin" ], "summary": "Delete an existing Stock Item Bin resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | StockItemBin->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": "DeleteStockItemBin", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Bin Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteStockItemBinResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Stock Item Bin was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Bins": { "get": { "tags": [ "Stock Item Bin" ], "summary": "Get a collection of Stock Item Bin 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 | StockItemBin->Id | integer | int64 |\r\n| version | StockItemBin->Version | integer | int32 |\r\n| code | StockItemBin->Code | string | |\r\n| stockItemId | StockItemBin->StockItem_Id | integer | int64 |\r\n| stockItemAlternativeDescription | StockItemBin->StockItem_AlternativeDescription | string | |\r\n| stockItemWarehouseId | StockItemBin->StockItem_Warehouse_Id | integer | int64 |\r\n| stockItemWarehouseCode | StockItemBin->StockItem_Warehouse_Code | string | |\r\n| stockItemMaterialMasterId | StockItemBin->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | StockItemBin->StockItem_MaterialMaster_Code | string | |\r\n| notes | StockItemBin->Notes | string | |\r\n| sequenceNumber | StockItemBin->SequenceNumber | integer | int32 |\r\n| isActive | StockItemBin->IsActive | boolean | |\r\n| createdOn | StockItemBin->CreatedOn | string | date-time |\r\n| modifiedOn | StockItemBin->ModifiedOn | string | date-time |\r\n", "operationId": "GetStockItemBinCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Stock Item Bin collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetStockItemBinCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Stock Item Bin" ], "summary": "Create a new Stock Item Bin resource.", "description": "### Request Body\r\n#### 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 | StockItemBin->Code | string | |\r\n| permissionTreeId | StockItemBin->PermissionTree_Id | integer | int64 |\r\n| stockItemId | StockItemBin->StockItem_Id | integer | int64 |\r\n| sequenceNumber | StockItemBin->SequenceNumber | integer | int32 |\r\n| notes | StockItemBin->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| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| stockItemId | Required | True | |\r\n| stockItemId | Nullable | False | |\r\n\r\n", "operationId": "CreateStockItemBin", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateStockItemBinResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/{stockItemId}/Bins": { "get": { "tags": [ "Stock Item Bin" ], "summary": "Get a collection of Stock Item Bin resources for the Stock Item.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItemBin->Id | integer | int64 |\r\n| version | StockItemBin->Version | integer | int32 |\r\n| code | StockItemBin->Code | string | |\r\n| stockItemId | StockItemBin->StockItem_Id | integer | int64 |\r\n| stockItemAlternativeDescription | StockItemBin->StockItem_AlternativeDescription | string | |\r\n| stockItemWarehouseId | StockItemBin->StockItem_Warehouse_Id | integer | int64 |\r\n| stockItemWarehouseCode | StockItemBin->StockItem_Warehouse_Code | string | |\r\n| stockItemMaterialMasterId | StockItemBin->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | StockItemBin->StockItem_MaterialMaster_Code | string | |\r\n| notes | StockItemBin->Notes | string | |\r\n| sequenceNumber | StockItemBin->SequenceNumber | integer | int32 |\r\n| isActive | StockItemBin->IsActive | boolean | |\r\n| createdOn | StockItemBin->CreatedOn | string | date-time |\r\n| modifiedOn | StockItemBin->ModifiedOn | string | date-time |\r\n", "operationId": "GetStockItemBinForStockItemCollection", "parameters": [ { "name": "stockItemId", "in": "path", "required": true, "description": "Stock Item Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Stock Item Bin collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetStockItemBinForStockItemCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Bins/Lookups/LookupStockItemBinChangePermissionTree": { "get": { "tags": [ "Stock Item Bin" ], "summary": "Lookup the permission set for changing the Stock Item Bin.", "description": "### Response Body\r\n#### Payload\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": "LookupStockItemBinChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemBinChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Bins/Lookups/LookupStockItemBinInsertPermissionTree": { "get": { "tags": [ "Stock Item Bin" ], "summary": "Lookup the permission set for creating the Stock Item Bin.", "description": "### Response Body\r\n#### Payload\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": "LookupStockItemBinInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemBinInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Bins/Lookups/LookupStockItemBinStockItem": { "get": { "tags": [ "Stock Item Bin" ], "summary": "Stock Item Bin", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItem->Id | integer | int64 |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n", "operationId": "LookupStockItemBinStockItem", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Stock Item collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemBinStockItemLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Bins/Batch/{ids}": { "get": { "tags": [ "Stock Item Bin" ], "summary": "Get a collection of Stock Item Bin 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 | StockItemBin->Code | string | |\r\n| isActive | StockItemBin->IsActive | boolean | |\r\n| createdByUserId | StockItemBin->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | StockItemBin->CreatedByUser_Code | string | |\r\n| createdByUserFullName | StockItemBin->CreatedByUser_FullName | string | |\r\n| createdOn | StockItemBin->CreatedOn | string | date-time |\r\n| modifiedByUserId | StockItemBin->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | StockItemBin->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | StockItemBin->ModifiedByUser_FullName | string | |\r\n| modifiedOn | StockItemBin->ModifiedOn | string | date-time |\r\n| version | StockItemBin->Version | integer | int32 |\r\n| permissionTreeId | StockItemBin->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StockItemBin->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StockItemBin->PermissionTree_Description | string | |\r\n| id | StockItemBin->Id | integer | int64 |\r\n| notes | StockItemBin->Notes | string | |\r\n| sequenceNumber | StockItemBin->SequenceNumber | integer | int32 |\r\n| stockItemId | StockItemBin->StockItem_Id | integer | int64 |\r\n| stockItemMaterialMasterId | StockItemBin->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | StockItemBin->StockItem_MaterialMaster_Code | string | |\r\n| stockItemAlternativeDescription | StockItemBin->StockItem_AlternativeDescription | string | |\r\n", "operationId": "BatchGetStockItemBin", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Stock Item Bin id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Stock Item Bin collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetStockItemBinResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Bins/Batch": { "post": { "tags": [ "Stock Item Bin" ], "summary": "Create a new collection of Stock Item Bin resources.", "description": "### Request Body\r\n#### 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 | StockItemBin->Code | string | |\r\n| permissionTreeId | StockItemBin->PermissionTree_Id | integer | int64 |\r\n| stockItemId | StockItemBin->StockItem_Id | integer | int64 |\r\n| sequenceNumber | StockItemBin->SequenceNumber | integer | int32 |\r\n| notes | StockItemBin->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| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| stockItemId | Required | True | |\r\n| stockItemId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateStockItemBin", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateStockItemBinResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Stock Item Bin batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Stock Item Bin" ], "summary": "Update a collection of existing Stock Item Bin resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItemBin->Id | integer | int64 |\r\n| version | StockItemBin->Version | integer | int32 |\r\n| code | StockItemBin->Code | string | |\r\n| sequenceNumber | StockItemBin->SequenceNumber | integer | int32 |\r\n| notes | StockItemBin->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\r\n", "operationId": "BatchUpdateStockItemBin", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateStockItemBinResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Stock Item Bin batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Stock Item Bin" ], "summary": "Delete a collection of existing Stock Item Bin resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItemBin->Id | integer | int64 |\r\n| version | StockItemBin->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": "BatchDeleteStockItemBin", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteStockItemBinResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Stock Item Bin batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Bins/{id}/Active": { "patch": { "tags": [ "Stock Item Bin" ], "summary": "Change the IsActive status for an existing Stock Item Bin resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | StockItemBin->Version | integer | int32 |\r\n| isActive | StockItemBin->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": "ChangeStockItemBinIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Bin Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeStockItemBinIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Bins/{id}/PermissionTree": { "patch": { "tags": [ "Stock Item Bin" ], "summary": "Change the PermissionTree for an existing Stock Item Bin resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | StockItemBin->Version | integer | int32 |\r\n| permissionTreeId | StockItemBin->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": "ChangeStockItemBinPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Bin Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeStockItemBinPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Bins/Batch/Active": { "patch": { "tags": [ "Stock Item Bin" ], "summary": "Change the IsActive status for a collection of existing Stock Item Bin resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItemBin->Id | integer | int64 |\r\n| version | StockItemBin->Version | integer | int32 |\r\n| isActive | StockItemBin->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": "BatchChangeStockItemBinIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeStockItemBinIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Bins/Batch/PermissionTree": { "patch": { "tags": [ "Stock Item Bin" ], "summary": "Change the PermissionTree status for a collection of existing Stock Item Bin resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItemBin->Id | integer | int64 |\r\n| version | StockItemBin->Version | integer | int32 |\r\n| permissionTreeId | StockItemBin->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": "BatchChangeStockItemBinPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeStockItemBinPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Documents/{id}": { "get": { "tags": [ "Stock Item Document" ], "summary": "Get a Stock Item 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| stockItemId | StockItemDocument->StockItem_Id | integer | int64 |\r\n| stockItemMaterialMasterId | StockItemDocument->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | StockItemDocument->StockItem_MaterialMaster_Code | string | |\r\n| stockItemMaterialMasterDescription | StockItemDocument->StockItem_MaterialMaster_Description | string | |\r\n| isActive | StockItemDocument->IsActive | boolean | |\r\n| createdByUserId | StockItemDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | StockItemDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | StockItemDocument->CreatedByUser_FullName | string | |\r\n| createdOn | StockItemDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | StockItemDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | StockItemDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | StockItemDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | StockItemDocument->ModifiedOn | string | date-time |\r\n| version | StockItemDocument->Version | integer | int32 |\r\n| permissionTreeId | StockItemDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StockItemDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StockItemDocument->PermissionTree_Description | string | |\r\n| id | StockItemDocument->Id | integer | int64 |\r\n| documentRecordId | StockItemDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | StockItemDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | StockItemDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | StockItemDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | StockItemDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | StockItemDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | StockItemDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | StockItemDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | StockItemDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | StockItemDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | StockItemDocument->Notes | string | |\r\n| sequenceNumber | StockItemDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetStockItemDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Stock Item Document", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetStockItemDocumentResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Stock Item Document" ], "summary": "Update an existing Stock Item 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 | StockItemDocument->Version | integer | int32 |\r\n| sequenceNumber | StockItemDocument->SequenceNumber | integer | int32 |\r\n| notes | StockItemDocument->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": "UpdateStockItemDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateStockItemDocumentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Stock Item Document was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Stock Item Document" ], "summary": "Delete an existing Stock Item 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 | StockItemDocument->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": "DeleteStockItemDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteStockItemDocumentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Stock Item Document was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/{id}/Documents": { "get": { "tags": [ "Stock Item Document" ], "summary": "Get a collection of Stock Item Document resources for the Stock Item.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItemDocument->Id | integer | int64 |\r\n| version | StockItemDocument->Version | integer | int32 |\r\n| sequenceNumber | StockItemDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | StockItemDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | StockItemDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | StockItemDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | StockItemDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | StockItemDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | StockItemDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | StockItemDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetStockItemDocumentCollectionForStockItem", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Stock Item Document collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetStockItemDocumentCollectionForStockItemResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Documents": { "get": { "tags": [ "Stock Item Document" ], "summary": "Get a collection of Stock Item 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 | StockItemDocument->Id | integer | int64 |\r\n| version | StockItemDocument->Version | integer | int32 |\r\n| stockItemId | StockItemDocument->StockItem_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | StockItemDocument->StockItem_MaterialMaster_Code | string | |\r\n| stockItemMaterialMasterDescription | StockItemDocument->StockItem_MaterialMaster_Description | string | |\r\n| sequenceNumber | StockItemDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | StockItemDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | StockItemDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | StockItemDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | StockItemDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | StockItemDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | StockItemDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | StockItemDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetStockItemDocumentCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Stock Item Document collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetStockItemDocumentCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Stock Item Document" ], "summary": "Create a new Stock Item 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| stockItemId | StockItemDocument->StockItem_Id | integer | int64 |\r\n| documentRecordId | StockItemDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | StockItemDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | StockItemDocument->SequenceNumber | integer | int32 |\r\n| notes | StockItemDocument->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| stockItemId | Required | True | |\r\n| stockItemId | 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": "CreateStockItemDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateStockItemDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Documents/Lookups/LookupStockItemDocumentChangePermissionTree": { "get": { "tags": [ "Stock Item Document" ], "summary": "Lookup the permission set for changing the Stock Item 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": "LookupStockItemDocumentChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemDocumentChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Documents/Lookups/LookupStockItemDocument": { "get": { "tags": [ "Stock Item Document" ], "summary": "Stock Item 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": "LookupStockItemDocument", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Document Record collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemDocumentDocumentLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Documents/Lookups/LookupStockItemDocumentInsertPermissionTree": { "get": { "tags": [ "Stock Item Document" ], "summary": "Lookup the permission set for creating the Stock Item 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": "LookupStockItemDocumentInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemDocumentInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Documents/Lookups/LookupStockItemDocumentStockItem": { "get": { "tags": [ "Stock Item Document" ], "summary": "Lookup the Stock Item Document for the Stock Item 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 | StockItem->Id | integer | int64 |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| materialMasterDescription | StockItem->MaterialMaster_Description | string | |\r\n", "operationId": "LookupStockItemDocumentStockItem", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Stock Item collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemDocumentStockItemLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Documents/Batch/{ids}": { "get": { "tags": [ "Stock Item Document" ], "summary": "Get a collection of Stock Item 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| stockItemId | StockItemDocument->StockItem_Id | integer | int64 |\r\n| stockItemMaterialMasterId | StockItemDocument->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | StockItemDocument->StockItem_MaterialMaster_Code | string | |\r\n| stockItemMaterialMasterDescription | StockItemDocument->StockItem_MaterialMaster_Description | string | |\r\n| isActive | StockItemDocument->IsActive | boolean | |\r\n| createdByUserId | StockItemDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | StockItemDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | StockItemDocument->CreatedByUser_FullName | string | |\r\n| createdOn | StockItemDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | StockItemDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | StockItemDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | StockItemDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | StockItemDocument->ModifiedOn | string | date-time |\r\n| version | StockItemDocument->Version | integer | int32 |\r\n| permissionTreeId | StockItemDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StockItemDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StockItemDocument->PermissionTree_Description | string | |\r\n| id | StockItemDocument->Id | integer | int64 |\r\n| documentRecordId | StockItemDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | StockItemDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | StockItemDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | StockItemDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | StockItemDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | StockItemDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | StockItemDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | StockItemDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | StockItemDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | StockItemDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | StockItemDocument->Notes | string | |\r\n| sequenceNumber | StockItemDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetStockItemDocument", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Stock Item Document id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Stock Item Document collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetStockItemDocumentResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Documents/Batch": { "post": { "tags": [ "Stock Item Document" ], "summary": "Create a new collection of Stock Item 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| stockItemId | StockItemDocument->StockItem_Id | integer | int64 |\r\n| documentRecordId | StockItemDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | StockItemDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | StockItemDocument->SequenceNumber | integer | int32 |\r\n| notes | StockItemDocument->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| stockItemId | Required | True | |\r\n| stockItemId | 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": "BatchCreateStockItemDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateStockItemDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Stock Item Document batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Stock Item Document" ], "summary": "Update a collection of existing Stock Item 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 | StockItemDocument->Id | integer | int64 |\r\n| version | StockItemDocument->Version | integer | int32 |\r\n| sequenceNumber | StockItemDocument->SequenceNumber | integer | int32 |\r\n| notes | StockItemDocument->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": "BatchUpdateStockItemDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateStockItemDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Stock Item Document batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Stock Item Document" ], "summary": "Delete a collection of existing Stock Item 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 | StockItemDocument->Id | integer | int64 |\r\n| version | StockItemDocument->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": "BatchDeleteStockItemDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteStockItemDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Stock Item Document batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Documents/{id}/Active": { "patch": { "tags": [ "Stock Item Document" ], "summary": "Change the IsActive status for an existing Stock Item 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 | StockItemDocument->Version | integer | int32 |\r\n| isActive | StockItemDocument->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": "ChangeStockItemDocumentIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeStockItemDocumentIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Stock Item Document" ], "summary": "Change the PermissionTree for an existing Stock Item 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 | StockItemDocument->Version | integer | int32 |\r\n| permissionTreeId | StockItemDocument->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": "ChangeStockItemDocumentPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeStockItemDocumentPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Stock Item Document" ], "summary": "Change the PermissionTree status for a collection of existing Stock Item 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 | StockItemDocument->Id | integer | int64 |\r\n| version | StockItemDocument->Version | integer | int32 |\r\n| permissionTreeId | StockItemDocument->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": "BatchChangeStockItemDocumentPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeStockItemDocumentPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Documents/Batch/Active": { "patch": { "tags": [ "Stock Item Document" ], "summary": "Change the IsActive status for a collection of existing Stock Item 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 | StockItemDocument->Id | integer | int64 |\r\n| version | StockItemDocument->Version | integer | int32 |\r\n| isActive | StockItemDocument->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": "BatchChangeStockItemDocumentIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeStockItemDocumentIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/FileAttachments/{id}/Download": { "get": { "tags": [ "Stock Item File Attachment" ], "summary": "Download the content for a Stock Item File Attachment resource.", "description": "", "operationId": "GetStockItemFileAttachmentContent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "name": "cv", "in": "query", "description": "Return older version of attachment content", "schema": { "type": "integer", "format": "int32", "nullable": true } } ], "responses": { "200": { "description": "Success response - body contains file content", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/FileAttachments/{id}": { "get": { "tags": [ "Stock Item File Attachment" ], "summary": "Get a Stock Item 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| stockItemId | StockItemFileAttachment->StockItem_Id | integer | int64 |\r\n| stockItemMaterialMasterId | StockItemFileAttachment->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | StockItemFileAttachment->StockItem_MaterialMaster_Code | string | |\r\n| stockItemMaterialMasterDescription | StockItemFileAttachment->StockItem_MaterialMaster_Description | string | |\r\n| stockItemWarehouseId | StockItemFileAttachment->StockItem_Warehouse_Id | integer | int64 |\r\n| stockItemWarehouseCode | StockItemFileAttachment->StockItem_Warehouse_Code | string | |\r\n| stockItemWarehouseDescription | StockItemFileAttachment->StockItem_Warehouse_Description | string | |\r\n| createdByUserId | StockItemFileAttachment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | StockItemFileAttachment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | StockItemFileAttachment->CreatedByUser_FullName | string | |\r\n| createdOn | StockItemFileAttachment->CreatedOn | string | date-time |\r\n| contentId | StockItemFileAttachment->Content_Id | integer | int64 |\r\n| contentFileLocationId | StockItemFileAttachment->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | StockItemFileAttachment->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | StockItemFileAttachment->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | StockItemFileAttachment->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | StockItemFileAttachment->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | StockItemFileAttachment->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | StockItemFileAttachment->Content_SizeInMb | number | decimal |\r\n| contentVersion | StockItemFileAttachment->ContentVersion | integer | int32 |\r\n| entityType | StockItemFileAttachment->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 | StockItemFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | StockItemFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | StockItemFileAttachment->FileCategory_Description | string | |\r\n| fileCategoryAutoIsRestricted | StockItemFileAttachment->FileCategory_AutoIsRestricted | boolean | |\r\n| fileFullName | StockItemFileAttachment->FileFullName | string | |\r\n| fileName | StockItemFileAttachment->FileName | string | |\r\n| fileTypeId | StockItemFileAttachment->FileType_Id | integer | int64 |\r\n| fileTypeExtension | StockItemFileAttachment->FileType_Extension | string | |\r\n| isRestricted | StockItemFileAttachment->IsRestricted | boolean | |\r\n| id | StockItemFileAttachment->Id | integer | int64 |\r\n| isActive | StockItemFileAttachment->IsActive | boolean | |\r\n| modifiedByUserId | StockItemFileAttachment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | StockItemFileAttachment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | StockItemFileAttachment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | StockItemFileAttachment->ModifiedOn | string | date-time |\r\n| permissionTreeId | StockItemFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StockItemFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StockItemFileAttachment->PermissionTree_Description | string | |\r\n| version | StockItemFileAttachment->Version | integer | int32 |\r\n", "operationId": "GetStockItemFileAttachment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Stock Item File Attachment", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetStockItemFileAttachmentResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Stock Item File Attachment" ], "summary": "Update an existing Stock Item 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 | StockItemFileAttachment->Version | integer | int32 |\r\n| fileCategoryId | StockItemFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileName | StockItemFileAttachment->FileName | string | |\r\n| isRestricted | StockItemFileAttachment->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": "UpdateStockItemFileAttachment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateStockItemFileAttachmentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Stock Item File Attachment was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Stock Item File Attachment" ], "summary": "Delete an existing Stock Item 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 | StockItemFileAttachment->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": "DeleteStockItemFileAttachment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteStockItemFileAttachmentResourceResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Stock Item File Attachment was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/{id}/FileAttachments": { "get": { "tags": [ "Stock Item File Attachment" ], "summary": "Get a collection of Stock Item File Attachment resources for the Stock Item.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItemFileAttachment->Id | integer | int64 |\r\n| version | StockItemFileAttachment->Version | integer | int32 |\r\n| fileFullName | StockItemFileAttachment->FileFullName | string | |\r\n| contentSizeInMb | StockItemFileAttachment->Content_SizeInMb | number | decimal |\r\n| isRestricted | StockItemFileAttachment->IsRestricted | boolean | |\r\n| fileCategoryId | StockItemFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | StockItemFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | StockItemFileAttachment->FileCategory_Description | string | |\r\n| permissionTreeId | StockItemFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StockItemFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StockItemFileAttachment->PermissionTree_Description | string | |\r\n| createdOn | StockItemFileAttachment->CreatedOn | string | date-time |\r\n| modifiedOn | StockItemFileAttachment->ModifiedOn | string | date-time |\r\n", "operationId": "GetStockItemFileAttachmentCollectionForStockItem", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Stock Item File Attachment collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetStockItemFileAttachmentCollectionForStockItemResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/FileAttachments": { "get": { "tags": [ "Stock Item File Attachment" ], "summary": "Get a collection of Stock Item 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 | StockItemFileAttachment->Id | integer | int64 |\r\n| version | StockItemFileAttachment->Version | integer | int32 |\r\n| stockItemId | StockItemFileAttachment->StockItem_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | StockItemFileAttachment->StockItem_MaterialMaster_Code | string | |\r\n| stockItemWarehouseCode | StockItemFileAttachment->StockItem_Warehouse_Code | string | |\r\n| fileFullName | StockItemFileAttachment->FileFullName | string | |\r\n| contentSizeInMb | StockItemFileAttachment->Content_SizeInMb | number | decimal |\r\n| fileTypeExtension | StockItemFileAttachment->FileType_Extension | string | |\r\n| isRestricted | StockItemFileAttachment->IsRestricted | boolean | |\r\n| fileCategoryId | StockItemFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | StockItemFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | StockItemFileAttachment->FileCategory_Description | string | |\r\n| permissionTreeId | StockItemFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StockItemFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StockItemFileAttachment->PermissionTree_Description | string | |\r\n| createdOn | StockItemFileAttachment->CreatedOn | string | date-time |\r\n| modifiedOn | StockItemFileAttachment->ModifiedOn | string | date-time |\r\n", "operationId": "GetStockItemFileAttachmentCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Stock Item File Attachment collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetStockItemFileAttachmentCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/FileAttachments/Upload": { "post": { "tags": [ "Stock Item File Attachment" ], "summary": "Upload and create a new Stock Item 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| stockItemId | StockItemFileAttachment->StockItem_Id | integer | int64 |\r\n| isRestricted | StockItemFileAttachment->IsRestricted | boolean | |\r\n| fileName | StockItemFileAttachment->FileName | string | |\r\n| fileCategoryId | StockItemFileAttachment->FileCategory_Id | integer | int64 |\r\n| permissionTreeId | StockItemFileAttachment->PermissionTree_Id | integer | int64 |\r\n| bytes | StockItemFileAttachment->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| stockItemId | Required | True | |\r\n| stockItemId | 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": "CreateStockItemFileAttachment", "requestBody": { "x-name": "entityPost", "description": "Request Body content", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreateStockItemFileAttachmentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/FileAttachments/{id}/Upload": { "put": { "tags": [ "Stock Item File Attachment" ], "summary": "Upload new content for an existing Stock Item 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 | StockItemFileAttachment->Version | integer | int32 |\r\n| bytes | StockItemFileAttachment->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": "UpdateStockItemFileAttachmentContent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 } ], "requestBody": { "x-name": "entityFilePatch", "description": "Request Body content", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UpdateStockItemFileAttachmentContentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Stock Item File Attachment was successfully updated" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/FileAttachments/Batch/{ids}": { "get": { "tags": [ "Stock Item File Attachment" ], "summary": "Get a collection of Stock Item 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| stockItemId | StockItemFileAttachment->StockItem_Id | integer | int64 |\r\n| stockItemMaterialMasterId | StockItemFileAttachment->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | StockItemFileAttachment->StockItem_MaterialMaster_Code | string | |\r\n| stockItemMaterialMasterDescription | StockItemFileAttachment->StockItem_MaterialMaster_Description | string | |\r\n| stockItemWarehouseId | StockItemFileAttachment->StockItem_Warehouse_Id | integer | int64 |\r\n| stockItemWarehouseCode | StockItemFileAttachment->StockItem_Warehouse_Code | string | |\r\n| stockItemWarehouseDescription | StockItemFileAttachment->StockItem_Warehouse_Description | string | |\r\n| createdByUserId | StockItemFileAttachment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | StockItemFileAttachment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | StockItemFileAttachment->CreatedByUser_FullName | string | |\r\n| createdOn | StockItemFileAttachment->CreatedOn | string | date-time |\r\n| contentId | StockItemFileAttachment->Content_Id | integer | int64 |\r\n| contentFileLocationId | StockItemFileAttachment->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | StockItemFileAttachment->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | StockItemFileAttachment->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | StockItemFileAttachment->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | StockItemFileAttachment->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | StockItemFileAttachment->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | StockItemFileAttachment->Content_SizeInMb | number | decimal |\r\n| contentVersion | StockItemFileAttachment->ContentVersion | integer | int32 |\r\n| entityType | StockItemFileAttachment->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 | StockItemFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | StockItemFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | StockItemFileAttachment->FileCategory_Description | string | |\r\n| fileCategoryAutoIsRestricted | StockItemFileAttachment->FileCategory_AutoIsRestricted | boolean | |\r\n| fileFullName | StockItemFileAttachment->FileFullName | string | |\r\n| fileName | StockItemFileAttachment->FileName | string | |\r\n| fileTypeId | StockItemFileAttachment->FileType_Id | integer | int64 |\r\n| fileTypeExtension | StockItemFileAttachment->FileType_Extension | string | |\r\n| isRestricted | StockItemFileAttachment->IsRestricted | boolean | |\r\n| id | StockItemFileAttachment->Id | integer | int64 |\r\n| isActive | StockItemFileAttachment->IsActive | boolean | |\r\n| modifiedByUserId | StockItemFileAttachment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | StockItemFileAttachment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | StockItemFileAttachment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | StockItemFileAttachment->ModifiedOn | string | date-time |\r\n| permissionTreeId | StockItemFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StockItemFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StockItemFileAttachment->PermissionTree_Description | string | |\r\n| version | StockItemFileAttachment->Version | integer | int32 |\r\n", "operationId": "BatchGetStockItemFileAttachment", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Stock Item File Attachment id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Stock Item File Attachment collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetStockItemFileAttachmentResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/FileAttachments/{id}/ContentHistory": { "get": { "tags": [ "Stock Item File Attachment" ], "summary": "Get a collection of File Attachment Content History resources for the Stock Item 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": "GetStockItemFileAttachmentContentHistory", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Stock Item File Attachment collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/GetStockItemFileAttachmentContentHistoryResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/FileAttachments/Upload/Batch": { "post": { "tags": [ "Stock Item File Attachment" ], "summary": "Upload and create a new collection of Stock Item 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| stockItemId | StockItemFileAttachment->StockItem_Id | integer | int64 |\r\n| isRestricted | StockItemFileAttachment->IsRestricted | boolean | |\r\n| fileName | StockItemFileAttachment->FileName | string | |\r\n| fileCategoryId | StockItemFileAttachment->FileCategory_Id | integer | int64 |\r\n| permissionTreeId | StockItemFileAttachment->PermissionTree_Id | integer | int64 |\r\n| bytes | StockItemFileAttachment->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| stockItemId | Required | True | |\r\n| stockItemId | 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": "BatchCreateStockItemFileAttachment", "parameters": [ { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "entityPostCollection", "description": "Request Body content", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/BatchCreateStockItemFileAttachmentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Stock Item File Attachment batch was successfully created" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/FileAttachments/Batch": { "patch": { "tags": [ "Stock Item File Attachment" ], "summary": "Update a collection of existing Stock Item 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 | StockItemFileAttachment->Id | integer | int64 |\r\n| version | StockItemFileAttachment->Version | integer | int32 |\r\n| isRestricted | StockItemFileAttachment->IsRestricted | boolean | |\r\n| fileName | StockItemFileAttachment->FileName | string | |\r\n| fileCategoryId | StockItemFileAttachment->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": "BatchUpdateStockItemFileAttachment", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateStockItemFileAttachmentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Stock Item File Attachment batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Stock Item File Attachment" ], "summary": "Delete a collection of existing Stock Item 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 | StockItemFileAttachment->Id | integer | int64 |\r\n| version | StockItemFileAttachment->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": "BatchDeleteStockItemFileAttachment", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteStockItemFileAttachmentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Stock Item File Attachment batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Suppliers/{id}": { "get": { "tags": [ "Stock Item Supplier" ], "summary": "Get a Stock Item 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| isActive | StockItemSupplier->IsActive | boolean | |\r\n| createdByUserId | StockItemSupplier->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | StockItemSupplier->CreatedByUser_Code | string | |\r\n| createdByUserFullName | StockItemSupplier->CreatedByUser_FullName | string | |\r\n| createdOn | StockItemSupplier->CreatedOn | string | date-time |\r\n| modifiedByUserId | StockItemSupplier->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | StockItemSupplier->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | StockItemSupplier->ModifiedByUser_FullName | string | |\r\n| modifiedOn | StockItemSupplier->ModifiedOn | string | date-time |\r\n| version | StockItemSupplier->Version | integer | int32 |\r\n| permissionTreeId | StockItemSupplier->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StockItemSupplier->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StockItemSupplier->PermissionTree_Description | string | |\r\n| id | StockItemSupplier->Id | integer | int64 |\r\n| currencyId | StockItemSupplier->Currency_Id | integer | int64 |\r\n| currencyCode | StockItemSupplier->Currency_Code | string | |\r\n| currencyDescription | StockItemSupplier->Currency_Description | string | |\r\n| leadTime | StockItemSupplier->LeadTime | string | duration |\r\n| minimumOrderQuantity | StockItemSupplier->MinimumOrderQuantity | number | decimal |\r\n| notes | StockItemSupplier->Notes | string | |\r\n| sequenceNumber | StockItemSupplier->SequenceNumber | integer | int32 |\r\n| stockItemId | StockItemSupplier->StockItem_Id | integer | int64 |\r\n| stockItemMaterialMasterId | StockItemSupplier->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | StockItemSupplier->StockItem_MaterialMaster_Code | string | |\r\n| stockItemAlternativeDescription | StockItemSupplier->StockItem_AlternativeDescription | string | |\r\n| supplierId | StockItemSupplier->Supplier_Id | integer | int64 |\r\n| supplierCode | StockItemSupplier->Supplier_Code | string | |\r\n| supplierDescription | StockItemSupplier->Supplier_Description | string | |\r\n| supplierPartNumber | StockItemSupplier->SupplierPartNumber | string | |\r\n| unitCost | StockItemSupplier->UnitCost | number | decimal |\r\n", "operationId": "GetStockItemSupplier", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Supplier Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Stock Item Supplier", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetStockItemSupplierResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Stock Item Supplier" ], "summary": "Update an existing Stock Item 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 | StockItemSupplier->Version | integer | int32 |\r\n| supplierPartNumber | StockItemSupplier->SupplierPartNumber | string | |\r\n| leadTime | StockItemSupplier->LeadTime | string | duration |\r\n| unitCost | StockItemSupplier->UnitCost | number | decimal |\r\n| currencyId | StockItemSupplier->Currency_Id | integer | int64 |\r\n| minimumOrderQuantity | StockItemSupplier->MinimumOrderQuantity | number | decimal |\r\n| notes | StockItemSupplier->Notes | string | |\r\n| sequenceNumber | StockItemSupplier->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| unitCost | Min Value | >= 0| |\r\n| minimumOrderQuantity | Min Value | >= 0| |\r\n\r\n", "operationId": "UpdateStockItemSupplier", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Supplier Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateStockItemSupplierResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Stock Item Supplier was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Stock Item Supplier" ], "summary": "Delete an existing Stock Item 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 | StockItemSupplier->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": "DeleteStockItemSupplier", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Supplier Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteStockItemSupplierResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Stock Item Supplier was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Suppliers": { "get": { "tags": [ "Stock Item Supplier" ], "summary": "Get a collection of Stock Item 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| id | StockItemSupplier->Id | integer | int64 |\r\n| version | StockItemSupplier->Version | integer | int32 |\r\n| stockItemId | StockItemSupplier->StockItem_Id | integer | int64 |\r\n| stockItemWarehouseCode | StockItemSupplier->StockItem_Warehouse_Code | string | |\r\n| stockItemMaterialMasterCode | StockItemSupplier->StockItem_MaterialMaster_Code | string | |\r\n| stockItemAlternativeDescription | StockItemSupplier->StockItem_AlternativeDescription | string | |\r\n| supplierId | StockItemSupplier->Supplier_Id | integer | int64 |\r\n| supplierCode | StockItemSupplier->Supplier_Code | string | |\r\n| supplierDescription | StockItemSupplier->Supplier_Description | string | |\r\n| notes | StockItemSupplier->Notes | string | |\r\n| sequenceNumber | StockItemSupplier->SequenceNumber | integer | int32 |\r\n", "operationId": "GetStockItemSupplierCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Stock Item Supplier collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetStockItemSupplierCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Stock Item Supplier" ], "summary": "Create a new Stock Item 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| stockItemId | StockItemSupplier->StockItem_Id | integer | int64 |\r\n| supplierId | StockItemSupplier->Supplier_Id | integer | int64 |\r\n| supplierPartNumber | StockItemSupplier->SupplierPartNumber | string | |\r\n| leadTime | StockItemSupplier->LeadTime | string | duration |\r\n| unitCost | StockItemSupplier->UnitCost | number | decimal |\r\n| currencyId | StockItemSupplier->Currency_Id | integer | int64 |\r\n| minimumOrderQuantity | StockItemSupplier->MinimumOrderQuantity | number | decimal |\r\n| notes | StockItemSupplier->Notes | string | |\r\n| permissionTreeId | StockItemSupplier->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | StockItemSupplier->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| stockItemId | Required | True | |\r\n| stockItemId | Nullable | False | |\r\n| supplierId | Required | True | |\r\n| supplierId | Nullable | False | |\r\n| unitCost | Min Value | >= 0| |\r\n| currencyId | System Generated | true | If no value specified |\r\n| minimumOrderQuantity | Min Value | >= 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateStockItemSupplier", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateStockItemSupplierResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/{stockItemId}/Suppliers": { "get": { "tags": [ "Stock Item Supplier" ], "summary": "Get a collection of Stock Item Supplier resources for the Stock Item.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItemSupplier->Id | integer | int64 |\r\n| version | StockItemSupplier->Version | integer | int32 |\r\n| supplierId | StockItemSupplier->Supplier_Id | integer | int64 |\r\n| supplierCode | StockItemSupplier->Supplier_Code | string | |\r\n| supplierDescription | StockItemSupplier->Supplier_Description | string | |\r\n| notes | StockItemSupplier->Notes | string | |\r\n| sequenceNumber | StockItemSupplier->SequenceNumber | integer | int32 |\r\n", "operationId": "GetStockItemSupplierForStockItemCollection", "parameters": [ { "name": "stockItemId", "in": "path", "required": true, "description": "Stock Item Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Stock Item Supplier collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetStockItemSuppliersForStockItemCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Suppliers/Lookups/LookupStockItemSupplierChangePermissionTree": { "get": { "tags": [ "Stock Item Supplier" ], "summary": "Lookup the permission set for changing the Stock Item 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": "LookupStockItemSupplierChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemSupplierChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Suppliers/Lookups/LookupStockItemSupplierCurrency": { "get": { "tags": [ "Stock Item Supplier" ], "summary": "Lookup the Currency for the Stock Item 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": "LookupStockItemSupplierCurrency", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Currency collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/LookupStockItemSupplierCurrencyLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Suppliers/Lookups/LookupStockItemSupplierInsertPermissionTree": { "get": { "tags": [ "Stock Item Supplier" ], "summary": "Lookup the permission set for creating the Stock Item 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": "LookupStockItemSupplierInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemSupplierInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Suppliers/Lookups/LookupStockItemSupplierStockItem": { "get": { "tags": [ "Stock Item Supplier" ], "summary": "Lookup the Stock Item for the Stock Item 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 | StockItem->Id | integer | int64 |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n", "operationId": "LookupStockItemSupplierStockItem", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Stock Item collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemSupplierStockItemLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Suppliers/Lookups/LookupStockItemSupplierSupplier": { "get": { "tags": [ "Stock Item Supplier" ], "summary": "Lookup the Supplier for the Stock Item 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 | Supplier->Id | integer | int64 |\r\n| code | Supplier->Code | string | |\r\n| description | Supplier->Description | string | |\r\n", "operationId": "LookupStockItemSupplierSupplier", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Supplier collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/StockItemSupplierSupplierLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Suppliers/Batch/{ids}": { "get": { "tags": [ "Stock Item Supplier" ], "summary": "Get a collection of Stock Item 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| isActive | StockItemSupplier->IsActive | boolean | |\r\n| createdByUserId | StockItemSupplier->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | StockItemSupplier->CreatedByUser_Code | string | |\r\n| createdByUserFullName | StockItemSupplier->CreatedByUser_FullName | string | |\r\n| createdOn | StockItemSupplier->CreatedOn | string | date-time |\r\n| modifiedByUserId | StockItemSupplier->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | StockItemSupplier->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | StockItemSupplier->ModifiedByUser_FullName | string | |\r\n| modifiedOn | StockItemSupplier->ModifiedOn | string | date-time |\r\n| version | StockItemSupplier->Version | integer | int32 |\r\n| permissionTreeId | StockItemSupplier->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StockItemSupplier->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StockItemSupplier->PermissionTree_Description | string | |\r\n| id | StockItemSupplier->Id | integer | int64 |\r\n| currencyId | StockItemSupplier->Currency_Id | integer | int64 |\r\n| currencyCode | StockItemSupplier->Currency_Code | string | |\r\n| currencyDescription | StockItemSupplier->Currency_Description | string | |\r\n| leadTime | StockItemSupplier->LeadTime | string | duration |\r\n| minimumOrderQuantity | StockItemSupplier->MinimumOrderQuantity | number | decimal |\r\n| notes | StockItemSupplier->Notes | string | |\r\n| sequenceNumber | StockItemSupplier->SequenceNumber | integer | int32 |\r\n| stockItemId | StockItemSupplier->StockItem_Id | integer | int64 |\r\n| stockItemMaterialMasterId | StockItemSupplier->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | StockItemSupplier->StockItem_MaterialMaster_Code | string | |\r\n| stockItemAlternativeDescription | StockItemSupplier->StockItem_AlternativeDescription | string | |\r\n| supplierId | StockItemSupplier->Supplier_Id | integer | int64 |\r\n| supplierCode | StockItemSupplier->Supplier_Code | string | |\r\n| supplierDescription | StockItemSupplier->Supplier_Description | string | |\r\n| supplierPartNumber | StockItemSupplier->SupplierPartNumber | string | |\r\n| unitCost | StockItemSupplier->UnitCost | number | decimal |\r\n", "operationId": "BatchGetStockItemSupplier", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Stock Item Supplier id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Stock Item Supplier collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetStockItemSupplierResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Suppliers/Batch": { "post": { "tags": [ "Stock Item Supplier" ], "summary": "Create a new collection of Stock Item 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| stockItemId | StockItemSupplier->StockItem_Id | integer | int64 |\r\n| supplierId | StockItemSupplier->Supplier_Id | integer | int64 |\r\n| supplierPartNumber | StockItemSupplier->SupplierPartNumber | string | |\r\n| leadTime | StockItemSupplier->LeadTime | string | duration |\r\n| unitCost | StockItemSupplier->UnitCost | number | decimal |\r\n| currencyId | StockItemSupplier->Currency_Id | integer | int64 |\r\n| minimumOrderQuantity | StockItemSupplier->MinimumOrderQuantity | number | decimal |\r\n| notes | StockItemSupplier->Notes | string | |\r\n| permissionTreeId | StockItemSupplier->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | StockItemSupplier->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| stockItemId | Required | True | |\r\n| stockItemId | Nullable | False | |\r\n| supplierId | Required | True | |\r\n| supplierId | Nullable | False | |\r\n| unitCost | Min Value | >= 0| |\r\n| currencyId | System Generated | true | If no value specified |\r\n| minimumOrderQuantity | Min Value | >= 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateStockItemSupplier", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateStockItemSupplierResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Stock Item Supplier batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Stock Item Supplier" ], "summary": "Update a collection of existing Stock Item 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 | StockItemSupplier->Id | integer | int64 |\r\n| version | StockItemSupplier->Version | integer | int32 |\r\n| supplierPartNumber | StockItemSupplier->SupplierPartNumber | string | |\r\n| leadTime | StockItemSupplier->LeadTime | string | duration |\r\n| unitCost | StockItemSupplier->UnitCost | number | decimal |\r\n| currencyId | StockItemSupplier->Currency_Id | integer | int64 |\r\n| minimumOrderQuantity | StockItemSupplier->MinimumOrderQuantity | number | decimal |\r\n| notes | StockItemSupplier->Notes | string | |\r\n| sequenceNumber | StockItemSupplier->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| unitCost | Min Value | >= 0| |\r\n| minimumOrderQuantity | Min Value | >= 0| |\r\n\r\n", "operationId": "BatchUpdateStockItemSupplier", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateStockItemSupplierResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Stock Item Supplier batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Stock Item Supplier" ], "summary": "Delete a collection of existing Stock Item 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 | StockItemSupplier->Id | integer | int64 |\r\n| version | StockItemSupplier->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": "BatchDeleteStockItemSupplier", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteStockItemSupplierResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Stock Item Supplier batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Suppliers/{id}/Active": { "patch": { "tags": [ "Stock Item Supplier" ], "summary": "Change the IsActive status for an existing Stock Item 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 | StockItemSupplier->Version | integer | int32 |\r\n| isActive | StockItemSupplier->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": "ChangeStockItemSupplierIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Supplier Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeStockItemSupplierIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Suppliers/{id}/PermissionTree": { "patch": { "tags": [ "Stock Item Supplier" ], "summary": "Change the PermissionTree for an existing Stock Item 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 | StockItemSupplier->Version | integer | int32 |\r\n| permissionTreeId | StockItemSupplier->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": "ChangeStockItemSupplierPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Stock Item Supplier Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeStockItemSupplierPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Suppliers/Batch/Active": { "patch": { "tags": [ "Stock Item Supplier" ], "summary": "Change the IsActive status for a collection of existing Stock Item 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 | StockItemSupplier->Id | integer | int64 |\r\n| version | StockItemSupplier->Version | integer | int32 |\r\n| isActive | StockItemSupplier->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": "BatchChangeStockItemSupplierIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeStockItemSupplierIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/StockItems/Suppliers/Batch/PermissionTree": { "patch": { "tags": [ "Stock Item Supplier" ], "summary": "Change the PermissionTree status for a collection of existing Stock Item 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 | StockItemSupplier->Id | integer | int64 |\r\n| version | StockItemSupplier->Version | integer | int32 |\r\n| permissionTreeId | StockItemSupplier->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": "BatchChangeStockItemSupplierPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeStockItemSupplierPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/{id}": { "get": { "tags": [ "Warehouse" ], "summary": "Get a Warehouse 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 | Warehouse->Code | string | |\r\n| isActive | Warehouse->IsActive | boolean | |\r\n| createdByUserId | Warehouse->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Warehouse->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Warehouse->CreatedByUser_FullName | string | |\r\n| createdOn | Warehouse->CreatedOn | string | date-time |\r\n| modifiedByUserId | Warehouse->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Warehouse->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Warehouse->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Warehouse->ModifiedOn | string | date-time |\r\n| version | Warehouse->Version | integer | int32 |\r\n| permissionTreeId | Warehouse->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Warehouse->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Warehouse->PermissionTree_Description | string | |\r\n| siteId | Warehouse->Site_Id | integer | int64 |\r\n| siteCode | Warehouse->Site_Code | string | |\r\n| siteDescription | Warehouse->Site_Description | string | |\r\n| id | Warehouse->Id | integer | int64 |\r\n| costCentreId | Warehouse->CostCentre_Id | integer | int64 |\r\n| costCentreCode | Warehouse->CostCentre_Code | string | |\r\n| costCentreDescription | Warehouse->CostCentre_Description | string | |\r\n| description | Warehouse->Description | string | |\r\n| notes | Warehouse->Notes | string | |\r\n| sequenceNumber | Warehouse->SequenceNumber | integer | int32 |\r\n", "operationId": "GetWarehouse", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Warehouse Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Warehouse", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetWarehouseResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Warehouse" ], "summary": "Update an existing Warehouse resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Warehouse->Version | integer | int32 |\r\n| code | Warehouse->Code | string | |\r\n| description | Warehouse->Description | string | |\r\n| sequenceNumber | Warehouse->SequenceNumber | integer | int32 |\r\n| costCentreId | Warehouse->CostCentre_Id | integer | int64 |\r\n| notes | Warehouse->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| costCentreId | Nullable | False | |\r\n\r\n", "operationId": "UpdateWarehouse", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Warehouse Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateWarehouseResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Warehouse was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Warehouse" ], "summary": "Delete an existing Warehouse resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Warehouse->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": "DeleteWarehouse", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Warehouse Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "input", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteWarehouseResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Warehouse was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses": { "get": { "tags": [ "Warehouse" ], "summary": "Get a collection of Warehouse 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 | Warehouse->Version | integer | int32 |\r\n| id | Warehouse->Id | integer | int64 |\r\n| code | Warehouse->Code | string | |\r\n| description | Warehouse->Description | string | |\r\n| sequenceNumber | Warehouse->SequenceNumber | integer | int32 |\r\n| costCentreId | Warehouse->CostCentre_Id | integer | int64 |\r\n| costCentreCode | Warehouse->CostCentre_Code | string | |\r\n| costCentreDescription | Warehouse->CostCentre_Description | string | |\r\n| siteId | Warehouse->Site_Id | integer | int64 |\r\n| siteCode | Warehouse->Site_Code | string | |\r\n| siteDescription | Warehouse->Site_Description | string | |\r\n| notes | Warehouse->Notes | string | |\r\n| createdOn | Warehouse->CreatedOn | string | date-time |\r\n| modifiedOn | Warehouse->ModifiedOn | string | date-time |\r\n", "operationId": "GetWarehouseCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Warehouse collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetWarehouseCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Warehouse" ], "summary": "Create a new Warehouse resource.", "description": "### Request Body\r\n#### 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 | Warehouse->PermissionTree_Id | integer | int64 |\r\n| siteId | Warehouse->Site_Id | integer | int64 |\r\n| code | Warehouse->Code | string | |\r\n| description | Warehouse->Description | string | |\r\n| sequenceNumber | Warehouse->SequenceNumber | integer | int32 |\r\n| costCentreId | Warehouse->CostCentre_Id | integer | int64 |\r\n| notes | Warehouse->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| siteId | Required | True | |\r\n| siteId | 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| costCentreId | Required | True | |\r\n| costCentreId | Nullable | False | |\r\n\r\n", "operationId": "CreateWarehouse", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateWarehouseResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Lookups/LookupWarehouseChangePermissionTree": { "get": { "tags": [ "Warehouse" ], "summary": "Lookup the permission set for changing the Warehouse.", "description": "### Response Body\r\n#### Payload\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": "LookupWarehouseChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/WarehouseChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Lookups/LookupWarehouseCostCentre": { "get": { "tags": [ "Warehouse" ], "summary": "Lookup the Cost Centre for the Warehouse.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentre->Id | integer | int64 |\r\n| code | CostCentre->Code | string | |\r\n| description | CostCentre->Description | string | |\r\n", "operationId": "LookupWarehouseCostCentre", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Cost Centre collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/WarehouseCostCentreLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Lookups/LookupWarehouseInsertPermissionTree": { "get": { "tags": [ "Warehouse" ], "summary": "Lookup the permission set for creating the Warehouse.", "description": "### Response Body\r\n#### Payload\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": "LookupWarehouseInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/WarehouseInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Lookups/LookupWarehouseSite": { "get": { "tags": [ "Warehouse" ], "summary": "Lookup the Site for the Warehouse.", "description": "### Response Body\r\n#### Payload\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": "LookupWarehouseSite", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Site collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/WarehouseSiteLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Batch/{ids}": { "get": { "tags": [ "Warehouse" ], "summary": "Get a collection of Warehouse 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 | Warehouse->Code | string | |\r\n| isActive | Warehouse->IsActive | boolean | |\r\n| createdByUserId | Warehouse->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Warehouse->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Warehouse->CreatedByUser_FullName | string | |\r\n| createdOn | Warehouse->CreatedOn | string | date-time |\r\n| modifiedByUserId | Warehouse->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Warehouse->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Warehouse->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Warehouse->ModifiedOn | string | date-time |\r\n| version | Warehouse->Version | integer | int32 |\r\n| permissionTreeId | Warehouse->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Warehouse->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Warehouse->PermissionTree_Description | string | |\r\n| siteId | Warehouse->Site_Id | integer | int64 |\r\n| siteCode | Warehouse->Site_Code | string | |\r\n| siteDescription | Warehouse->Site_Description | string | |\r\n| id | Warehouse->Id | integer | int64 |\r\n| costCentreId | Warehouse->CostCentre_Id | integer | int64 |\r\n| costCentreCode | Warehouse->CostCentre_Code | string | |\r\n| costCentreDescription | Warehouse->CostCentre_Description | string | |\r\n| description | Warehouse->Description | string | |\r\n| notes | Warehouse->Notes | string | |\r\n| sequenceNumber | Warehouse->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetWarehouse", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Warehouse id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Warehouse collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetWarehouseResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Batch": { "post": { "tags": [ "Warehouse" ], "summary": "Create a new collection of Warehouse resources.", "description": "### Request Body\r\n#### 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 | Warehouse->PermissionTree_Id | integer | int64 |\r\n| siteId | Warehouse->Site_Id | integer | int64 |\r\n| code | Warehouse->Code | string | |\r\n| description | Warehouse->Description | string | |\r\n| sequenceNumber | Warehouse->SequenceNumber | integer | int32 |\r\n| costCentreId | Warehouse->CostCentre_Id | integer | int64 |\r\n| notes | Warehouse->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| siteId | Required | True | |\r\n| siteId | 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| costCentreId | Required | True | |\r\n| costCentreId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateWarehouse", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateWarehouseResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Warehouse batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Warehouse" ], "summary": "Update a collection of existing Warehouse resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request 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| version | Warehouse->Version | integer | int32 |\r\n| code | Warehouse->Code | string | |\r\n| description | Warehouse->Description | string | |\r\n| sequenceNumber | Warehouse->SequenceNumber | integer | int32 |\r\n| costCentreId | Warehouse->CostCentre_Id | integer | int64 |\r\n| notes | Warehouse->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| costCentreId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateWarehouse", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateWarehouseResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Warehouse batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Warehouse" ], "summary": "Delete a collection of existing Warehouse resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request 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| version | Warehouse->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": "BatchDeleteWarehouse", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteWarehouseResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Warehouse batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/{id}/Active": { "patch": { "tags": [ "Warehouse" ], "summary": "Change the IsActive status for an existing Warehouse resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Warehouse->Version | integer | int32 |\r\n| isActive | Warehouse->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": "ChangeWarehouseIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Warehouse Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeWarehouseIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/{id}/PermissionTree": { "patch": { "tags": [ "Warehouse" ], "summary": "Change the PermissionTree for an existing Warehouse resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Warehouse->Version | integer | int32 |\r\n| permissionTreeId | Warehouse->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": "ChangeWarehousePermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Warehouse Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeWarehousePermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/{id}/Site": { "patch": { "tags": [ "Warehouse" ], "summary": "Change the Site status for an existing Warehouse resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Warehouse->Version | integer | int32 |\r\n| siteId | Warehouse->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": "ChangeWarehouseSite", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Warehouse Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeWarehouseSiteResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Batch/Active": { "patch": { "tags": [ "Warehouse" ], "summary": "Change the IsActive status for a collection of existing Warehouse resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request 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| version | Warehouse->Version | integer | int32 |\r\n| isActive | Warehouse->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": "BatchChangeWarehouseIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeWarehouseIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Batch/PermissionTree": { "patch": { "tags": [ "Warehouse" ], "summary": "Change the PermissionTree status for a collection of existing Warehouse resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request 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| version | Warehouse->Version | integer | int32 |\r\n| permissionTreeId | Warehouse->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": "BatchChangeWarehousePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeWarehousePermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Batch/Site": { "patch": { "tags": [ "Warehouse" ], "summary": "Change the Site status for a collection of existing Warehouse resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request 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| version | Warehouse->Version | integer | int32 |\r\n| siteId | Warehouse->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": "BatchChangeWarehouseSite", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeWarehouseSiteResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Attributes/{id}": { "get": { "tags": [ "Warehouse Attribute" ], "summary": "Get a Warehouse 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| warehouseId | WarehouseAttribute->Warehouse_Id | integer | int64 |\r\n| warehouseCode | WarehouseAttribute->Warehouse_Code | string | |\r\n| warehouseDescription | WarehouseAttribute->Warehouse_Description | string | |\r\n| createdByUserId | WarehouseAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WarehouseAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WarehouseAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | WarehouseAttribute->CreatedOn | string | date-time |\r\n| isActive | WarehouseAttribute->IsActive | boolean | |\r\n| modifiedByUserId | WarehouseAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WarehouseAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WarehouseAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WarehouseAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | WarehouseAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WarehouseAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WarehouseAttribute->PermissionTree_Description | string | |\r\n| version | WarehouseAttribute->Version | integer | int32 |\r\n| id | WarehouseAttribute->Id | integer | int64 |\r\n| attributeId | WarehouseAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | WarehouseAttribute->Attribute_Code | string | |\r\n| attributeDescription | WarehouseAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | WarehouseAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | WarehouseAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | WarehouseAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | WarehouseAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | WarehouseAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | WarehouseAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | WarehouseAttribute->Notes | string | |\r\n| predefinedValueId | WarehouseAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | WarehouseAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | WarehouseAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | WarehouseAttribute->SequenceNumber | integer | int32 |\r\n| value | WarehouseAttribute->Value | object | composite |\r\n", "operationId": "GetWarehouseAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Warehouse Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Warehouse Attribute", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetWarehouseAttributeResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Warehouse Attribute" ], "summary": "Update an existing Warehouse 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 | WarehouseAttribute->Version | integer | int32 |\r\n| value | WarehouseAttribute->Value | object | composite |\r\n| predefinedValueId | WarehouseAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | WarehouseAttribute->SequenceNumber | integer | int32 |\r\n| notes | WarehouseAttribute->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": "UpdateWarehouseAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Warehouse Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateWarehouseAttributeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Warehouse Attribute was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Warehouse Attribute" ], "summary": "Delete an existing Warehouse 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 | WarehouseAttribute->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": "DeleteWarehouseAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Warehouse Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteWarehouseAttributeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Warehouse Attribute was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/{warehouseId}/Attributes": { "get": { "tags": [ "Warehouse Attribute" ], "summary": "Get a collection of Warehouse Attribute resources for the Warehouse.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WarehouseAttribute->Id | integer | int64 |\r\n| version | WarehouseAttribute->Version | integer | int32 |\r\n| sequenceNumber | WarehouseAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | WarehouseAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | WarehouseAttribute->Attribute_Code | string | |\r\n| attributeDescription | WarehouseAttribute->Attribute_Description | string | |\r\n| attributeDataType | WarehouseAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | WarehouseAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | WarehouseAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | WarehouseAttribute->PredefinedValue_Value | object | composite |\r\n| value | WarehouseAttribute->Value | object | composite |\r\n| notes | WarehouseAttribute->Notes | string | |\r\n| createdOn | WarehouseAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | WarehouseAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetWarehouseAttributeCollectionForWarehouse", "parameters": [ { "name": "warehouseId", "in": "path", "required": true, "description": "Warehouse Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Warehouse Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetWarehouseAttributeCollectionForWarehouseResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Attributes": { "get": { "tags": [ "Warehouse Attribute" ], "summary": "Get a collection of Warehouse 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 | WarehouseAttribute->Id | integer | int64 |\r\n| version | WarehouseAttribute->Version | integer | int32 |\r\n| warehouseId | WarehouseAttribute->Warehouse_Id | integer | int64 |\r\n| warehouseCode | WarehouseAttribute->Warehouse_Code | string | |\r\n| warehouseDescription | WarehouseAttribute->Warehouse_Description | string | |\r\n| sequenceNumber | WarehouseAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | WarehouseAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | WarehouseAttribute->Attribute_Code | string | |\r\n| attributeDescription | WarehouseAttribute->Attribute_Description | string | |\r\n| attributeDataType | WarehouseAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | WarehouseAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | WarehouseAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | WarehouseAttribute->PredefinedValue_Value | object | composite |\r\n| value | WarehouseAttribute->Value | object | composite |\r\n| notes | WarehouseAttribute->Notes | string | |\r\n| createdOn | WarehouseAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | WarehouseAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetWarehouseAttributeCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Warehouse Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetWarehouseAttributeCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Warehouse Attribute" ], "summary": "Create a new Warehouse 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| warehouseId | WarehouseAttribute->Warehouse_Id | integer | int64 |\r\n| attributeId | WarehouseAttribute->Attribute_Id | integer | int64 |\r\n| value | WarehouseAttribute->Value | object | composite |\r\n| predefinedValueId | WarehouseAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | WarehouseAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | WarehouseAttribute->SequenceNumber | integer | int32 |\r\n| notes | WarehouseAttribute->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| warehouseId | Required | True | |\r\n| warehouseId | 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": "CreateWarehouseAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateWarehouseAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Attributes/Lookups/LookupWarehouseAttributeAllowedValue": { "get": { "tags": [ "Warehouse Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Warehouse 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": "LookupWarehouseAttributeAllowedValue", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Attribute Allowed Value collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/WarehouseAttributeAttributeAllowedValueLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Attributes/Lookups/LookupWarehouseAttribute": { "get": { "tags": [ "Warehouse Attribute" ], "summary": "Warehouse 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": "LookupWarehouseAttribute", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/WarehouseAttributeAttributeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Attributes/Lookups/LookupWarehouseAttributeChangePermissionTree": { "get": { "tags": [ "Warehouse Attribute" ], "summary": "Lookup the permission set for changing the Warehouse 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": "LookupWarehouseAttributeChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/WarehouseAttributeChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Attributes/Lookups/LookupWarehouseAttributeInsertPermissionTree": { "get": { "tags": [ "Warehouse Attribute" ], "summary": "Lookup the permission set for creating the Warehouse 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": "LookupWarehouseAttributeInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/WarehouseAttributeInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Attributes/Lookups/LookupWarehouseAttributeWarehouse": { "get": { "tags": [ "Warehouse Attribute" ], "summary": "Lookup the Warehouse Attribute for the Warehouse 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 | Warehouse->Id | integer | int64 |\r\n| code | Warehouse->Code | string | |\r\n| description | Warehouse->Description | string | |\r\n", "operationId": "LookupWarehouseAttributeWarehouse", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Warehouse collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/WarehouseAttributeWarehouseLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Attributes/Batch/{ids}": { "get": { "tags": [ "Warehouse Attribute" ], "summary": "Get a collection of Warehouse 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| warehouseId | WarehouseAttribute->Warehouse_Id | integer | int64 |\r\n| warehouseCode | WarehouseAttribute->Warehouse_Code | string | |\r\n| warehouseDescription | WarehouseAttribute->Warehouse_Description | string | |\r\n| createdByUserId | WarehouseAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WarehouseAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WarehouseAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | WarehouseAttribute->CreatedOn | string | date-time |\r\n| isActive | WarehouseAttribute->IsActive | boolean | |\r\n| modifiedByUserId | WarehouseAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WarehouseAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WarehouseAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WarehouseAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | WarehouseAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WarehouseAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WarehouseAttribute->PermissionTree_Description | string | |\r\n| version | WarehouseAttribute->Version | integer | int32 |\r\n| id | WarehouseAttribute->Id | integer | int64 |\r\n| attributeId | WarehouseAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | WarehouseAttribute->Attribute_Code | string | |\r\n| attributeDescription | WarehouseAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | WarehouseAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | WarehouseAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | WarehouseAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | WarehouseAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | WarehouseAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | WarehouseAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | WarehouseAttribute->Notes | string | |\r\n| predefinedValueId | WarehouseAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | WarehouseAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | WarehouseAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | WarehouseAttribute->SequenceNumber | integer | int32 |\r\n| value | WarehouseAttribute->Value | object | composite |\r\n", "operationId": "BatchGetWarehouseAttribute", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Warehouse Attribute id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Warehouse Attribute collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetWarehouseAttributeResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Attributes/Batch": { "post": { "tags": [ "Warehouse Attribute" ], "summary": "Create a new collection of Warehouse 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| warehouseId | WarehouseAttribute->Warehouse_Id | integer | int64 |\r\n| attributeId | WarehouseAttribute->Attribute_Id | integer | int64 |\r\n| value | WarehouseAttribute->Value | object | composite |\r\n| predefinedValueId | WarehouseAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | WarehouseAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | WarehouseAttribute->SequenceNumber | integer | int32 |\r\n| notes | WarehouseAttribute->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| warehouseId | Required | True | |\r\n| warehouseId | 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": "BatchCreateWarehouseAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateWarehouseAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Warehouse Attribute batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Warehouse Attribute" ], "summary": "Update a collection of existing Warehouse 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 | WarehouseAttribute->Id | integer | int64 |\r\n| version | WarehouseAttribute->Version | integer | int32 |\r\n| value | WarehouseAttribute->Value | object | composite |\r\n| predefinedValueId | WarehouseAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | WarehouseAttribute->SequenceNumber | integer | int32 |\r\n| notes | WarehouseAttribute->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": "BatchUpdateWarehouseAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateWarehouseAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Warehouse Attribute batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Warehouse Attribute" ], "summary": "Delete a collection of existing Warehouse 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 | WarehouseAttribute->Id | integer | int64 |\r\n| version | WarehouseAttribute->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": "BatchDeleteWarehouseAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteWarehouseAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Warehouse Attribute batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Attributes/{id}/Active": { "patch": { "tags": [ "Warehouse Attribute" ], "summary": "Change the IsActive status for an existing Warehouse 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 | WarehouseAttribute->Version | integer | int32 |\r\n| isActive | WarehouseAttribute->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": "ChangeWarehouseAttributeIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Warehouse Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeWarehouseAttributeIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Warehouse Attribute" ], "summary": "Change the PermissionTree for an existing Warehouse 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 | WarehouseAttribute->Version | integer | int32 |\r\n| permissionTreeId | WarehouseAttribute->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": "ChangeWarehouseAttributePermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Warehouse Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeWarehouseAttributePermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Warehouse Attribute" ], "summary": "Change the PermissionTree status for a collection of existing Warehouse 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 | WarehouseAttribute->Id | integer | int64 |\r\n| version | WarehouseAttribute->Version | integer | int32 |\r\n| permissionTreeId | WarehouseAttribute->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": "BatchChangeWarehouseAttributePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeWarehouseAttributePermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Attributes/Batch/Active": { "patch": { "tags": [ "Warehouse Attribute" ], "summary": "Change the IsActive status for a collection of existing Warehouse 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 | WarehouseAttribute->Id | integer | int64 |\r\n| version | WarehouseAttribute->Version | integer | int32 |\r\n| isActive | WarehouseAttribute->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": "BatchChangeWarehouseAttributeIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeWarehouseAttributeIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Documents/{id}": { "get": { "tags": [ "Warehouse Document" ], "summary": "Get a Warehouse 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| warehouseId | WarehouseDocument->Warehouse_Id | integer | int64 |\r\n| warehouseCode | WarehouseDocument->Warehouse_Code | string | |\r\n| warehouseDescription | WarehouseDocument->Warehouse_Description | string | |\r\n| isActive | WarehouseDocument->IsActive | boolean | |\r\n| createdByUserId | WarehouseDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WarehouseDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WarehouseDocument->CreatedByUser_FullName | string | |\r\n| createdOn | WarehouseDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | WarehouseDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WarehouseDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WarehouseDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WarehouseDocument->ModifiedOn | string | date-time |\r\n| version | WarehouseDocument->Version | integer | int32 |\r\n| permissionTreeId | WarehouseDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WarehouseDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WarehouseDocument->PermissionTree_Description | string | |\r\n| id | WarehouseDocument->Id | integer | int64 |\r\n| documentRecordId | WarehouseDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | WarehouseDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | WarehouseDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | WarehouseDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | WarehouseDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | WarehouseDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | WarehouseDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | WarehouseDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | WarehouseDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | WarehouseDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | WarehouseDocument->Notes | string | |\r\n| sequenceNumber | WarehouseDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetWarehouseDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Warehouse Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Warehouse Document", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetWarehouseDocumentResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Warehouse Document" ], "summary": "Update an existing Warehouse 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 | WarehouseDocument->Version | integer | int32 |\r\n| sequenceNumber | WarehouseDocument->SequenceNumber | integer | int32 |\r\n| notes | WarehouseDocument->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": "UpdateWarehouseDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Warehouse Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateWarehouseDocumentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Warehouse Document was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Warehouse Document" ], "summary": "Delete an existing Warehouse 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 | WarehouseDocument->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": "DeleteWarehouseDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Warehouse Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteWarehouseDocumentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Warehouse Document was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/{id}/Documents": { "get": { "tags": [ "Warehouse Document" ], "summary": "Get a collection of Warehouse Document resources for the Warehouse.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WarehouseDocument->Id | integer | int64 |\r\n| version | WarehouseDocument->Version | integer | int32 |\r\n| sequenceNumber | WarehouseDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | WarehouseDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | WarehouseDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | WarehouseDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | WarehouseDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | WarehouseDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | WarehouseDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | WarehouseDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetWarehouseDocumentCollectionForWarehouse", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Warehouse Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Warehouse Document collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetWarehouseDocumentCollectionForWarehouseResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Documents": { "get": { "tags": [ "Warehouse Document" ], "summary": "Get a collection of Warehouse 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 | WarehouseDocument->Id | integer | int64 |\r\n| version | WarehouseDocument->Version | integer | int32 |\r\n| warehouseId | WarehouseDocument->Warehouse_Id | integer | int64 |\r\n| warehouseCode | WarehouseDocument->Warehouse_Code | string | |\r\n| warehouseDescription | WarehouseDocument->Warehouse_Description | string | |\r\n| sequenceNumber | WarehouseDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | WarehouseDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | WarehouseDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | WarehouseDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | WarehouseDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | WarehouseDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | WarehouseDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | WarehouseDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetWarehouseDocumentCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Warehouse Document collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetWarehouseDocumentCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Warehouse Document" ], "summary": "Create a new Warehouse 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| warehouseId | WarehouseDocument->Warehouse_Id | integer | int64 |\r\n| documentRecordId | WarehouseDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | WarehouseDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | WarehouseDocument->SequenceNumber | integer | int32 |\r\n| notes | WarehouseDocument->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| warehouseId | Required | True | |\r\n| warehouseId | 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": "CreateWarehouseDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateWarehouseDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Documents/Lookups/LookupWarehouseDocumentChangePermissionTree": { "get": { "tags": [ "Warehouse Document" ], "summary": "Lookup the permission set for changing the Warehouse 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": "LookupWarehouseDocumentChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/WarehouseDocumentChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Documents/Lookups/LookupWarehouseDocument": { "get": { "tags": [ "Warehouse Document" ], "summary": "Warehouse 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": "LookupWarehouseDocument", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Document Record collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/WarehouseDocumentDocumentLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Documents/Lookups/LookupWarehouseDocumentInsertPermissionTree": { "get": { "tags": [ "Warehouse Document" ], "summary": "Lookup the permission set for creating the Warehouse 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": "LookupWarehouseDocumentInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/WarehouseDocumentInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Documents/Lookups/LookupWarehouseDocumentWarehouse": { "get": { "tags": [ "Warehouse Document" ], "summary": "Lookup the Warehouse Document for the Warehouse 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 | Warehouse->Id | integer | int64 |\r\n| code | Warehouse->Code | string | |\r\n| description | Warehouse->Description | string | |\r\n", "operationId": "LookupWarehouseDocumentWarehouse", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Warehouse collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/WarehouseDocumentWarehouseLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Documents/Batch/{ids}": { "get": { "tags": [ "Warehouse Document" ], "summary": "Get a collection of Warehouse 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| warehouseId | WarehouseDocument->Warehouse_Id | integer | int64 |\r\n| warehouseCode | WarehouseDocument->Warehouse_Code | string | |\r\n| warehouseDescription | WarehouseDocument->Warehouse_Description | string | |\r\n| isActive | WarehouseDocument->IsActive | boolean | |\r\n| createdByUserId | WarehouseDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WarehouseDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WarehouseDocument->CreatedByUser_FullName | string | |\r\n| createdOn | WarehouseDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | WarehouseDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WarehouseDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WarehouseDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WarehouseDocument->ModifiedOn | string | date-time |\r\n| version | WarehouseDocument->Version | integer | int32 |\r\n| permissionTreeId | WarehouseDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WarehouseDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WarehouseDocument->PermissionTree_Description | string | |\r\n| id | WarehouseDocument->Id | integer | int64 |\r\n| documentRecordId | WarehouseDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | WarehouseDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | WarehouseDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | WarehouseDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | WarehouseDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | WarehouseDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | WarehouseDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | WarehouseDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | WarehouseDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | WarehouseDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | WarehouseDocument->Notes | string | |\r\n| sequenceNumber | WarehouseDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetWarehouseDocument", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Warehouse Document id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Warehouse Document collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetWarehouseDocumentResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Documents/Batch": { "post": { "tags": [ "Warehouse Document" ], "summary": "Create a new collection of Warehouse 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| warehouseId | WarehouseDocument->Warehouse_Id | integer | int64 |\r\n| documentRecordId | WarehouseDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | WarehouseDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | WarehouseDocument->SequenceNumber | integer | int32 |\r\n| notes | WarehouseDocument->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| warehouseId | Required | True | |\r\n| warehouseId | 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": "BatchCreateWarehouseDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateWarehouseDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Warehouse Document batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Warehouse Document" ], "summary": "Update a collection of existing Warehouse 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 | WarehouseDocument->Id | integer | int64 |\r\n| version | WarehouseDocument->Version | integer | int32 |\r\n| sequenceNumber | WarehouseDocument->SequenceNumber | integer | int32 |\r\n| notes | WarehouseDocument->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": "BatchUpdateWarehouseDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateWarehouseDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Warehouse Document batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Warehouse Document" ], "summary": "Delete a collection of existing Warehouse 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 | WarehouseDocument->Id | integer | int64 |\r\n| version | WarehouseDocument->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": "BatchDeleteWarehouseDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteWarehouseDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Warehouse Document batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Documents/{id}/Active": { "patch": { "tags": [ "Warehouse Document" ], "summary": "Change the IsActive status for an existing Warehouse 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 | WarehouseDocument->Version | integer | int32 |\r\n| isActive | WarehouseDocument->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": "ChangeWarehouseDocumentIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Warehouse Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeWarehouseDocumentIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Warehouse Document" ], "summary": "Change the PermissionTree for an existing Warehouse 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 | WarehouseDocument->Version | integer | int32 |\r\n| permissionTreeId | WarehouseDocument->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": "ChangeWarehouseDocumentPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Warehouse Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeWarehouseDocumentPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Warehouse Document" ], "summary": "Change the PermissionTree status for a collection of existing Warehouse 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 | WarehouseDocument->Id | integer | int64 |\r\n| version | WarehouseDocument->Version | integer | int32 |\r\n| permissionTreeId | WarehouseDocument->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": "BatchChangeWarehouseDocumentPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeWarehouseDocumentPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/MM/Warehouses/Documents/Batch/Active": { "patch": { "tags": [ "Warehouse Document" ], "summary": "Change the IsActive status for a collection of existing Warehouse 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 | WarehouseDocument->Id | integer | int64 |\r\n| version | WarehouseDocument->Version | integer | int32 |\r\n| isActive | WarehouseDocument->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": "BatchChangeWarehouseDocumentIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeWarehouseDocumentIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } } }, "components": { "schemas": { "OperationExecutionMode": { "type": "string", "description": "", "x-enumNames": [ "AllOrNone", "PerRecord" ], "enum": [ "AllOrNone", "PerRecord" ] }, "SeverityType": { "type": "string", "description": "", "nullable": false, "x-enumNames": [ "Error", "Warning", "Information" ], "enum": [ "error", "warning", "information" ] }, "NotificationItemSchema": { "title": "NotificationItemSchema", "type": "object", "additionalProperties": false, "properties": { "code": { "title": "code", "type": "string", "description": "Unique code for message", "nullable": false }, "message": { "title": "message", "type": "string", "nullable": false }, "objectId": { "title": "objectId", "type": "string", "description": "Optional id of record to which the message applies", "nullable": true }, "objectType": { "title": "objectType", "type": "string", "format": "enum", "nullable": true, "x-formatSpecifier": "EntityType" }, "properties": { "title": "properties", "type": "array", "description": "Collection of properties referenced by the message using property path syntax", "nullable": true, "example": [ "Asset->Code" ], "items": { "type": "string" } }, "severity": { "$ref": "#/components/schemas/SeverityType" }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Optional provided unique external record identifier to echo back with message", "nullable": true } } }, "NotificationSchema": { "title": "NotificationSchema", "type": "object", "additionalProperties": false, "properties": { "messages": { "title": "messages", "type": "array", "description": "Collection of messages", "nullable": false, "items": { "$ref": "#/components/schemas/NotificationItemSchema" } } } }, "EntityPermissionViolationSchema": { "type": "object", "additionalProperties": false, "required": [ "permissionTreeId" ], "properties": { "permissionId": { "type": "integer", "format": "int64" }, "permissionTreeId": { "type": "integer", "format": "int64", "nullable": true }, "propertyPaths": { "type": "array", "items": { "type": "string" } } } }, "EntityPhraseTranslationSchema": { "type": "object", "additionalProperties": false, "required": [ "translation" ], "properties": { "phrase": { "type": "string" }, "translation": { "type": "string", "nullable": true }, "propertyPaths": { "type": "array", "items": { "type": "string" } } } }, "Link": { "type": "object", "additionalProperties": false, "required": [ "href", "method" ], "properties": { "doc": { "type": "string", "description": "Documentation endpoint that describes the link", "nullable": true }, "href": { "type": "string", "description": "Endpoint to invoke link", "minLength": 1 }, "mapping": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "method": { "type": "string", "description": "HTTP method used for link", "minLength": 1 }, "module": { "type": "string", "description": "Module used by link", "nullable": true }, "rel": { "type": "string", "nullable": true }, "resource": { "type": "string", "description": "Resource used by link", "nullable": true }, "resourceAction": { "type": "string", "description": "Resource Action used by link", "nullable": true }, "title": { "type": "string", "description": "Title", "nullable": true }, "type": { "description": "Type of link", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ResourceLinkType" } ] } } }, "LinkMapping": { "type": "object", "additionalProperties": false, "required": [ "source" ], "properties": { "source": { "type": "string" }, "target": { "type": "string", "nullable": true } } }, "ResourceLinkType": { "type": "string", "description": "", "x-enumNames": [ "Association", "PrimaryAction", "CustomAction", "Collection", "Detail", "Lookup", "Documentation", "Navigation", "Specification" ], "enum": [ "association", "primaryAction", "customAction", "collection", "detail", "lookup", "documentation", "navigation", "specification" ] }, "GetCategoryResourceActionResponse": { "title": "GetCategoryResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetCategoryResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Category->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Category->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "Category->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "Category->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Category->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "Category->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Category->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "Category->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "Category->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Category->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Category->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "Category->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "Category->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Category->Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Category->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Category->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetCategoryCollectionResourceActionResponse": { "title": "GetCategoryCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetCategoryCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetCategoryCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Category->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Category->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Category->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Category->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Category->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Category->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CategoryChangePermissionTreeLookupResourceActionResponse": { "title": "CategoryChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CategoryChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "CategoryChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CategoryInsertPermissionTreeLookupResourceActionResponse": { "title": "CategoryInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CategoryInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "CategoryInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateCategoryResourceActionRequest": { "title": "CreateCategoryResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateCategoryResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Category->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "Category->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "Category->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Category->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Category->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "PatchOperationType": { "type": "string", "description": "", "nullable": true, "x-enumNames": [ "Replace", "Add", "Remove" ], "enum": [ "replace", "add", "remove" ] }, "EntityPatchOperationSchema": { "type": "object", "additionalProperties": false, "required": [ "path", "value" ], "properties": { "op": { "title": "op", "description": "Type of operation to apply", "example": "replace", "$ref": "#/components/schemas/PatchOperationType" }, "path": { "title": "path", "type": "string", "description": "Property path for the property being updated", "nullable": false, "example": "Asset->Code" }, "value": { "title": "value", "type": "object", "description": "Value for the property being updated", "nullable": true, "example": "BOILER", "additionalProperties": false } } }, "UpdateCategoryResourceActionRequest": { "title": "UpdateCategoryResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "Category->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "Category->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Category->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Category->Notes" } ] } } }, "DeleteCategoryResourceActionRequest": { "title": "DeleteCategoryResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetCategoryResourceAction": { "title": "BatchGetCategoryResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Category entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Category entities", "items": { "$ref": "#/components/schemas/GetCategoryResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateCategoryResourceActionRequest": { "title": "BatchCreateCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateCategoryResourceActionRequest" } }, "BatchUpdateCategoryResourceActionRequest": { "title": "BatchUpdateCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateCategoryResourceActionRequest" } }, "BatchDeleteCategoryResourceActionRequest": { "title": "BatchDeleteCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteCategoryResourceActionRequest" } }, "ChangeCategoryIsActiveResourceActionRequest": { "title": "ChangeCategoryIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "Category->IsActive" } ] } } }, "ChangeCategoryPermissionTreeResourceActionRequest": { "title": "ChangeCategoryPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Category->PermissionTree_Id" } ] } } }, "BatchChangeCategoryIsActiveResourceActionRequest": { "title": "BatchChangeCategoryIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeCategoryIsActiveResourceActionRequest" } }, "BatchChangeCategoryPermissionTreeResourceActionRequest": { "title": "BatchChangeCategoryPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeCategoryPermissionTreeResourceActionRequest" } }, "GetCommodityResourceActionResponse": { "title": "GetCommodityResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetCommodityResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Commodity->Code" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "Commodity->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Commodity->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "Commodity->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "Commodity->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Commodity->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Commodity->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "Commodity->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "Commodity->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Commodity->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Commodity->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "Commodity->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "Commodity->PermissionTree_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Commodity->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "nullable": true, "x-propertyPath": "Commodity->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "nullable": true, "x-propertyPath": "Commodity->CostElement_Description" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Commodity->Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Commodity->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Commodity->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetCommodityCollectionResourceActionResponse": { "title": "GetCommodityCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetCommodityCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetCommodityCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Commodity->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Commodity->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Commodity->SequenceNumber" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Commodity->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "nullable": false, "x-propertyPath": "Commodity->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "nullable": false, "x-propertyPath": "Commodity->CostElement_Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Commodity->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Commodity->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Commodity->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CommodityChangePermissionTreeLookupResourceActionResponse": { "title": "CommodityChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CommodityChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "CommodityChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CommodityCostElementLookupResourceActionResponse": { "title": "CommodityCostElementLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CommodityCostElementLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "CommodityCostElementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "CostElement->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "CostElement->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CommodityInsertPermissionTreeLookupResourceActionResponse": { "title": "CommodityInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CommodityInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "CommodityInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateCommodityResourceActionRequest": { "title": "CreateCommodityResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateCommodityResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "permissionTreeId", "code", "description", "costElementId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Commodity->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "Commodity->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "Commodity->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Commodity->SequenceNumber" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Commodity->CostElement_Id" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Commodity->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateCommodityResourceActionRequest": { "title": "UpdateCommodityResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "Commodity->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "Commodity->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Commodity->SequenceNumber" }, { "title": "costElementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Commodity->CostElement_Id" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Commodity->Notes" } ] } } }, "DeleteCommodityResourceActionRequest": { "title": "DeleteCommodityResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetCommodityResourceAction": { "title": "BatchGetCommodityResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Commodity entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Commodity entities", "items": { "$ref": "#/components/schemas/GetCommodityResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateCommodityResourceActionRequest": { "title": "BatchCreateCommodityResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateCommodityResourceActionRequest" } }, "BatchUpdateCommodityResourceActionRequest": { "title": "BatchUpdateCommodityResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateCommodityResourceActionRequest" } }, "BatchDeleteCommodityResourceActionRequest": { "title": "BatchDeleteCommodityResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteCommodityResourceActionRequest" } }, "ChangeCommodityIsActiveResourceActionRequest": { "title": "ChangeCommodityIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "Commodity->IsActive" } ] } } }, "ChangeCommodityPermissionTreeResourceActionRequest": { "title": "ChangeCommodityPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Commodity->PermissionTree_Id" } ] } } }, "BatchChangeCommodityIsActiveResourceActionRequest": { "title": "BatchChangeCommodityIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeCommodityIsActiveResourceActionRequest" } }, "BatchChangeCommodityPermissionTreeResourceActionRequest": { "title": "BatchChangeCommodityPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeCommodityPermissionTreeResourceActionRequest" } }, "GetMaterialMasterResourceActionResponse": { "title": "GetMaterialMasterResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMaterialMasterResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->Code" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MaterialMaster->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMaster->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MaterialMaster->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMaster->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MaterialMaster->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMaster->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->PermissionTree_Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->AlternativeDescription" }, "barcode": { "title": "barcode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->Barcode" }, "categoryId": { "title": "categoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMaster->Category_Id" }, "categoryCode": { "title": "categoryCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->Category_Code" }, "categoryDescription": { "title": "categoryDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->Category_Description" }, "classification": { "title": "classification", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->Classification" }, "commodityId": { "title": "commodityId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMaster->Commodity_Id" }, "commodityCode": { "title": "commodityCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->Commodity_Code" }, "commodityDescription": { "title": "commodityDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->Commodity_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMaster->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->CostElement_Description" }, "defaultMaterialMasterBinId": { "title": "defaultMaterialMasterBinId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMaster->DefaultMaterialMasterBin_Id" }, "defaultMaterialMasterBinCode": { "title": "defaultMaterialMasterBinCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->DefaultMaterialMasterBin_Code" }, "defaultMaterialMasterSupplierId": { "title": "defaultMaterialMasterSupplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMaster->DefaultMaterialMasterSupplier_Id" }, "defaultMaterialMasterSupplierSupplierId": { "title": "defaultMaterialMasterSupplierSupplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMaster->DefaultMaterialMasterSupplier_Supplier_Id" }, "defaultMaterialMasterSupplierSupplierCode": { "title": "defaultMaterialMasterSupplierSupplierCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->DefaultMaterialMasterSupplier_Supplier_Code" }, "defaultMaterialMasterSupplierSupplierDescription": { "title": "defaultMaterialMasterSupplierSupplierDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->DefaultMaterialMasterSupplier_Supplier_Description" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->Description" }, "highLifeExpectancy": { "title": "highLifeExpectancy", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "MaterialMaster->HighLifeExpectancy" }, "isInsuranceItem": { "title": "isInsuranceItem", "type": "boolean", "nullable": false, "x-propertyPath": "MaterialMaster->IsInsuranceItem" }, "isStockItem": { "title": "isStockItem", "type": "boolean", "nullable": false, "x-propertyPath": "MaterialMaster->IsStockItem" }, "itemSize": { "title": "itemSize", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->ItemSize" }, "leadTime": { "title": "leadTime", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "MaterialMaster->LeadTime" }, "lowLifeExpectancy": { "title": "lowLifeExpectancy", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "MaterialMaster->LowLifeExpectancy" }, "maximumLevel": { "title": "maximumLevel", "type": "number", "format": "float", "nullable": true, "x-propertyPath": "MaterialMaster->MaximumLevel" }, "mediumLifeExpectancy": { "title": "mediumLifeExpectancy", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "MaterialMaster->MediumLifeExpectancy" }, "minimumLevel": { "title": "minimumLevel", "type": "number", "format": "float", "nullable": true, "x-propertyPath": "MaterialMaster->MinimumLevel" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->Notes" }, "partsReplacementMethod": { "title": "partsReplacementMethod", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MaterialMaster->PartsReplacementMethod", "x-formatSpecifier": "PartsReplacementMethod" }, "replaceByDate": { "title": "replaceByDate", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MaterialMaster->ReplaceByDate" }, "replacedOnDate": { "title": "replacedOnDate", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MaterialMaster->ReplacedOnDate" }, "replaceWithMaterialMasterId": { "title": "replaceWithMaterialMasterId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMaster->ReplaceWithMaterialMaster_Id" }, "replaceWithMaterialMasterCode": { "title": "replaceWithMaterialMasterCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->ReplaceWithMaterialMaster_Code" }, "replaceWithMaterialMasterDescription": { "title": "replaceWithMaterialMasterDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->ReplaceWithMaterialMaster_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MaterialMaster->SequenceNumber" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMaster->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->UnitOfMeasurement_Description" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMaterialMasterCollectionResourceActionResponse": { "title": "GetMaterialMasterCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMaterialMasterCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMaterialMasterCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->AlternativeDescription" }, "isStockItem": { "title": "isStockItem", "type": "boolean", "nullable": false, "x-propertyPath": "MaterialMaster->IsStockItem" }, "classification": { "title": "classification", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->Classification" }, "commodityId": { "title": "commodityId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMaster->Commodity_Id" }, "commodityCode": { "title": "commodityCode", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->Commodity_Code" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMaster->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->CostElement_Code" }, "categoryId": { "title": "categoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMaster->Category_Id" }, "categoryCode": { "title": "categoryCode", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->Category_Code" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMaster->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->UnitOfMeasurement_Code" }, "defaultMaterialMasterBinId": { "title": "defaultMaterialMasterBinId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMaster->DefaultMaterialMasterBin_Id" }, "defaultMaterialMasterBinCode": { "title": "defaultMaterialMasterBinCode", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->DefaultMaterialMasterBin_Code" }, "defaultMaterialMasterSupplierSupplierId": { "title": "defaultMaterialMasterSupplierSupplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMaster->DefaultMaterialMasterSupplier_Supplier_Id" }, "defaultMaterialMasterSupplierSupplierCode": { "title": "defaultMaterialMasterSupplierSupplierCode", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->DefaultMaterialMasterSupplier_Supplier_Code" }, "defaultMaterialMasterSupplierSupplierDescription": { "title": "defaultMaterialMasterSupplierSupplierDescription", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->DefaultMaterialMasterSupplier_Supplier_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterCategoryLookupResourceActionResponse": { "title": "MaterialMasterCategoryLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterCategoryLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterCategoryLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Category->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Category->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterChangePermissionTreeLookupResourceActionResponse": { "title": "MaterialMasterChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterCommodityLookupResourceActionResponse": { "title": "MaterialMasterCommodityLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterCommodityLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterCommodityLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Commodity->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Commodity->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterCostElementLookupResourceActionResponse": { "title": "MaterialMasterCostElementLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterCostElementLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterCostElementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "CostElement->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "CostElement->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterDefaultBinLookupResourceActionResponse": { "title": "MaterialMasterDefaultBinLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterDefaultBinLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterDefaultBinLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MaterialMasterBin->Code" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterDefaultSupplierLookupResourceActionResponse": { "title": "MaterialMasterDefaultSupplierLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterDefaultSupplierLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterDefaultSupplierLookupResourceActionResponseItemProperties", "type": "object", "properties": { "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "nullable": false, "x-propertyPath": "MaterialMasterSupplier->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "nullable": false, "x-propertyPath": "MaterialMasterSupplier->Supplier_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterInsertPermissionTreeLookupResourceActionResponse": { "title": "MaterialMasterInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterLinkWarehouseLookupResourceActionResponse": { "title": "MaterialMasterLinkWarehouseLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterLinkWarehouseLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterLinkWarehouseLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Warehouse->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Warehouse->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterReplaceWithMaterialMasterLookupResourceActionResponse": { "title": "MaterialMasterReplaceWithMaterialMasterLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterReplaceWithMaterialMasterLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterReplaceWithMaterialMasterLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterUnitOfMeasurementLookupResourceActionResponse": { "title": "MaterialMasterUnitOfMeasurementLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterUnitOfMeasurementLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterUnitOfMeasurementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "UnitOfMeasurement->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "UnitOfMeasurement->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateMaterialMasterResourceActionRequest": { "title": "CreateMaterialMasterResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateMaterialMasterResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "code", "commodityId", "costElementId", "description", "isInsuranceItem", "isStockItem", "permissionTreeId", "unitOfMeasurementId" ], "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->AlternativeDescription" }, "barcode": { "title": "barcode", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "MaterialMaster->Barcode" }, "categoryId": { "title": "categoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMaster->Category_Id" }, "classification": { "title": "classification", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "MaterialMaster->Classification" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "MaterialMaster->Code" }, "commodityId": { "title": "commodityId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMaster->Commodity_Id" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMaster->CostElement_Id" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "MaterialMaster->Description" }, "highLifeExpectancy": { "title": "highLifeExpectancy", "type": "string", "format": "duration", "minimum": 0.0, "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "MaterialMaster->HighLifeExpectancy" }, "itemSize": { "title": "itemSize", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "MaterialMaster->ItemSize" }, "isInsuranceItem": { "title": "isInsuranceItem", "type": "boolean", "nullable": false, "x-propertyPath": "MaterialMaster->IsInsuranceItem" }, "isStockItem": { "title": "isStockItem", "type": "boolean", "nullable": false, "x-propertyPath": "MaterialMaster->IsStockItem" }, "leadTime": { "title": "leadTime", "type": "string", "format": "duration", "minimum": 0.0, "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "MaterialMaster->LeadTime" }, "lowLifeExpectancy": { "title": "lowLifeExpectancy", "type": "string", "format": "duration", "minimum": 0.0, "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "MaterialMaster->LowLifeExpectancy" }, "maximumLevel": { "title": "maximumLevel", "type": "number", "format": "float", "minimum": 0.0, "nullable": true, "x-propertyPath": "MaterialMaster->MaximumLevel" }, "mediumLifeExpectancy": { "title": "mediumLifeExpectancy", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "MaterialMaster->MediumLifeExpectancy" }, "minimumLevel": { "title": "minimumLevel", "type": "number", "format": "float", "minimum": 0.0, "nullable": true, "x-propertyPath": "MaterialMaster->MinimumLevel" }, "notes": { "title": "notes", "type": "string", "minLength": 1, "nullable": true, "x-propertyPath": "MaterialMaster->Notes" }, "partsReplacementMethod": { "title": "partsReplacementMethod", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MaterialMaster->PartsReplacementMethod", "x-formatSpecifier": "PartsReplacementMethod" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMaster->PermissionTree_Id" }, "replaceWithMaterialMasterId": { "title": "replaceWithMaterialMasterId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMaster->ReplaceWithMaterialMaster_Id" }, "replaceByDate": { "title": "replaceByDate", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MaterialMaster->ReplaceByDate" }, "replacedOnDate": { "title": "replacedOnDate", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MaterialMaster->ReplacedOnDate" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MaterialMaster->SequenceNumber" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMaster->UnitOfMeasurement_Id" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateMaterialMasterResourceActionRequest": { "title": "UpdateMaterialMasterResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "alternativeDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->AlternativeDescription" }, { "title": "barcode", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "MaterialMaster->Barcode" }, { "title": "categoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMaster->Category_Id" }, { "title": "classification", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "MaterialMaster->Classification" }, { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "MaterialMaster->Code" }, { "title": "commodityId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMaster->Commodity_Id" }, { "title": "costElementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMaster->CostElement_Id" }, { "title": "defaultMaterialMasterBinId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMaster->DefaultMaterialMasterBin_Id" }, { "title": "defaultMaterialMasterSupplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMaster->DefaultMaterialMasterSupplier_Id" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "MaterialMaster->Description" }, { "title": "highLifeExpectancy", "type": "string", "format": "duration", "minimum": 0.0, "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "MaterialMaster->HighLifeExpectancy" }, { "title": "itemSize", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "MaterialMaster->ItemSize" }, { "title": "isInsuranceItem", "type": "boolean", "nullable": false, "x-propertyPath": "MaterialMaster->IsInsuranceItem" }, { "title": "isStockItem", "type": "boolean", "nullable": false, "x-propertyPath": "MaterialMaster->IsStockItem" }, { "title": "leadTime", "type": "string", "format": "duration", "minimum": 0.0, "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "MaterialMaster->LeadTime" }, { "title": "lowLifeExpectancy", "type": "string", "format": "duration", "minimum": 0.0, "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "MaterialMaster->LowLifeExpectancy" }, { "title": "maximumLevel", "type": "number", "format": "float", "minimum": 0.0, "nullable": true, "x-propertyPath": "MaterialMaster->MaximumLevel" }, { "title": "mediumLifeExpectancy", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "MaterialMaster->MediumLifeExpectancy" }, { "title": "minimumLevel", "type": "number", "format": "float", "minimum": 0.0, "nullable": true, "x-propertyPath": "MaterialMaster->MinimumLevel" }, { "title": "notes", "type": "string", "minLength": 1, "nullable": true, "x-propertyPath": "MaterialMaster->Notes" }, { "title": "partsReplacementMethod", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MaterialMaster->PartsReplacementMethod", "x-formatSpecifier": "PartsReplacementMethod" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MaterialMaster->SequenceNumber" }, { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMaster->UnitOfMeasurement_Id" }, { "title": "replaceWithMaterialMasterId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMaster->ReplaceWithMaterialMaster_Id" }, { "title": "replaceByDate", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MaterialMaster->ReplaceByDate" }, { "title": "replacedOnDate", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MaterialMaster->ReplacedOnDate" } ] } } }, "DeleteMaterialMasterResourceActionRequest": { "title": "DeleteMaterialMasterResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetMaterialMasterResourceAction": { "title": "BatchGetMaterialMasterResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Material Master entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Material Master entities", "items": { "$ref": "#/components/schemas/GetMaterialMasterResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateMaterialMasterResourceActionRequest": { "title": "BatchCreateMaterialMasterResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateMaterialMasterResourceActionRequest" } }, "BatchUpdateMaterialMasterResourceActionRequest": { "title": "BatchUpdateMaterialMasterResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateMaterialMasterResourceActionRequest" } }, "BatchDeleteMaterialMasterResourceActionRequest": { "title": "BatchDeleteMaterialMasterResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteMaterialMasterResourceActionRequest" } }, "ChangeMaterialMasterIsActiveResourceActionRequest": { "title": "ChangeMaterialMasterIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MaterialMaster->IsActive" } ] } } }, "ChangeMaterialMasterPermissionTreeResourceActionRequest": { "title": "ChangeMaterialMasterPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMaster->PermissionTree_Id" } ] } } }, "MaterialMasterLinkWarehouseResourceActionRequest": { "title": "MaterialMasterLinkWarehouseResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "MaterialMasterLinkWarehouseResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "sourceMaterialMasterIds", "targetWarehouseIds" ], "properties": { "sourceMaterialMasterIds": { "title": "sourceMaterialMasterIds", "type": "array", "format": "array", "nullable": false, "items": { "type": "integer" }, "x-propertyPath": "MaterialMasterLinkWarehouse->SourceMaterialMasterIds", "x-formatSpecifier": "Int64" }, "targetWarehouseIds": { "title": "targetWarehouseIds", "type": "array", "format": "array", "nullable": false, "items": { "type": "integer" }, "x-propertyPath": "MaterialMasterLinkWarehouse->TargetWarehouseIds", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "BatchChangeMaterialMasterIsActiveResourceActionRequest": { "title": "BatchChangeMaterialMasterIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMaterialMasterIsActiveResourceActionRequest" } }, "BatchChangeMaterialMasterPermissionTreeResourceActionRequest": { "title": "BatchChangeMaterialMasterPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMaterialMasterPermissionTreeResourceActionRequest" } }, "DynamicValueSchema": { "title": "DynamicValueSchema", "type": "object", "additionalProperties": false, "properties": { "type": { "title": "type", "type": "string", "format": "enum", "nullable": false, "x-formatSpecifier": "DynamicValueType", "x-enumNames": [ "String", "Email", "Integer", "Long", "Float", "Currency", "DateTime", "Date", "Time", "Duration", "Boolean" ] }, "value": { "title": "value", "type": "object", "additionalProperties": false } } }, "GetMaterialMasterAttributeResourceActionResponse": { "title": "GetMaterialMasterAttributeResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMaterialMasterAttributeResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterAttribute->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->MaterialMaster_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MaterialMasterAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MaterialMasterAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "MaterialMasterAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "MaterialMasterAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "MaterialMasterAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "MaterialMasterAttribute->Value", "x-formatSpecifier": "DynamicValue" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMaterialMasterAttributeCollectionForMaterialMasterResourceActionResponse": { "title": "GetMaterialMasterAttributeCollectionForMaterialMasterResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMaterialMasterAttributeCollectionForMaterialMasterResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMaterialMasterAttributeCollectionForMaterialMasterResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": false, "x-propertyPath": "MaterialMasterAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": false, "x-propertyPath": "MaterialMasterAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MaterialMasterAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "MaterialMasterAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "MaterialMasterAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MaterialMasterAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MaterialMasterAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMaterialMasterAttributeCollectionResourceActionResponse": { "title": "GetMaterialMasterAttributeCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMaterialMasterAttributeCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMaterialMasterAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->SequenceNumber" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "MaterialMasterAttribute->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "nullable": false, "x-propertyPath": "MaterialMasterAttribute->MaterialMaster_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": false, "x-propertyPath": "MaterialMasterAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": false, "x-propertyPath": "MaterialMasterAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MaterialMasterAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "MaterialMasterAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "MaterialMasterAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MaterialMasterAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MaterialMasterAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "MaterialMasterAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "value": { "title": "value", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterAttributeAttributeLookupResourceActionResponse": { "title": "MaterialMasterAttributeAttributeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterAttributeAttributeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterAttributeAttributeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Attribute->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Attribute->Description" }, "allowAnyValue": { "title": "allowAnyValue", "type": "boolean", "nullable": false, "x-propertyPath": "Attribute->AllowAnyValue" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Attribute->DataType", "x-formatSpecifier": "DynamicValueType" }, "defaultValue": { "title": "defaultValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, "defaultAllowedValueId": { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id" }, "defaultAllowedValueValue": { "title": "defaultAllowedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultAllowedValueDescription": { "title": "defaultAllowedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Description" }, "explanation": { "title": "explanation", "type": "string", "nullable": true, "x-propertyPath": "Attribute->Explanation" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "MaterialMasterAttributeChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterAttributeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "MaterialMasterAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterAttributeMaterialMasterLookupResourceActionResponse": { "title": "MaterialMasterAttributeMaterialMasterLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterAttributeMaterialMasterLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterAttributeMaterialMasterLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateMaterialMasterAttributeResourceActionRequest": { "title": "CreateMaterialMasterAttributeResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateMaterialMasterAttributeResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "materialMasterId", "attributeId" ], "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterAttribute->MaterialMaster_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "MaterialMasterAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateMaterialMasterAttributeResourceActionRequest": { "title": "UpdateMaterialMasterAttributeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "value", "format": "composite", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterAttribute->Notes" } ] } } }, "DeleteMaterialMasterAttributeResourceActionRequest": { "title": "DeleteMaterialMasterAttributeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetMaterialMasterAttributeResourceAction": { "title": "BatchGetMaterialMasterAttributeResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Material Master Attribute entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Material Master Attribute entities", "items": { "$ref": "#/components/schemas/GetMaterialMasterAttributeResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateMaterialMasterAttributeResourceActionRequest": { "title": "BatchCreateMaterialMasterAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateMaterialMasterAttributeResourceActionRequest" } }, "BatchUpdateMaterialMasterAttributeResourceActionRequest": { "title": "BatchUpdateMaterialMasterAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateMaterialMasterAttributeResourceActionRequest" } }, "BatchDeleteMaterialMasterAttributeResourceActionRequest": { "title": "BatchDeleteMaterialMasterAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteMaterialMasterAttributeResourceActionRequest" } }, "ChangeMaterialMasterAttributeIsActiveResourceActionRequest": { "title": "ChangeMaterialMasterAttributeIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MaterialMasterAttribute->IsActive" } ] } } }, "ChangeMaterialMasterAttributePermissionTreeResourceActionRequest": { "title": "ChangeMaterialMasterAttributePermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterAttribute->PermissionTree_Id" } ] } } }, "BatchChangeMaterialMasterAttributeIsActiveResourceActionRequest": { "title": "BatchChangeMaterialMasterAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMaterialMasterAttributeIsActiveResourceActionRequest" } }, "BatchChangeMaterialMasterAttributePermissionTreeResourceActionRequest": { "title": "BatchChangeMaterialMasterAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMaterialMasterAttributePermissionTreeResourceActionRequest" } }, "GetMaterialMasterBinResourceActionResponse": { "title": "GetMaterialMasterBinResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMaterialMasterBinResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MaterialMasterBin->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterBin->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterBin->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterBin->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MaterialMasterBin->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterBin->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterBin->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterBin->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MaterialMasterBin->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterBin->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterBin->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterBin->PermissionTree_Description" }, "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MaterialMasterBin->Code" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterBin->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterBin->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterBin->MaterialMaster_Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterBin->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MaterialMasterBin->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMaterialMasterBinCollectionResourceActionResponse": { "title": "GetMaterialMasterBinCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMaterialMasterBinCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMaterialMasterBinCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterCode": { "title": "materialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "MaterialMasterBin->MaterialMaster_Code" }, "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MaterialMasterBin->Code" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MaterialMasterBin->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterBin->Notes" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMaterialMasterBinForMaterialMasterCollectionResourceActionResponse": { "title": "GetMaterialMasterBinForMaterialMasterCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMaterialMasterBinForMaterialMasterCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMaterialMasterBinForMaterialMasterCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MaterialMasterBin->Code" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterBin->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MaterialMasterBin->SequenceNumber" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterBinChangePermissionTreeLookupResourceActionResponse": { "title": "MaterialMasterBinChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterBinChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterBinChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterBinInsertPermissionTreeLookupResourceActionResponse": { "title": "MaterialMasterBinInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterBinInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterBinInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterBinMaterialMasterLookupResourceActionResponse": { "title": "MaterialMasterBinMaterialMasterLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterBinMaterialMasterLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterBinMaterialMasterLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateMaterialMasterBinResourceActionRequest": { "title": "CreateMaterialMasterBinResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateMaterialMasterBinResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "materialMasterId", "code" ], "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterBin->MaterialMaster_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "MaterialMasterBin->Code" }, "notes": { "title": "notes", "type": "string", "minLength": 1, "nullable": true, "x-propertyPath": "MaterialMasterBin->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterBin->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MaterialMasterBin->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateMaterialMasterBinResourceActionRequest": { "title": "UpdateMaterialMasterBinResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "MaterialMasterBin->Code" }, { "title": "notes", "type": "string", "minLength": 1, "nullable": true, "x-propertyPath": "MaterialMasterBin->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MaterialMasterBin->SequenceNumber" } ] } } }, "DeleteMaterialMasterBinResourceActionRequest": { "title": "DeleteMaterialMasterBinResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetMaterialMasterBinResourceAction": { "title": "BatchGetMaterialMasterBinResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Material Master Bin entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Material Master Bin entities", "items": { "$ref": "#/components/schemas/GetMaterialMasterBinResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateMaterialMasterBinResourceActionRequest": { "title": "BatchCreateMaterialMasterBinResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateMaterialMasterBinResourceActionRequest" } }, "BatchUpdateMaterialMasterBinResourceActionRequest": { "title": "BatchUpdateMaterialMasterBinResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateMaterialMasterBinResourceActionRequest" } }, "BatchDeleteMaterialMasterBinResourceActionRequest": { "title": "BatchDeleteMaterialMasterBinResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteMaterialMasterBinResourceActionRequest" } }, "ChangeMaterialMasterBinIsActiveResourceActionRequest": { "title": "ChangeMaterialMasterBinIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MaterialMasterBin->IsActive" } ] } } }, "ChangeMaterialMasterBinPermissionTreeResourceActionRequest": { "title": "ChangeMaterialMasterBinPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterBin->PermissionTree_Id" } ] } } }, "BatchChangeMaterialMasterBinIsActiveResourceActionRequest": { "title": "BatchChangeMaterialMasterBinIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMaterialMasterBinIsActiveResourceActionRequest" } }, "BatchChangeMaterialMasterBinPermissionTreeResourceActionRequest": { "title": "BatchChangeMaterialMasterBinPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMaterialMasterBinPermissionTreeResourceActionRequest" } }, "GetMaterialMasterDocumentResourceActionResponse": { "title": "GetMaterialMasterDocumentResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMaterialMasterDocumentResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterDocument->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterDocument->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterDocument->MaterialMaster_Description" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": true, "x-propertyPath": "MaterialMasterDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MaterialMasterDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MaterialMasterDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MaterialMasterDocument->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMaterialMasterDocumentCollectionForMaterialMasterResourceActionResponse": { "title": "GetMaterialMasterDocumentCollectionForMaterialMasterResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMaterialMasterDocumentCollectionForMaterialMasterResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMaterialMasterDocumentCollectionForMaterialMasterResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MaterialMasterDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": false, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": false, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_FileType_Extension" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMaterialMasterDocumentCollectionResourceActionResponse": { "title": "GetMaterialMasterDocumentCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMaterialMasterDocumentCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMaterialMasterDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterDocument->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "MaterialMasterDocument->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "nullable": false, "x-propertyPath": "MaterialMasterDocument->MaterialMaster_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MaterialMasterDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": false, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": false, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_FileType_Extension" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "MaterialMasterDocumentChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterDocumentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterDocumentDocumentLookupResourceActionResponse": { "title": "MaterialMasterDocumentDocumentLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterDocumentDocumentLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterDocumentDocumentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "DocumentRecord->Description" }, "fileLocation": { "title": "fileLocation", "type": "string", "nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, "fileFullName": { "title": "fileFullName", "type": "string", "nullable": true, "x-propertyPath": "DocumentRecord->FileFullName" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "MaterialMasterDocumentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterDocumentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterDocumentMaterialMasterLookupResourceActionResponse": { "title": "MaterialMasterDocumentMaterialMasterLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterDocumentMaterialMasterLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterDocumentMaterialMasterLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateMaterialMasterDocumentResourceActionRequest": { "title": "CreateMaterialMasterDocumentResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateMaterialMasterDocumentResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "materialMasterId", "documentRecordId" ], "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterDocument->MaterialMaster_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MaterialMasterDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateMaterialMasterDocumentResourceActionRequest": { "title": "UpdateMaterialMasterDocumentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MaterialMasterDocument->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterDocument->Notes" } ] } } }, "DeleteMaterialMasterDocumentResourceActionRequest": { "title": "DeleteMaterialMasterDocumentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetMaterialMasterDocumentResourceAction": { "title": "BatchGetMaterialMasterDocumentResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Material Master Document entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Material Master Document entities", "items": { "$ref": "#/components/schemas/GetMaterialMasterDocumentResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateMaterialMasterDocumentResourceActionRequest": { "title": "BatchCreateMaterialMasterDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateMaterialMasterDocumentResourceActionRequest" } }, "BatchUpdateMaterialMasterDocumentResourceActionRequest": { "title": "BatchUpdateMaterialMasterDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateMaterialMasterDocumentResourceActionRequest" } }, "BatchDeleteMaterialMasterDocumentResourceActionRequest": { "title": "BatchDeleteMaterialMasterDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteMaterialMasterDocumentResourceActionRequest" } }, "ChangeMaterialMasterDocumentIsActiveResourceActionRequest": { "title": "ChangeMaterialMasterDocumentIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MaterialMasterDocument->IsActive" } ] } } }, "ChangeMaterialMasterDocumentPermissionTreeResourceActionRequest": { "title": "ChangeMaterialMasterDocumentPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterDocument->PermissionTree_Id" } ] } } }, "BatchChangeMaterialMasterDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeMaterialMasterDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMaterialMasterDocumentPermissionTreeResourceActionRequest" } }, "BatchChangeMaterialMasterDocumentIsActiveResourceActionRequest": { "title": "BatchChangeMaterialMasterDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMaterialMasterDocumentIsActiveResourceActionRequest" } }, "GetMaterialMasterSupplierResourceActionResponse": { "title": "GetMaterialMasterSupplierResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMaterialMasterSupplierResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MaterialMasterSupplier->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MaterialMasterSupplier->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MaterialMasterSupplier->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterSupplier->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->PermissionTree_Description" }, "leadTime": { "title": "leadTime", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "MaterialMasterSupplier->LeadTime" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterSupplier->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->MaterialMaster_Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->SequenceNumber" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterSupplier->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->Supplier_Description" }, "supplierPartNumber": { "title": "supplierPartNumber", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->SupplierPartNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMaterialMasterSupplierCollectionResourceActionResponse": { "title": "GetMaterialMasterSupplierCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMaterialMasterSupplierCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMaterialMasterSupplierCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "MaterialMasterSupplier->MaterialMaster_Code" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "nullable": false, "x-propertyPath": "MaterialMasterSupplier->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "nullable": false, "x-propertyPath": "MaterialMasterSupplier->Supplier_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->Notes" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMaterialMasterSupplierForMaterialMasterCollectionResourceActionResponse": { "title": "GetMaterialMasterSupplierForMaterialMasterCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMaterialMasterSupplierForMaterialMasterCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMaterialMasterSupplierForMaterialMasterCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "nullable": false, "x-propertyPath": "MaterialMasterSupplier->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "nullable": false, "x-propertyPath": "MaterialMasterSupplier->Supplier_Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->Notes" }, "supplierPartNumber": { "title": "supplierPartNumber", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->SupplierPartNumber" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->SequenceNumber" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterSupplierChangePermissionTreeLookupResourceActionResponse": { "title": "MaterialMasterSupplierChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterSupplierChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterSupplierChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterSupplierInsertPermissionTreeLookupResourceActionResponse": { "title": "MaterialMasterSupplierInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterSupplierInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterSupplierInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterSupplierMaterialMasterLookupResourceActionResponse": { "title": "MaterialMasterSupplierMaterialMasterLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterSupplierMaterialMasterLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterSupplierMaterialMasterLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MaterialMasterSupplierSupplierLookupResourceActionResponse": { "title": "MaterialMasterSupplierSupplierLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MaterialMasterSupplierSupplierLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MaterialMasterSupplierSupplierLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Supplier->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Supplier->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateMaterialMasterSupplierResourceActionRequest": { "title": "CreateMaterialMasterSupplierResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateMaterialMasterSupplierResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "materialMasterId", "supplierId" ], "properties": { "leadTime": { "title": "leadTime", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "MaterialMasterSupplier->LeadTime" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterSupplier->MaterialMaster_Id" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterSupplier->Supplier_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterSupplier->PermissionTree_Id", "x-systemGenerated": true }, "supplierPartNumber": { "title": "supplierPartNumber", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->SupplierPartNumber" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateMaterialMasterSupplierResourceActionRequest": { "title": "UpdateMaterialMasterSupplierResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->SequenceNumber" }, { "title": "supplierPartNumber", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->SupplierPartNumber" }, { "title": "leadTime", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "MaterialMasterSupplier->LeadTime" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MaterialMasterSupplier->Notes" } ] } } }, "DeleteMaterialMasterSupplierResourceActionRequest": { "title": "DeleteMaterialMasterSupplierResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetMaterialMasterSupplierResourceAction": { "title": "BatchGetMaterialMasterSupplierResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Material Master Supplier entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Material Master Supplier entities", "items": { "$ref": "#/components/schemas/GetMaterialMasterSupplierResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateMaterialMasterSupplierResourceActionRequest": { "title": "BatchCreateMaterialMasterSupplierResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateMaterialMasterSupplierResourceActionRequest" } }, "BatchUpdateMaterialMasterSupplierResourceActionRequest": { "title": "BatchUpdateMaterialMasterSupplierResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateMaterialMasterSupplierResourceActionRequest" } }, "BatchDeleteMaterialMasterSupplierResourceActionRequest": { "title": "BatchDeleteMaterialMasterSupplierResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteMaterialMasterSupplierResourceActionRequest" } }, "ChangeMaterialMasterSupplierIsActiveResourceActionRequest": { "title": "ChangeMaterialMasterSupplierIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MaterialMasterSupplier->IsActive" } ] } } }, "ChangeMaterialMasterSupplierPermissionTreeResourceActionRequest": { "title": "ChangeMaterialMasterSupplierPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MaterialMasterSupplier->PermissionTree_Id" } ] } } }, "BatchChangeMaterialMasterSupplierIsActiveResourceActionRequest": { "title": "BatchChangeMaterialMasterSupplierIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMaterialMasterSupplierIsActiveResourceActionRequest" } }, "BatchChangeMaterialMasterSupplierPermissionTreeResourceActionRequest": { "title": "BatchChangeMaterialMasterSupplierPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMaterialMasterSupplierPermissionTreeResourceActionRequest" } }, "GetRequisitionResourceActionResponse": { "title": "GetRequisitionResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetRequisitionResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "Requisition->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "Requisition->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Requisition->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "Requisition->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "Requisition->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Requisition->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Requisition->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "Requisition->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "Requisition->PermissionTree_Description" }, "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Requisition->Code" }, "codeCounter": { "title": "codeCounter", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->CodeCounter" }, "codePrefix": { "title": "codePrefix", "type": "string", "nullable": true, "x-propertyPath": "Requisition->CodePrefix" }, "requester": { "title": "requester", "type": "string", "nullable": false, "x-propertyPath": "Requisition->Requester", "x-NullExpression": "Requisition->RequesterType eq 'FreeText'" }, "requesterContactId": { "title": "requesterContactId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->RequesterContact_Id", "x-NullExpression": "Requisition->RequesterType eq 'User'" }, "requesterContactCode": { "title": "requesterContactCode", "type": "string", "nullable": true, "x-propertyPath": "Requisition->RequesterContact_Code" }, "approvalWorkflowInterceptedStatusId": { "title": "approvalWorkflowInterceptedStatusId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->ApprovalWorkflowInterceptedStatus_Id" }, "approvalWorkflowInterceptedStatusBaseStatus": { "title": "approvalWorkflowInterceptedStatusBaseStatus", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "Requisition->ApprovalWorkflowInterceptedStatus_BaseStatus", "x-formatSpecifier": "RequisitionStatusBaseStatus" }, "approvalWorkflowInterceptedStatusCode": { "title": "approvalWorkflowInterceptedStatusCode", "type": "string", "nullable": true, "x-propertyPath": "Requisition->ApprovalWorkflowInterceptedStatus_Code" }, "approvalWorkflowInterceptedStatusDescription": { "title": "approvalWorkflowInterceptedStatusDescription", "type": "string", "nullable": true, "x-propertyPath": "Requisition->ApprovalWorkflowInterceptedStatus_Description" }, "approvalWorkflowProgress": { "title": "approvalWorkflowProgress", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "Requisition->ApprovalWorkflowProgress", "x-formatSpecifier": "ApprovalWorkflowProgress" }, "codedNonStockItemCost": { "title": "codedNonStockItemCost", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "Requisition->CodedNonStockItemCost" }, "contractorItemCost": { "title": "contractorItemCost", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "Requisition->ContractorItemCost" }, "directPurchaseItemCost": { "title": "directPurchaseItemCost", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "Requisition->DirectPurchaseItemCost" }, "importanceId": { "title": "importanceId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->Importance_Id" }, "importanceCode": { "title": "importanceCode", "type": "string", "nullable": true, "x-propertyPath": "Requisition->Importance_Code" }, "importanceDescription": { "title": "importanceDescription", "type": "string", "nullable": true, "x-propertyPath": "Requisition->Importance_Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Requisition->Notes" }, "requestedOn": { "title": "requestedOn", "type": "string", "format": "date-time", "nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Requisition->RequestedOn" }, "requesterType": { "title": "requesterType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Requisition->RequesterType", "x-formatSpecifier": "RequisitionRequesterType" }, "requestTypeId": { "title": "requestTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->RequestType_Id" }, "requestTypeDescription": { "title": "requestTypeDescription", "type": "string", "nullable": true, "x-propertyPath": "Requisition->RequestType_Description" }, "requestTypeCode": { "title": "requestTypeCode", "type": "string", "nullable": true, "x-propertyPath": "Requisition->RequestType_Code" }, "latestRequisitionStatusChangeId": { "title": "latestRequisitionStatusChangeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->LatestRequisitionStatusChange_Id" }, "latestRequisitionStatusChangeRemark": { "title": "latestRequisitionStatusChangeRemark", "type": "string", "nullable": true, "x-propertyPath": "Requisition->LatestRequisitionStatusChange_Remark" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Requisition->SequenceNumber" }, "statusId": { "title": "statusId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Requisition->Status_Id" }, "statusBaseStatus": { "title": "statusBaseStatus", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "Requisition->Status_BaseStatus", "x-formatSpecifier": "RequisitionStatusBaseStatus" }, "statusCode": { "title": "statusCode", "type": "string", "nullable": true, "x-propertyPath": "Requisition->Status_Code" }, "statusDescription": { "title": "statusDescription", "type": "string", "nullable": true, "x-propertyPath": "Requisition->Status_Description" }, "stockItemCost": { "title": "stockItemCost", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "Requisition->StockItemCost" }, "totalItemCost": { "title": "totalItemCost", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "Requisition->TotalItemCost" }, "totalTransactionCost": { "title": "totalTransactionCost", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "Requisition->TotalTransactionCost" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Requisition->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "nullable": true, "x-propertyPath": "Requisition->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "nullable": true, "x-propertyPath": "Requisition->WorkOrder_Description" }, "workOrderCostCentreId": { "title": "workOrderCostCentreId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->WorkOrder_CostCentre_Id" }, "workOrderCostCentreCode": { "title": "workOrderCostCentreCode", "type": "string", "nullable": true, "x-propertyPath": "Requisition->WorkOrder_CostCentre_Code" }, "workOrderCostCentreDescription": { "title": "workOrderCostCentreDescription", "type": "string", "nullable": true, "x-propertyPath": "Requisition->WorkOrder_CostCentre_Description" }, "workOrderGeneralLedgerId": { "title": "workOrderGeneralLedgerId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->WorkOrder_GeneralLedger_Id" }, "workOrderGeneralLedgerCode": { "title": "workOrderGeneralLedgerCode", "type": "string", "nullable": true, "x-propertyPath": "Requisition->WorkOrder_GeneralLedger_Code" }, "workOrderGeneralLedgerDescription": { "title": "workOrderGeneralLedgerDescription", "type": "string", "nullable": true, "x-propertyPath": "Requisition->WorkOrder_GeneralLedger_Description" }, "workOrderSiteId": { "title": "workOrderSiteId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->WorkOrder_Site_Id" }, "workOrderSiteCode": { "title": "workOrderSiteCode", "type": "string", "nullable": true, "x-propertyPath": "Requisition->WorkOrder_Site_Code" }, "workOrderSiteDescription": { "title": "workOrderSiteDescription", "type": "string", "nullable": true, "x-propertyPath": "Requisition->WorkOrder_Site_Description" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetApprovalForRequisitionCollectionResourceActionResponse": { "title": "GetApprovalForRequisitionCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetApprovalForRequisitionCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetApprovalForRequisitionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isLocked": { "title": "isLocked", "type": "boolean", "nullable": true, "x-propertyPath": "Approval->IsLocked" }, "status": { "title": "status", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "Approval->Status", "x-formatSpecifier": "ApprovalStatus" }, "roleCode": { "title": "roleCode", "type": "string", "nullable": false, "x-propertyPath": "Approval->Role_Code" }, "roleDescription": { "title": "roleDescription", "type": "string", "nullable": false, "x-propertyPath": "Approval->Role_Description" }, "remark": { "title": "remark", "type": "string", "nullable": true, "x-propertyPath": "Approval->Remark" }, "isHistoric": { "title": "isHistoric", "type": "boolean", "nullable": true, "x-propertyPath": "Approval->IsHistoric" }, "reviewedByUserFullName": { "title": "reviewedByUserFullName", "type": "string", "nullable": false, "x-propertyPath": "Approval->ReviewedByUser_FullName" }, "reviewedOn": { "title": "reviewedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Approval->ReviewedOn" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Approval->EntityType", "x-formatSpecifier": "EntityType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetRequisitionCollectionResourceActionResponse": { "title": "GetRequisitionCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRequisitionCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetRequisitionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Requisition->Code" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Requisition->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": false, "x-propertyPath": "Requisition->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": false, "x-propertyPath": "Requisition->PermissionTree_Description" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "nullable": false, "x-propertyPath": "Requisition->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "nullable": false, "x-propertyPath": "Requisition->WorkOrder_Description" }, "workOrderCostCentreId": { "title": "workOrderCostCentreId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->WorkOrder_CostCentre_Id" }, "workOrderCostCentreCode": { "title": "workOrderCostCentreCode", "type": "string", "nullable": false, "x-propertyPath": "Requisition->WorkOrder_CostCentre_Code" }, "workOrderCostCentreDescription": { "title": "workOrderCostCentreDescription", "type": "string", "nullable": false, "x-propertyPath": "Requisition->WorkOrder_CostCentre_Description" }, "workOrderGeneralLedgerId": { "title": "workOrderGeneralLedgerId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->WorkOrder_GeneralLedger_Id" }, "workOrderGeneralLedgerCode": { "title": "workOrderGeneralLedgerCode", "type": "string", "nullable": false, "x-propertyPath": "Requisition->WorkOrder_GeneralLedger_Code" }, "workOrderGeneralLedgerDescription": { "title": "workOrderGeneralLedgerDescription", "type": "string", "nullable": false, "x-propertyPath": "Requisition->WorkOrder_GeneralLedger_Description" }, "workOrderSiteId": { "title": "workOrderSiteId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->WorkOrder_Site_Id" }, "workOrderSiteCode": { "title": "workOrderSiteCode", "type": "string", "nullable": false, "x-propertyPath": "Requisition->WorkOrder_Site_Code" }, "workOrderSiteDescription": { "title": "workOrderSiteDescription", "type": "string", "nullable": false, "x-propertyPath": "Requisition->WorkOrder_Site_Description" }, "workOrderSiteCurrencyId": { "title": "workOrderSiteCurrencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->WorkOrder_Site_Currency_Id" }, "workOrderSiteCurrencyCode": { "title": "workOrderSiteCurrencyCode", "type": "string", "nullable": false, "x-propertyPath": "Requisition->WorkOrder_Site_Currency_Code" }, "workOrderSiteCurrencyDescription": { "title": "workOrderSiteCurrencyDescription", "type": "string", "nullable": false, "x-propertyPath": "Requisition->WorkOrder_Site_Currency_Description" }, "importanceId": { "title": "importanceId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->Importance_Id" }, "importanceCode": { "title": "importanceCode", "type": "string", "nullable": false, "x-propertyPath": "Requisition->Importance_Code" }, "importanceDescription": { "title": "importanceDescription", "type": "string", "nullable": false, "x-propertyPath": "Requisition->Importance_Description" }, "requestedOn": { "title": "requestedOn", "type": "string", "format": "date-time", "nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Requisition->RequestedOn" }, "requester": { "title": "requester", "type": "string", "nullable": false, "x-propertyPath": "Requisition->Requester", "x-NullExpression": "Requisition->RequesterType eq 'FreeText'" }, "requestTypeId": { "title": "requestTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->RequestType_Id" }, "requestTypeCode": { "title": "requestTypeCode", "type": "string", "nullable": false, "x-propertyPath": "Requisition->RequestType_Code" }, "requestTypeDescription": { "title": "requestTypeDescription", "type": "string", "nullable": false, "x-propertyPath": "Requisition->RequestType_Description" }, "requesterType": { "title": "requesterType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Requisition->RequesterType", "x-formatSpecifier": "RequisitionRequesterType" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Requisition->SequenceNumber" }, "statusId": { "title": "statusId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->Status_Id" }, "statusCode": { "title": "statusCode", "type": "string", "nullable": false, "x-propertyPath": "Requisition->Status_Code" }, "statusDescription": { "title": "statusDescription", "type": "string", "nullable": false, "x-propertyPath": "Requisition->Status_Description" }, "statusBaseStatus": { "title": "statusBaseStatus", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Requisition->Status_BaseStatus", "x-formatSpecifier": "RequisitionStatusBaseStatus" }, "totalItemCost": { "title": "totalItemCost", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "Requisition->TotalItemCost" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionChangePermissionTreeLookupResourceActionResponse": { "title": "RequisitionChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionFinancialYearPeriodLookupResourceActionResponse": { "title": "RequisitionFinancialYearPeriodLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionFinancialYearPeriodLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionFinancialYearPeriodLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "FinancialYearPeriod->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "FinancialYearPeriod->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionInsertPermissionTreeLookupResourceActionResponse": { "title": "RequisitionInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionRequestTypeLookupResourceActionResponse": { "title": "RequisitionRequestTypeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionRequestTypeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionRequestTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "RequestType->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "RequestType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionWorkOrderImportanceLookupResourceActionResponse": { "title": "RequisitionWorkOrderImportanceLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionWorkOrderImportanceLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionWorkOrderImportanceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "WorkOrderImportance->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "WorkOrderImportance->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionWorkOrderLookupResourceActionResponse": { "title": "RequisitionWorkOrderLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionWorkOrderLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionWorkOrderLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "WorkOrder->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "WorkOrder->Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "WorkOrder->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "nullable": false, "x-propertyPath": "WorkOrder->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "nullable": false, "x-propertyPath": "WorkOrder->Site_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "WorkOrder->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "nullable": false, "x-propertyPath": "WorkOrder->CostCentre_Code" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "WorkOrder->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "nullable": false, "x-propertyPath": "WorkOrder->GeneralLedger_Code" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionRequesterContactLookupResourceActionResponse": { "title": "RequisitionRequesterContactLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionRequesterContactLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionRequesterContactLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Resource->Code" }, "contactDetailFullName": { "title": "contactDetailFullName", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailFullName" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionStatusLookupResourceActionResponse": { "title": "RequisitionStatusLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionStatusLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionStatusLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatus->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatus->Description" }, "baseStatus": { "title": "baseStatus", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "RequisitionStatus->BaseStatus", "x-formatSpecifier": "RequisitionStatusBaseStatus" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateRequisitionResourceActionRequest": { "title": "CreateRequisitionResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateRequisitionResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "requesterType", "workOrderId" ], "properties": { "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "Requisition->Code", "x-systemGenerated": true }, "importanceId": { "title": "importanceId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->Importance_Id" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Requisition->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Requisition->PermissionTree_Id", "x-systemGenerated": true }, "requestTypeId": { "title": "requestTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->RequestType_Id" }, "requestedOn": { "title": "requestedOn", "type": "string", "format": "date-time", "nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Requisition->RequestedOn" }, "requester": { "title": "requester", "type": "string", "minLength": 1, "nullable": false, "x-propertyPath": "Requisition->Requester", "x-NullExpression": "Requisition->RequesterType eq 'FreeText'" }, "requesterContactId": { "title": "requesterContactId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->RequesterContact_Id", "x-NullExpression": "Requisition->RequesterType eq 'User'" }, "requesterType": { "title": "requesterType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Requisition->RequesterType", "x-formatSpecifier": "RequisitionRequesterType" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Requisition->SequenceNumber" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Requisition->WorkOrder_Id" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateRequisitionResourceActionRequest": { "title": "UpdateRequisitionResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "Requisition->Code" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Requisition->Notes" }, { "title": "importanceId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->Importance_Id" }, { "title": "requestTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->RequestType_Id" }, { "title": "requestedOn", "type": "string", "format": "date-time", "nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Requisition->RequestedOn" }, { "title": "requester", "type": "string", "minLength": 1, "nullable": false, "x-propertyPath": "Requisition->Requester", "x-NullExpression": "Requisition->RequesterType eq 'FreeText'" }, { "title": "requesterContactId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->RequesterContact_Id", "x-NullExpression": "Requisition->RequesterType eq 'User'" }, { "title": "requesterType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Requisition->RequesterType", "x-formatSpecifier": "RequisitionRequesterType" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Requisition->SequenceNumber" }, { "title": "workOrderId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Requisition->WorkOrder_Id" } ] } } }, "DeleteRequisitionResourceActionRequest": { "title": "DeleteRequisitionResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetRequisitionResourceAction": { "title": "BatchGetRequisitionResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Requisition entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Requisition entities", "items": { "$ref": "#/components/schemas/GetRequisitionResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateRequisitionResourceActionRequest": { "title": "BatchCreateRequisitionResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateRequisitionResourceActionRequest" } }, "BatchUpdateRequisitionResourceActionRequest": { "title": "BatchUpdateRequisitionResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateRequisitionResourceActionRequest" } }, "BatchDeleteRequisitionResourceActionRequest": { "title": "BatchDeleteRequisitionResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteRequisitionResourceActionRequest" } }, "BatchIssueAllRequisitionResourceActionRequest": { "title": "BatchIssueAllRequisitionResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "BatchIssueAllRequisitionResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "entityIds" ], "properties": { "entityIds": { "title": "entityIds", "type": "array", "format": "array", "nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IssueReturnAll->EntityIds", "x-formatSpecifier": "Int64" }, "permissionId": { "title": "permissionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "IssueReturnAll->Permission_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "IssueReturnAll->FinancialYearPeriod_Id", "x-systemGenerated": true }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "IssueReturnAll->TransactedOn", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "BatchReturnAllRequisitionResourceActionRequest": { "title": "BatchReturnAllRequisitionResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "BatchReturnAllRequisitionResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "entityIds" ], "properties": { "entityIds": { "title": "entityIds", "type": "array", "format": "array", "nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IssueReturnAll->EntityIds", "x-formatSpecifier": "Int64" }, "permissionId": { "title": "permissionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "IssueReturnAll->Permission_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "IssueReturnAll->FinancialYearPeriod_Id", "x-systemGenerated": true }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "IssueReturnAll->TransactedOn", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "ChangeRequisitionPermissionTreeResourceActionRequest": { "title": "ChangeRequisitionPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Requisition->PermissionTree_Id" } ] } } }, "IssueAllRequisitionResourceActionRequest": { "title": "IssueAllRequisitionResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "IssueAllRequisitionResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "permissionId": { "title": "permissionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "IssueReturnAll->Permission_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "IssueReturnAll->FinancialYearPeriod_Id", "x-systemGenerated": true }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "IssueReturnAll->TransactedOn", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "ReturnAllRequisitionResourceActionRequest": { "title": "ReturnAllRequisitionResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "ReturnAllRequisitionResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "permissionId": { "title": "permissionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "IssueReturnAll->Permission_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "IssueReturnAll->FinancialYearPeriod_Id", "x-systemGenerated": true }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "IssueReturnAll->TransactedOn", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "ChangeRequisitionStatusResourceActionRequest": { "title": "ChangeRequisitionStatusResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "ChangeRequisitionStatusResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "requisitionId", "statusId" ], "properties": { "requisitionId": { "title": "requisitionId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionStatusChange->Requisition_Id" }, "statusId": { "title": "statusId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionStatusChange->Status_Id" }, "statusChangedOn": { "title": "statusChangedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionStatusChange->StatusChangedOn" }, "remark": { "title": "remark", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusChange->Remark" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "BatchChangeRequisitionStatusResourceActionRequest": { "title": "BatchChangeRequisitionStatusResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequisitionStatusResourceActionRequest" } }, "BatchChangeRequisitionPermissionTreeResourceActionRequest": { "title": "BatchChangeRequisitionPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequisitionPermissionTreeResourceActionRequest" } }, "GetRequisitionAttributeResourceActionResponse": { "title": "GetRequisitionAttributeResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetRequisitionAttributeResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "requisitionId": { "title": "requisitionId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionAttribute->Requisition_Id" }, "requisitionCode": { "title": "requisitionCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionAttribute->Requisition_Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": true, "x-propertyPath": "RequisitionAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "nullable": true, "x-propertyPath": "RequisitionAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "RequisitionAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "RequisitionAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "RequisitionAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "RequisitionAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "RequisitionAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "RequisitionAttribute->Value", "x-formatSpecifier": "DynamicValue" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetRequisitionAttributeCollectionForRequisitionResourceActionResponse": { "title": "GetRequisitionAttributeCollectionForRequisitionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRequisitionAttributeCollectionForRequisitionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetRequisitionAttributeCollectionForRequisitionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "RequisitionAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "RequisitionAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "RequisitionAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "RequisitionAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetRequisitionAttributeCollectionResourceActionResponse": { "title": "GetRequisitionAttributeCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRequisitionAttributeCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetRequisitionAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionAttribute->SequenceNumber" }, "requisitionCode": { "title": "requisitionCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionAttribute->Requisition_Code" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "RequisitionAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "RequisitionAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "RequisitionAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "RequisitionAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "RequisitionAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "value": { "title": "value", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionAttributeAttributeLookupResourceActionResponse": { "title": "RequisitionAttributeAttributeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionAttributeAttributeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionAttributeAttributeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Attribute->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Attribute->Description" }, "allowAnyValue": { "title": "allowAnyValue", "type": "boolean", "nullable": false, "x-propertyPath": "Attribute->AllowAnyValue" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Attribute->DataType", "x-formatSpecifier": "DynamicValueType" }, "defaultValue": { "title": "defaultValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, "defaultAllowedValueId": { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id" }, "defaultAllowedValueValue": { "title": "defaultAllowedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultAllowedValueDescription": { "title": "defaultAllowedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Description" }, "explanation": { "title": "explanation", "type": "string", "nullable": true, "x-propertyPath": "Attribute->Explanation" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "RequisitionAttributeChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionAttributeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "RequisitionAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionAttributeRequisitionLookupResourceActionResponse": { "title": "RequisitionAttributeRequisitionLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionAttributeRequisitionLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionAttributeRequisitionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Requisition->Code" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateRequisitionAttributeResourceActionRequest": { "title": "CreateRequisitionAttributeResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateRequisitionAttributeResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "requisitionId", "attributeId" ], "properties": { "requisitionId": { "title": "requisitionId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionAttribute->Requisition_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "RequisitionAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "RequisitionAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateRequisitionAttributeResourceActionRequest": { "title": "UpdateRequisitionAttributeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "value", "format": "composite", "nullable": true, "x-propertyPath": "RequisitionAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "RequisitionAttribute->Notes" } ] } } }, "DeleteRequisitionAttributeResourceActionRequest": { "title": "DeleteRequisitionAttributeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetRequisitionAttributeResourceAction": { "title": "BatchGetRequisitionAttributeResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Requisition Attribute entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Requisition Attribute entities", "items": { "$ref": "#/components/schemas/GetRequisitionAttributeResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateRequisitionAttributeResourceActionRequest": { "title": "BatchCreateRequisitionAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateRequisitionAttributeResourceActionRequest" } }, "BatchUpdateRequisitionAttributeResourceActionRequest": { "title": "BatchUpdateRequisitionAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateRequisitionAttributeResourceActionRequest" } }, "BatchDeleteRequisitionAttributeResourceActionRequest": { "title": "BatchDeleteRequisitionAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteRequisitionAttributeResourceActionRequest" } }, "ChangeRequisitionAttributeIsActiveResourceActionRequest": { "title": "ChangeRequisitionAttributeIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "RequisitionAttribute->IsActive" } ] } } }, "ChangeRequisitionAttributePermissionTreeResourceActionRequest": { "title": "ChangeRequisitionAttributePermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionAttribute->PermissionTree_Id" } ] } } }, "BatchChangeRequisitionAttributePermissionTreeResourceActionRequest": { "title": "BatchChangeRequisitionAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequisitionAttributePermissionTreeResourceActionRequest" } }, "BatchChangeRequisitionAttributeIsActiveResourceActionRequest": { "title": "BatchChangeRequisitionAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequisitionAttributeIsActiveResourceActionRequest" } }, "GetRequisitionDocumentResourceActionResponse": { "title": "GetRequisitionDocumentResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetRequisitionDocumentResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "requisitionId": { "title": "requisitionId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionDocument->Requisition_Id" }, "requisitionCode": { "title": "requisitionCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionDocument->Requisition_Code" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": true, "x-propertyPath": "RequisitionDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "RequisitionDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "RequisitionDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "RequisitionDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionDocument->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetRequisitionDocumentCollectionForRequisitionResourceActionResponse": { "title": "GetRequisitionDocumentCollectionForRequisitionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRequisitionDocumentCollectionForRequisitionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetRequisitionDocumentCollectionForRequisitionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "RequisitionDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "RequisitionDocument->DocumentRecord_FileType_Extension" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetRequisitionDocumentCollectionResourceActionResponse": { "title": "GetRequisitionDocumentCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRequisitionDocumentCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetRequisitionDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "requisitionId": { "title": "requisitionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionDocument->Requisition_Id" }, "requisitionCode": { "title": "requisitionCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionDocument->Requisition_Code" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "RequisitionDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "RequisitionDocument->DocumentRecord_FileType_Extension" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "RequisitionDocumentChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionDocumentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionDocumentDocumentLookupResourceActionResponse": { "title": "RequisitionDocumentDocumentLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionDocumentDocumentLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionDocumentDocumentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "DocumentRecord->Description" }, "fileLocation": { "title": "fileLocation", "type": "string", "nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, "fileFullName": { "title": "fileFullName", "type": "string", "nullable": true, "x-propertyPath": "DocumentRecord->FileFullName" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "RequisitionDocumentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionDocumentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionDocumentRequisitionLookupResourceActionResponse": { "title": "RequisitionDocumentRequisitionLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionDocumentRequisitionLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionDocumentRequisitionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Requisition->Code" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateRequisitionDocumentResourceActionRequest": { "title": "CreateRequisitionDocumentResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateRequisitionDocumentResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "requisitionId", "documentRecordId" ], "properties": { "requisitionId": { "title": "requisitionId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionDocument->Requisition_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "RequisitionDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateRequisitionDocumentResourceActionRequest": { "title": "UpdateRequisitionDocumentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionDocument->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "RequisitionDocument->Notes" } ] } } }, "DeleteRequisitionDocumentResourceActionRequest": { "title": "DeleteRequisitionDocumentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetRequisitionDocumentResourceAction": { "title": "BatchGetRequisitionDocumentResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Requisition Document entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Requisition Document entities", "items": { "$ref": "#/components/schemas/GetRequisitionDocumentResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateRequisitionDocumentResourceActionRequest": { "title": "BatchCreateRequisitionDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateRequisitionDocumentResourceActionRequest" } }, "BatchUpdateRequisitionDocumentResourceActionRequest": { "title": "BatchUpdateRequisitionDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateRequisitionDocumentResourceActionRequest" } }, "BatchDeleteRequisitionDocumentResourceActionRequest": { "title": "BatchDeleteRequisitionDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteRequisitionDocumentResourceActionRequest" } }, "ChangeRequisitionDocumentIsActiveResourceActionRequest": { "title": "ChangeRequisitionDocumentIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "RequisitionDocument->IsActive" } ] } } }, "ChangeRequisitionDocumentPermissionTreeResourceActionRequest": { "title": "ChangeRequisitionDocumentPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionDocument->PermissionTree_Id" } ] } } }, "BatchChangeRequisitionDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeRequisitionDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequisitionDocumentPermissionTreeResourceActionRequest" } }, "BatchChangeRequisitionDocumentIsActiveResourceActionRequest": { "title": "BatchChangeRequisitionDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequisitionDocumentIsActiveResourceActionRequest" } }, "GetRequisitionFileAttachmentResourceActionResponse": { "title": "GetRequisitionFileAttachmentResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetRequisitionFileAttachmentResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "requisitionId": { "title": "requisitionId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->Requisition_Id" }, "requisitionCode": { "title": "requisitionCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->Requisition_Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionFileAttachment->CreatedOn" }, "contentId": { "title": "contentId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->Content_Id" }, "contentFileLocationId": { "title": "contentFileLocationId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->Content_FileLocation_Id" }, "contentFileLocationDescription": { "title": "contentFileLocationDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->Content_FileLocation_Description" }, "contentFileLocationFileLocationType": { "title": "contentFileLocationFileLocationType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->Content_FileLocation_FileLocationType", "x-formatSpecifier": "FileContentStoreLocationType" }, "contentFileLocationOnKeyFileStoreId": { "title": "contentFileLocationOnKeyFileStoreId", "type": "string", "format": "uuid", "nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "RequisitionFileAttachment->Content_FileLocation_OnKeyFileStoreId" }, "contentSizeInBytes": { "title": "contentSizeInBytes", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->Content_SizeInBytes" }, "contentSizeInKb": { "title": "contentSizeInKb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->Content_SizeInKb" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->Content_SizeInMb" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->ContentVersion" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->EntityType", "x-formatSpecifier": "EntityType" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->FileCategory_Description" }, "fileCategoryAutoIsRestricted": { "title": "fileCategoryAutoIsRestricted", "type": "boolean", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->FileCategory_AutoIsRestricted" }, "fileFullName": { "title": "fileFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->FileFullName" }, "fileName": { "title": "fileName", "type": "string", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->FileName" }, "fileTypeId": { "title": "fileTypeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->FileType_Id" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->FileType_Extension" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->IsRestricted" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionFileAttachment->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->PermissionTree_Description" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetRequisitionFileAttachmentCollectionForRequisitionResourceActionResponse": { "title": "GetRequisitionFileAttachmentCollectionForRequisitionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRequisitionFileAttachmentCollectionForRequisitionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetRequisitionFileAttachmentCollectionForRequisitionResourceActionResponseItemProperties", "type": "object", "properties": { "fileFullName": { "title": "fileFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->Content_SizeInMb" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->IsRestricted" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->FileCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionFileAttachment->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionFileAttachment->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetRequisitionFileAttachmentCollectionResourceActionResponse": { "title": "GetRequisitionFileAttachmentCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRequisitionFileAttachmentCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetRequisitionFileAttachmentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "requisitionId": { "title": "requisitionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->Requisition_Id" }, "requisitionCode": { "title": "requisitionCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->Requisition_Code" }, "fileFullName": { "title": "fileFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->Content_SizeInMb" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->FileType_Extension" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->IsRestricted" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->FileCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionFileAttachment->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionFileAttachment->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateRequisitionFileAttachmentResourceActionRequest": { "title": "CreateRequisitionFileAttachmentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "requisitionId" ], "properties": { "requisitionId": { "title": "requisitionId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->Requisition_Id" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->IsRestricted" }, "fileName": { "title": "fileName", "type": "string", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->FileName" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->FileCategory_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->PermissionTree_Id", "x-systemGenerated": true }, "file": { "type": "string", "format": "binary" } } }, "UpdateRequisitionFileAttachmentContentResourceActionRequest": { "title": "UpdateRequisitionFileAttachmentContentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->Version" }, "file": { "type": "string", "format": "binary" } } }, "UpdateRequisitionFileAttachmentResourceActionRequest": { "title": "UpdateRequisitionFileAttachmentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "fileCategoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->FileCategory_Id" }, { "title": "fileName", "type": "string", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->FileName" }, { "title": "isRestricted", "type": "boolean", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->IsRestricted" } ] } } }, "DeleteRequisitionFileAttachmentResourceResourceActionRequest": { "title": "DeleteRequisitionFileAttachmentResourceResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetRequisitionFileAttachmentResourceAction": { "title": "BatchGetRequisitionFileAttachmentResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Requisition File Attachment entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Requisition File Attachment entities", "items": { "$ref": "#/components/schemas/GetRequisitionFileAttachmentResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetRequisitionFileAttachmentContentHistoryResourceActionResponse": { "title": "GetRequisitionFileAttachmentContentHistoryResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Id" }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Version" }, "contentId": { "title": "contentId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_Id" }, "contentFileLocationId": { "title": "contentFileLocationId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_Id" }, "contentFileLocationDescription": { "title": "contentFileLocationDescription", "type": "string", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_Description" }, "contentFileLocationFileLocationType": { "title": "contentFileLocationFileLocationType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_FileLocationType", "x-formatSpecifier": "FileContentStoreLocationType" }, "contentFileLocationOnKeyFileStoreId": { "title": "contentFileLocationOnKeyFileStoreId", "type": "string", "format": "uuid", "nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_OnKeyFileStoreId" }, "contentSizeInBytes": { "title": "contentSizeInBytes", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInBytes" }, "contentSizeInKb": { "title": "contentSizeInKb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInKb" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInMb" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->ContentVersion" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FileAttachmentContentHistory->CreatedOn" }, "fileAttachmentId": { "title": "fileAttachmentId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->FileAttachment_Id" } } }, "GetRequisitionFileAttachmentContentHistoryResourceAction": { "title": "GetRequisitionFileAttachmentContentHistoryResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Requisition File Attachment entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Requisition File Attachment entities", "items": { "$ref": "#/components/schemas/GetRequisitionFileAttachmentContentHistoryResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateRequisitionFileAttachmentResourceActionRequest": { "title": "BatchCreateRequisitionFileAttachmentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "requisitionId" ], "properties": { "requisitionId": { "title": "requisitionId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->Requisition_Id" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->IsRestricted" }, "fileName": { "title": "fileName", "type": "string", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->FileName" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionFileAttachment->FileCategory_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionFileAttachment->PermissionTree_Id", "x-systemGenerated": true }, "file": { "type": "array", "items": { "type": "string", "format": "binary" } } } }, "BatchUpdateRequisitionFileAttachmentResourceActionRequest": { "title": "BatchUpdateRequisitionFileAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateRequisitionFileAttachmentResourceActionRequest" } }, "BatchDeleteRequisitionFileAttachmentResourceActionRequest": { "title": "BatchDeleteRequisitionFileAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteRequisitionFileAttachmentResourceResourceActionRequest" } }, "GetRequisitionItemResourceActionResponse": { "title": "GetRequisitionItemResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetRequisitionItemResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionItem->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionItem->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionItem->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->PermissionTree_Description" }, "lineNumber": { "title": "lineNumber", "type": "integer", "format": "int32", "nullable": false, "x-propertyPath": "RequisitionItem->LineNumber" }, "approvalWorkflowProgress": { "title": "approvalWorkflowProgress", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "RequisitionItem->ApprovalWorkflowProgress", "x-formatSpecifier": "ApprovalWorkflowProgress" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->Notes" }, "quantityIssued": { "title": "quantityIssued", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItem->QuantityIssued" }, "quantityNotIssued": { "title": "quantityNotIssued", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItem->QuantityNotIssued" }, "quantityOrdered": { "title": "quantityOrdered", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionItem->QuantityOrdered" }, "quantityRequired": { "title": "quantityRequired", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItem->QuantityRequired" }, "quantityReserved": { "title": "quantityReserved", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionItem->QuantityReserved" }, "requisitionId": { "title": "requisitionId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionItem->Requisition_Id" }, "requisitionCode": { "title": "requisitionCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->Requisition_Code" }, "requisitionRequestedOn": { "title": "requisitionRequestedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionItem->Requisition_RequestedOn" }, "requisitionStatusId": { "title": "requisitionStatusId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->Requisition_Status_Id" }, "requisitionStatusBaseStatus": { "title": "requisitionStatusBaseStatus", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "RequisitionItem->Requisition_Status_BaseStatus", "x-formatSpecifier": "RequisitionStatusBaseStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionItem->SequenceNumber" }, "totalCostInSiteCurrency": { "title": "totalCostInSiteCurrency", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItem->TotalCostInSiteCurrency" }, "totalCostInSpareCurrency": { "title": "totalCostInSpareCurrency", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItem->TotalCostInSpareCurrency" }, "workOrderTaskSpareId": { "title": "workOrderTaskSpareId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_Id" }, "workOrderTaskSpareCode": { "title": "workOrderTaskSpareCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_Code" }, "workOrderTaskSpareDescription": { "title": "workOrderTaskSpareDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_Description" }, "workOrderTaskSpareSpareType": { "title": "workOrderTaskSpareSpareType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_SpareType", "x-formatSpecifier": "WorkOrderTaskSpareType" }, "workOrderTaskSpareUnitPriceInSpareCurrency": { "title": "workOrderTaskSpareUnitPriceInSpareCurrency", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_UnitPriceInSpareCurrency" }, "workOrderTaskSpareUnitPriceInWorkOrderCurrency": { "title": "workOrderTaskSpareUnitPriceInWorkOrderCurrency", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_UnitPriceInWorkOrderCurrency" }, "workOrderTaskSpareCostCentreId": { "title": "workOrderTaskSpareCostCentreId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_CostCentre_Id" }, "workOrderTaskSpareCostCentreCode": { "title": "workOrderTaskSpareCostCentreCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_CostCentre_Code" }, "workOrderTaskSpareCostCentreDescription": { "title": "workOrderTaskSpareCostCentreDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_CostCentre_Description" }, "workOrderTaskSpareCostElementId": { "title": "workOrderTaskSpareCostElementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_CostElement_Id" }, "workOrderTaskSpareCostElementCode": { "title": "workOrderTaskSpareCostElementCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_CostElement_Code" }, "workOrderTaskSpareCostElementDescription": { "title": "workOrderTaskSpareCostElementDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_CostElement_Description" }, "workOrderTaskSpareGeneralLedgerId": { "title": "workOrderTaskSpareGeneralLedgerId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_GeneralLedger_Id" }, "workOrderTaskSpareGeneralLedgerCode": { "title": "workOrderTaskSpareGeneralLedgerCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_GeneralLedger_Code" }, "workOrderTaskSpareGeneralLedgerDescription": { "title": "workOrderTaskSpareGeneralLedgerDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_GeneralLedger_Description" }, "workOrderTaskSpareSpareCurrencyId": { "title": "workOrderTaskSpareSpareCurrencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_SpareCurrency_Id" }, "workOrderTaskSpareSpareCurrencyCode": { "title": "workOrderTaskSpareSpareCurrencyCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_SpareCurrency_Code" }, "workOrderTaskSpareSpareCurrencyDescription": { "title": "workOrderTaskSpareSpareCurrencyDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_SpareCurrency_Description" }, "workOrderTaskSpareStockItemId": { "title": "workOrderTaskSpareStockItemId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_Id" }, "workOrderTaskSpareStockItemMaterialMasterId": { "title": "workOrderTaskSpareStockItemMaterialMasterId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Id" }, "workOrderTaskSpareStockItemMaterialMasterCode": { "title": "workOrderTaskSpareStockItemMaterialMasterCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Code" }, "workOrderTaskSpareStockItemMaterialMasterDescription": { "title": "workOrderTaskSpareStockItemMaterialMasterDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Description" }, "workOrderTaskSpareStockItemWarehouseId": { "title": "workOrderTaskSpareStockItemWarehouseId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_Warehouse_Id" }, "workOrderTaskSpareStockItemWarehouseCode": { "title": "workOrderTaskSpareStockItemWarehouseCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_Warehouse_Code" }, "workOrderTaskSpareSupplierId": { "title": "workOrderTaskSpareSupplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_Supplier_Id" }, "workOrderTaskSpareSupplierCode": { "title": "workOrderTaskSpareSupplierCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_Supplier_Code" }, "workOrderTaskSpareSupplierDescription": { "title": "workOrderTaskSpareSupplierDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_Supplier_Description" }, "workOrderTaskSpareUnitOfMeasurementId": { "title": "workOrderTaskSpareUnitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_UnitOfMeasurement_Id" }, "workOrderTaskSpareUnitOfMeasurementCode": { "title": "workOrderTaskSpareUnitOfMeasurementCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_UnitOfMeasurement_Code" }, "workOrderTaskSpareUnitOfMeasurementDescription": { "title": "workOrderTaskSpareUnitOfMeasurementDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_UnitOfMeasurement_Description" }, "workOrderTaskSpareWorkOrderCurrencyId": { "title": "workOrderTaskSpareWorkOrderCurrencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderCurrency_Id" }, "workOrderTaskSpareWorkOrderCurrencyCode": { "title": "workOrderTaskSpareWorkOrderCurrencyCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderCurrency_Code" }, "workOrderTaskSpareWorkOrderCurrencyDescription": { "title": "workOrderTaskSpareWorkOrderCurrencyDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderCurrency_Description" }, "workOrderTaskSpareWorkOrderTaskId": { "title": "workOrderTaskSpareWorkOrderTaskId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_Id" }, "workOrderTaskSpareWorkOrderTaskTaskCode": { "title": "workOrderTaskSpareWorkOrderTaskTaskCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskCode" }, "workOrderTaskSpareWorkOrderTaskTaskDescription": { "title": "workOrderTaskSpareWorkOrderTaskTaskDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskDescription" }, "workOrderTaskSpareInfoId": { "title": "workOrderTaskSpareInfoId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpareInfoId" }, "code": { "title": "code", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->Code" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->CostCentre_Id" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->CostCentre_Description" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->CostCentre_Code" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->CostElement_Id" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->CostElement_Description" }, "costElementCode": { "title": "costElementCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->CostElement_Code" }, "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->Description" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->FinancialYearPeriod_Id" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->FinancialYearPeriod_Description" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->FinancialYearPeriod_Code" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->GeneralLedger_Id" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->GeneralLedger_Description" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->GeneralLedger_Code" }, "requiredOn": { "title": "requiredOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionItem->RequiredOn" }, "spareToWorkOrderCurrencyRateValue": { "title": "spareToWorkOrderCurrencyRateValue", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionItem->SpareToWorkOrderCurrencyRateValue" }, "spareType": { "title": "spareType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "RequisitionItem->SpareType", "x-formatSpecifier": "WorkOrderTaskSpareType" }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->StockItem_Id" }, "stockItemAlternativeDescription": { "title": "stockItemAlternativeDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->StockItem_AlternativeDescription" }, "stockItemMaterialMasterId": { "title": "stockItemMaterialMasterId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->StockItem_MaterialMaster_Id" }, "stockItemMaterialMasterCode": { "title": "stockItemMaterialMasterCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->StockItem_MaterialMaster_Code" }, "stockItemWarehouseId": { "title": "stockItemWarehouseId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->StockItem_Warehouse_Id" }, "stockItemWarehouseCode": { "title": "stockItemWarehouseCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->StockItem_Warehouse_Code" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->Supplier_Id" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->Supplier_Description" }, "supplierCode": { "title": "supplierCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->Supplier_Code" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->UnitOfMeasurement_Id" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->UnitOfMeasurement_Description" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->UnitOfMeasurement_Code" }, "unitPriceInSpareCurrency": { "title": "unitPriceInSpareCurrency", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionItem->UnitPriceInSpareCurrency" }, "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTask_Id" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTask_TaskCode" }, "workOrderTaskTaskDescription": { "title": "workOrderTaskTaskDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTask_TaskDescription" }, "workOrderTaskTaskType": { "title": "workOrderTaskTaskType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTask_TaskType", "x-formatSpecifier": "EntityType" }, "workOrderTaskWorkOrderId": { "title": "workOrderTaskWorkOrderId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTask_WorkOrder_Id" }, "workOrderTaskWorkOrderCode": { "title": "workOrderTaskWorkOrderCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTask_WorkOrder_Code" }, "workOrderTaskWorkOrderDescription": { "title": "workOrderTaskWorkOrderDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTask_WorkOrder_Description" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetApprovalForRequisitionItemCollectionResourceActionResponse": { "title": "GetApprovalForRequisitionItemCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetApprovalForRequisitionItemCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetApprovalForRequisitionItemCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "entityType": { "title": "entityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Approval->EntityType", "x-formatSpecifier": "EntityType" }, "expressionId": { "title": "expressionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Approval->Expression_Id" }, "expressionDescription": { "title": "expressionDescription", "type": "string", "nullable": false, "x-propertyPath": "Approval->Expression_Description" }, "reviewedByUserFullName": { "title": "reviewedByUserFullName", "type": "string", "nullable": false, "x-propertyPath": "Approval->ReviewedByUser_FullName" }, "reviewedOn": { "title": "reviewedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Approval->ReviewedOn" }, "isHistoric": { "title": "isHistoric", "type": "boolean", "nullable": true, "x-propertyPath": "Approval->IsHistoric" }, "isLocked": { "title": "isLocked", "type": "boolean", "nullable": true, "x-propertyPath": "Approval->IsLocked" }, "remark": { "title": "remark", "type": "string", "nullable": true, "x-propertyPath": "Approval->Remark" }, "roleCode": { "title": "roleCode", "type": "string", "nullable": false, "x-propertyPath": "Approval->Role_Code" }, "roleDescription": { "title": "roleDescription", "type": "string", "nullable": false, "x-propertyPath": "Approval->Role_Description" }, "status": { "title": "status", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "Approval->Status", "x-formatSpecifier": "ApprovalStatus" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetRequisitionItemCollectionResourceActionResponse": { "title": "GetRequisitionItemCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRequisitionItemCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetRequisitionItemCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "requisitionId": { "title": "requisitionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->Requisition_Id" }, "requisitionCode": { "title": "requisitionCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->Requisition_Code" }, "requisitionRequestedOn": { "title": "requisitionRequestedOn", "type": "string", "format": "date-time", "nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionItem->Requisition_RequestedOn" }, "requisitionStatusCode": { "title": "requisitionStatusCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->Requisition_Status_Code" }, "requisitionStatusBaseStatus": { "title": "requisitionStatusBaseStatus", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "RequisitionItem->Requisition_Status_BaseStatus", "x-formatSpecifier": "RequisitionStatusBaseStatus" }, "requisitionWorkOrderCode": { "title": "requisitionWorkOrderCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->Requisition_WorkOrder_Code" }, "requisitionWorkOrderStatusCode": { "title": "requisitionWorkOrderStatusCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->Requisition_WorkOrder_Status_Code" }, "workOrderTaskSpareId": { "title": "workOrderTaskSpareId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_Id" }, "workOrderTaskSpareCode": { "title": "workOrderTaskSpareCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_Code" }, "workOrderTaskSpareDescription": { "title": "workOrderTaskSpareDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_Description" }, "workOrderTaskSpareWorkOrderTaskTaskId": { "title": "workOrderTaskSpareWorkOrderTaskTaskId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskId" }, "workOrderTaskSpareWorkOrderTaskTaskCode": { "title": "workOrderTaskSpareWorkOrderTaskTaskCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskCode" }, "workOrderTaskSpareWorkOrderTaskTaskDescription": { "title": "workOrderTaskSpareWorkOrderTaskTaskDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskDescription" }, "workOrderTaskSpareWorkOrderTaskTaskType": { "title": "workOrderTaskSpareWorkOrderTaskTaskType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskType", "x-formatSpecifier": "EntityType" }, "workOrderTaskSpareWorkOrderTaskWorkOrderGeneralLedgerId": { "title": "workOrderTaskSpareWorkOrderTaskWorkOrderGeneralLedgerId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_WorkOrder_GeneralLedger_Id" }, "workOrderTaskSpareWorkOrderTaskWorkOrderGeneralLedgerCode": { "title": "workOrderTaskSpareWorkOrderTaskWorkOrderGeneralLedgerCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_WorkOrder_GeneralLedger_Code" }, "workOrderTaskSpareWorkOrderTaskWorkOrderGeneralLedgerDescription": { "title": "workOrderTaskSpareWorkOrderTaskWorkOrderGeneralLedgerDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_WorkOrder_GeneralLedger_Description" }, "workOrderTaskSpareWorkOrderTaskWorkOrderCostCentreId": { "title": "workOrderTaskSpareWorkOrderTaskWorkOrderCostCentreId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_WorkOrder_CostCentre_Id" }, "workOrderTaskSpareWorkOrderTaskWorkOrderCostCentreCode": { "title": "workOrderTaskSpareWorkOrderTaskWorkOrderCostCentreCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_WorkOrder_CostCentre_Code" }, "workOrderTaskSpareWorkOrderTaskWorkOrderCostCentreDescription": { "title": "workOrderTaskSpareWorkOrderTaskWorkOrderCostCentreDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_WorkOrder_CostCentre_Description" }, "workOrderTaskSpareSpareType": { "title": "workOrderTaskSpareSpareType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_SpareType", "x-formatSpecifier": "WorkOrderTaskSpareType" }, "workOrderTaskSpareStockItemMaterialMasterId": { "title": "workOrderTaskSpareStockItemMaterialMasterId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Id" }, "workOrderTaskSpareStockItemMaterialMasterCode": { "title": "workOrderTaskSpareStockItemMaterialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Code" }, "workOrderTaskSpareStockItemMaterialMasterDescription": { "title": "workOrderTaskSpareStockItemMaterialMasterDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Description" }, "workOrderTaskSpareStockItemAverageItemCost": { "title": "workOrderTaskSpareStockItemAverageItemCost", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_AverageItemCost" }, "workOrderTaskSpareStockItemQuantityOnHand": { "title": "workOrderTaskSpareStockItemQuantityOnHand", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_QuantityOnHand" }, "workOrderTaskSpareStockItemWarehouseCode": { "title": "workOrderTaskSpareStockItemWarehouseCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_Warehouse_Code" }, "workOrderTaskSpareStockItemWarehouseDescription": { "title": "workOrderTaskSpareStockItemWarehouseDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_Warehouse_Description" }, "workOrderTaskSpareStockItemCostElementId": { "title": "workOrderTaskSpareStockItemCostElementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_CostElement_Id" }, "workOrderTaskSpareStockItemCostElementCode": { "title": "workOrderTaskSpareStockItemCostElementCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_CostElement_Code" }, "workOrderTaskSpareStockItemCostElementDescription": { "title": "workOrderTaskSpareStockItemCostElementDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_CostElement_Description" }, "workOrderTaskSpareUnitOfMeasurementCode": { "title": "workOrderTaskSpareUnitOfMeasurementCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_UnitOfMeasurement_Code" }, "workOrderTaskSpareUnitOfMeasurementDescription": { "title": "workOrderTaskSpareUnitOfMeasurementDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_UnitOfMeasurement_Description" }, "workOrderTaskSpareSupplierCode": { "title": "workOrderTaskSpareSupplierCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_Supplier_Code" }, "workOrderTaskSpareSupplierDescription": { "title": "workOrderTaskSpareSupplierDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_Supplier_Description" }, "workOrderTaskSpareSpareCurrencyId": { "title": "workOrderTaskSpareSpareCurrencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_SpareCurrency_Id" }, "workOrderTaskSpareSpareCurrencyCode": { "title": "workOrderTaskSpareSpareCurrencyCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_SpareCurrency_Code" }, "workOrderTaskSpareSpareCurrencyDescription": { "title": "workOrderTaskSpareSpareCurrencyDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_SpareCurrency_Description" }, "workOrderTaskSpareTotalUsedInWorkOrderCurrency": { "title": "workOrderTaskSpareTotalUsedInWorkOrderCurrency", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_TotalUsedInWorkOrderCurrency" }, "workOrderTaskSpareWorkOrderCurrencyId": { "title": "workOrderTaskSpareWorkOrderCurrencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderCurrency_Id" }, "workOrderTaskSpareWorkOrderCurrencyCode": { "title": "workOrderTaskSpareWorkOrderCurrencyCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderCurrency_Code" }, "workOrderTaskSpareWorkOrderCurrencyDescription": { "title": "workOrderTaskSpareWorkOrderCurrencyDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderCurrency_Description" }, "workOrderTaskSpareUnitPriceInSpareCurrency": { "title": "workOrderTaskSpareUnitPriceInSpareCurrency", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_UnitPriceInSpareCurrency" }, "workOrderTaskSpareUnitPriceInWorkOrderCurrency": { "title": "workOrderTaskSpareUnitPriceInWorkOrderCurrency", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_UnitPriceInWorkOrderCurrency" }, "quantityRequired": { "title": "quantityRequired", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItem->QuantityRequired" }, "quantityIssued": { "title": "quantityIssued", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItem->QuantityIssued" }, "quantityOrdered": { "title": "quantityOrdered", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionItem->QuantityOrdered" }, "quantityReserved": { "title": "quantityReserved", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionItem->QuantityReserved" }, "quantityNotIssued": { "title": "quantityNotIssued", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItem->QuantityNotIssued" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->GeneralLedger_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->CostCentre_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->CostElement_Description" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->Supplier_Description" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->FinancialYearPeriod_Id" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->FinancialYearPeriod_Code" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->FinancialYearPeriod_Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->UnitOfMeasurement_Description" }, "unitPriceInSpareCurrency": { "title": "unitPriceInSpareCurrency", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionItem->UnitPriceInSpareCurrency" }, "code": { "title": "code", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->Code" }, "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetRequisitionItemForRequisitionCollectionResourceActionResponse": { "title": "GetRequisitionItemForRequisitionCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRequisitionItemForRequisitionCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetRequisitionItemForRequisitionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "requisitionCode": { "title": "requisitionCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->Requisition_Code" }, "quantityRequired": { "title": "quantityRequired", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItem->QuantityRequired" }, "workOrderTaskSpareCode": { "title": "workOrderTaskSpareCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_Code" }, "workOrderTaskSpareDescription": { "title": "workOrderTaskSpareDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_Description" }, "workOrderTaskSpareWorkOrderTaskWorkOrderCode": { "title": "workOrderTaskSpareWorkOrderTaskWorkOrderCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_WorkOrder_Code" }, "workOrderTaskSpareWorkOrderTaskTaskCode": { "title": "workOrderTaskSpareWorkOrderTaskTaskCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskCode" }, "workOrderTaskSpareWorkOrderTaskTaskDescription": { "title": "workOrderTaskSpareWorkOrderTaskTaskDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskDescription" }, "workOrderTaskSpareSpareType": { "title": "workOrderTaskSpareSpareType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_SpareType", "x-formatSpecifier": "WorkOrderTaskSpareType" }, "workOrderTaskSpareStockItemMaterialMasterId": { "title": "workOrderTaskSpareStockItemMaterialMasterId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Id" }, "workOrderTaskSpareStockItemMaterialMasterCode": { "title": "workOrderTaskSpareStockItemMaterialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Code" }, "workOrderTaskSpareStockItemMaterialMasterDescription": { "title": "workOrderTaskSpareStockItemMaterialMasterDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Description" }, "workOrderTaskSpareStockItemWarehouseCode": { "title": "workOrderTaskSpareStockItemWarehouseCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_Warehouse_Code" }, "workOrderTaskSpareStockItemWarehouseDescription": { "title": "workOrderTaskSpareStockItemWarehouseDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_Warehouse_Description" }, "workOrderTaskSpareStockItemAverageItemCost": { "title": "workOrderTaskSpareStockItemAverageItemCost", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_AverageItemCost" }, "workOrderTaskSpareStockItemQuantityOnHand": { "title": "workOrderTaskSpareStockItemQuantityOnHand", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_QuantityOnHand" }, "workOrderTaskSpareSupplierCode": { "title": "workOrderTaskSpareSupplierCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_Supplier_Code" }, "workOrderTaskSpareSupplierDescription": { "title": "workOrderTaskSpareSupplierDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_Supplier_Description" }, "workOrderTaskSpareUnitPriceInSpareCurrency": { "title": "workOrderTaskSpareUnitPriceInSpareCurrency", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_UnitPriceInSpareCurrency" }, "workOrderTaskSpareUnitPriceInWorkOrderCurrency": { "title": "workOrderTaskSpareUnitPriceInWorkOrderCurrency", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_UnitPriceInWorkOrderCurrency" }, "workOrderTaskSpareTotalUsedInWorkOrderCurrency": { "title": "workOrderTaskSpareTotalUsedInWorkOrderCurrency", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_TotalUsedInWorkOrderCurrency" }, "quantityIssued": { "title": "quantityIssued", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItem->QuantityIssued" }, "quantityNotIssued": { "title": "quantityNotIssued", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItem->QuantityNotIssued" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionItemChangePermissionTreeLookupResourceActionResponse": { "title": "RequisitionItemChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionItemChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionItemChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionItemCodedNonStockItemForSiteLookupResourceActionResponse": { "title": "RequisitionItemCodedNonStockItemForSiteLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionItemCodedNonStockItemForSiteLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionItemCodedNonStockItemForSiteLookupResourceActionResponseItemProperties", "type": "object", "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->Warehouse_Description" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Description" }, "defaultStockItemSupplierSupplierId": { "title": "defaultStockItemSupplierSupplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Id" }, "defaultStockItemSupplierSupplierCode": { "title": "defaultStockItemSupplierSupplierCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Code" }, "defaultStockItemSupplierSupplierDescription": { "title": "defaultStockItemSupplierSupplierDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Description" }, "defaultStockItemSupplierSupplierSiteCurrencyId": { "title": "defaultStockItemSupplierSupplierSiteCurrencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Site_Currency_Id" }, "defaultStockItemSupplierSupplierSiteCurrencyCode": { "title": "defaultStockItemSupplierSupplierSiteCurrencyCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Site_Currency_Code" }, "defaultStockItemSupplierSupplierSiteCurrencyDescription": { "title": "defaultStockItemSupplierSupplierSiteCurrencyDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Site_Currency_Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Description" }, "averageItemCost": { "title": "averageItemCost", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItem->AverageItemCost" }, "quantityOnHand": { "title": "quantityOnHand", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItem->QuantityOnHand" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionItemCodedNonStockItemLookupResourceActionResponse": { "title": "RequisitionItemCodedNonStockItemLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionItemCodedNonStockItemLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionItemCodedNonStockItemLookupResourceActionResponseItemProperties", "type": "object", "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->Warehouse_Description" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Description" }, "defaultStockItemSupplierSupplierId": { "title": "defaultStockItemSupplierSupplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Id" }, "defaultStockItemSupplierSupplierCode": { "title": "defaultStockItemSupplierSupplierCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Code" }, "defaultStockItemSupplierSupplierDescription": { "title": "defaultStockItemSupplierSupplierDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Description" }, "defaultStockItemSupplierSupplierSiteCurrencyId": { "title": "defaultStockItemSupplierSupplierSiteCurrencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Site_Currency_Id" }, "defaultStockItemSupplierSupplierSiteCurrencyCode": { "title": "defaultStockItemSupplierSupplierSiteCurrencyCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Site_Currency_Code" }, "defaultStockItemSupplierSupplierSiteCurrencyDescription": { "title": "defaultStockItemSupplierSupplierSiteCurrencyDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Site_Currency_Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Description" }, "averageItemCost": { "title": "averageItemCost", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItem->AverageItemCost" }, "quantityOnHand": { "title": "quantityOnHand", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItem->QuantityOnHand" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionItemCostCentreLookupResourceActionResponse": { "title": "RequisitionItemCostCentreLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionItemCostCentreLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionItemCostCentreLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "CostCentre->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "CostCentre->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionItemCostElementLookupResourceActionResponse": { "title": "RequisitionItemCostElementLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionItemCostElementLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionItemCostElementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "CostElement->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "CostElement->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionItemFinancialYearPeriodCodeLookupResourceActionResponse": { "title": "RequisitionItemFinancialYearPeriodCodeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionItemFinancialYearPeriodCodeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionItemFinancialYearPeriodCodeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "FinancialYearPeriod->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "FinancialYearPeriod->Description" }, "financialYearId": { "title": "financialYearId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Id" }, "financialYearCode": { "title": "financialYearCode", "type": "string", "nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Code" }, "financialYearDescription": { "title": "financialYearDescription", "type": "string", "nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionItemFinancialYearPeriodLookupResourceActionResponse": { "title": "RequisitionItemFinancialYearPeriodLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionItemFinancialYearPeriodLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionItemFinancialYearPeriodLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "FinancialYearPeriod->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "FinancialYearPeriod->Description" }, "financialYearId": { "title": "financialYearId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Id" }, "financialYearCode": { "title": "financialYearCode", "type": "string", "nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Code" }, "financialYearDescription": { "title": "financialYearDescription", "type": "string", "nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionItemGeneralLedgerLookupResourceActionResponse": { "title": "RequisitionItemGeneralLedgerLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionItemGeneralLedgerLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionItemGeneralLedgerLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "GeneralLedger->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "GeneralLedger->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionItemInsertPermissionTreeLookupResourceActionResponse": { "title": "RequisitionItemInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionItemInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionItemInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionItemRequisitionLookupResourceActionResponse": { "title": "RequisitionItemRequisitionLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionItemRequisitionLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionItemRequisitionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Requisition->Code" }, "requestedOn": { "title": "requestedOn", "type": "string", "format": "date-time", "nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Requisition->RequestedOn" }, "statusCode": { "title": "statusCode", "type": "string", "nullable": false, "x-propertyPath": "Requisition->Status_Code" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->WorkOrder_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionItemStockItemForAssetSpareLookupResourceActionResponse": { "title": "RequisitionItemStockItemForAssetSpareLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionItemStockItemForAssetSpareLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionItemStockItemForAssetSpareLookupResourceActionResponseItemProperties", "type": "object", "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->Warehouse_Description" }, "warehouseSiteCurrencyId": { "title": "warehouseSiteCurrencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->Warehouse_Site_Currency_Id" }, "warehouseSiteCurrencyCode": { "title": "warehouseSiteCurrencyCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->Warehouse_Site_Currency_Code" }, "warehouseSiteCurrencyDescription": { "title": "warehouseSiteCurrencyDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->Warehouse_Site_Currency_Description" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Description" }, "defaultStockItemSupplierSupplierId": { "title": "defaultStockItemSupplierSupplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Id" }, "defaultStockItemSupplierSupplierCode": { "title": "defaultStockItemSupplierSupplierCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Code" }, "defaultStockItemSupplierSupplierDescription": { "title": "defaultStockItemSupplierSupplierDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Description" }, "averageItemCost": { "title": "averageItemCost", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItem->AverageItemCost" }, "quantityOnHand": { "title": "quantityOnHand", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItem->QuantityOnHand" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionItemStockItemForSiteLookupResourceActionResponse": { "title": "RequisitionItemStockItemForSiteLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionItemStockItemForSiteLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionItemStockItemForSiteLookupResourceActionResponseItemProperties", "type": "object", "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->Warehouse_Description" }, "warehouseSiteCurrencyId": { "title": "warehouseSiteCurrencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->Warehouse_Site_Currency_Id" }, "warehouseSiteCurrencyCode": { "title": "warehouseSiteCurrencyCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->Warehouse_Site_Currency_Code" }, "warehouseSiteCurrencyDescription": { "title": "warehouseSiteCurrencyDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->Warehouse_Site_Currency_Description" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Description" }, "defaultStockItemSupplierSupplierId": { "title": "defaultStockItemSupplierSupplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Id" }, "defaultStockItemSupplierSupplierCode": { "title": "defaultStockItemSupplierSupplierCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Code" }, "defaultStockItemSupplierSupplierDescription": { "title": "defaultStockItemSupplierSupplierDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Description" }, "averageItemCost": { "title": "averageItemCost", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItem->AverageItemCost" }, "quantityOnHand": { "title": "quantityOnHand", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItem->QuantityOnHand" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionItemStockItemForWorkOrderSiteLookupResourceActionResponse": { "title": "RequisitionItemStockItemForWorkOrderSiteLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionItemStockItemForWorkOrderSiteLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionItemStockItemForWorkOrderSiteLookupResourceActionResponseItemProperties", "type": "object", "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->Warehouse_Description" }, "warehouseSiteCurrencyId": { "title": "warehouseSiteCurrencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->Warehouse_Site_Currency_Id" }, "warehouseSiteCurrencyCode": { "title": "warehouseSiteCurrencyCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->Warehouse_Site_Currency_Code" }, "warehouseSiteCurrencyDescription": { "title": "warehouseSiteCurrencyDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->Warehouse_Site_Currency_Description" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Description" }, "defaultStockItemSupplierSupplierId": { "title": "defaultStockItemSupplierSupplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Id" }, "defaultStockItemSupplierSupplierCode": { "title": "defaultStockItemSupplierSupplierCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Code" }, "defaultStockItemSupplierSupplierDescription": { "title": "defaultStockItemSupplierSupplierDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Description" }, "averageItemCost": { "title": "averageItemCost", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItem->AverageItemCost" }, "quantityOnHand": { "title": "quantityOnHand", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItem->QuantityOnHand" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionItemStockItemLookupResourceActionResponse": { "title": "RequisitionItemStockItemLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionItemStockItemLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionItemStockItemLookupResourceActionResponseItemProperties", "type": "object", "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->Warehouse_Description" }, "warehouseSiteCurrencyId": { "title": "warehouseSiteCurrencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->Warehouse_Site_Currency_Id" }, "warehouseSiteCurrencyCode": { "title": "warehouseSiteCurrencyCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->Warehouse_Site_Currency_Code" }, "warehouseSiteCurrencyDescription": { "title": "warehouseSiteCurrencyDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->Warehouse_Site_Currency_Description" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Description" }, "defaultStockItemSupplierSupplierId": { "title": "defaultStockItemSupplierSupplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Id" }, "defaultStockItemSupplierSupplierCode": { "title": "defaultStockItemSupplierSupplierCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Code" }, "defaultStockItemSupplierSupplierDescription": { "title": "defaultStockItemSupplierSupplierDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Description" }, "averageItemCost": { "title": "averageItemCost", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItem->AverageItemCost" }, "quantityOnHand": { "title": "quantityOnHand", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItem->QuantityOnHand" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionItemSupplierLookupResourceActionResponse": { "title": "RequisitionItemSupplierLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionItemSupplierLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionItemSupplierLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Supplier->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Supplier->Description" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Supplier->Currency_Id" }, "currencyCode": { "title": "currencyCode", "type": "string", "nullable": false, "x-propertyPath": "Supplier->Currency_Code" }, "currencyDescription": { "title": "currencyDescription", "type": "string", "nullable": false, "x-propertyPath": "Supplier->Currency_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionItemUnitOfMeasurementLookupResourceActionResponse": { "title": "RequisitionItemUnitOfMeasurementLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionItemUnitOfMeasurementLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionItemUnitOfMeasurementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "UnitOfMeasurement->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "UnitOfMeasurement->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionItemWorkOrderTaskLookupResourceActionResponse": { "title": "RequisitionItemWorkOrderTaskLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionItemWorkOrderTaskLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionItemWorkOrderTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "WorkOrderTask->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "nullable": false, "x-propertyPath": "WorkOrderTask->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "nullable": false, "x-propertyPath": "WorkOrderTask->WorkOrder_Description" }, "taskCode": { "title": "taskCode", "type": "string", "nullable": true, "x-propertyPath": "WorkOrderTask->TaskCode" }, "taskDescription": { "title": "taskDescription", "type": "string", "nullable": true, "x-propertyPath": "WorkOrderTask->TaskDescription" }, "taskType": { "title": "taskType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "WorkOrderTask->TaskType", "x-formatSpecifier": "EntityType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateRequisitionItemResourceActionRequest": { "title": "CreateRequisitionItemResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateRequisitionItemResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "quantityRequired", "requiredOn", "requisitionId", "spareType" ], "properties": { "code": { "title": "code", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->Code" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->CostCentre_Id", "x-systemGenerated": true }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->CostElement_Id", "x-systemGenerated": true }, "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->Description" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->FinancialYearPeriod_Id", "x-systemGenerated": true }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->GeneralLedger_Id", "x-systemGenerated": true }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionItem->PermissionTree_Id", "x-systemGenerated": true }, "quantityRequired": { "title": "quantityRequired", "type": "number", "format": "decimal", "minimum": 0.0, "nullable": false, "x-propertyPath": "RequisitionItem->QuantityRequired" }, "requiredOn": { "title": "requiredOn", "type": "string", "format": "date-time", "nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionItem->RequiredOn" }, "requisitionId": { "title": "requisitionId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionItem->Requisition_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionItem->SequenceNumber" }, "spareToWorkOrderCurrencyRateValue": { "title": "spareToWorkOrderCurrencyRateValue", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionItem->SpareToWorkOrderCurrencyRateValue", "x-systemGenerated": true }, "spareType": { "title": "spareType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "RequisitionItem->SpareType", "x-formatSpecifier": "WorkOrderTaskSpareType" }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->StockItem_Id" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->Supplier_Id" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->UnitOfMeasurement_Id" }, "unitPriceInSpareCurrency": { "title": "unitPriceInSpareCurrency", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionItem->UnitPriceInSpareCurrency" }, "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTask_Id" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateRequisitionItemResourceActionRequest": { "title": "UpdateRequisitionItemResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->Code" }, { "title": "costCentreId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->CostCentre_Id" }, { "title": "costElementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->CostElement_Id" }, { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->Description" }, { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->FinancialYearPeriod_Id" }, { "title": "generalLedgerId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->GeneralLedger_Id" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->Notes" }, { "title": "quantityRequired", "type": "number", "format": "decimal", "minimum": 0.0, "nullable": false, "x-propertyPath": "RequisitionItem->QuantityRequired" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionItem->SequenceNumber" }, { "title": "quantityOrdered", "type": "number", "format": "decimal", "minimum": 0.0, "nullable": true, "x-propertyPath": "RequisitionItem->QuantityOrdered" }, { "title": "quantityReserved", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionItem->QuantityReserved" }, { "title": "requiredOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionItem->RequiredOn" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionItem->SequenceNumber" }, { "title": "spareToWorkOrderCurrencyRateValue", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionItem->SpareToWorkOrderCurrencyRateValue" }, { "title": "supplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->Supplier_Id" }, { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->UnitOfMeasurement_Id" }, { "title": "unitPriceInSpareCurrency", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionItem->UnitPriceInSpareCurrency" } ] } } }, "DeleteRequisitionItemResourceActionRequest": { "title": "DeleteRequisitionItemResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetRequisitionItemResourceAction": { "title": "BatchGetRequisitionItemResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Requisition Item entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Requisition Item entities", "items": { "$ref": "#/components/schemas/GetRequisitionItemResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateRequisitionItemResourceActionRequest": { "title": "BatchCreateRequisitionItemResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateRequisitionItemResourceActionRequest" } }, "BatchUpdateRequisitionItemResourceActionRequest": { "title": "BatchUpdateRequisitionItemResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateRequisitionItemResourceActionRequest" } }, "BatchDeleteRequisitionItemResourceActionRequest": { "title": "BatchDeleteRequisitionItemResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteRequisitionItemResourceActionRequest" } }, "BatchIssueAllRequisitionItemResourceActionRequest": { "title": "BatchIssueAllRequisitionItemResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "BatchIssueAllRequisitionItemResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "entityIds" ], "properties": { "entityIds": { "title": "entityIds", "type": "array", "format": "array", "nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IssueReturnAll->EntityIds", "x-formatSpecifier": "Int64" }, "permissionId": { "title": "permissionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "IssueReturnAll->Permission_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "IssueReturnAll->FinancialYearPeriod_Id", "x-systemGenerated": true }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "IssueReturnAll->TransactedOn", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "BatchReturnAllRequisitionItemResourceActionRequest": { "title": "BatchReturnAllRequisitionItemResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "BatchReturnAllRequisitionItemResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "entityIds" ], "properties": { "entityIds": { "title": "entityIds", "type": "array", "format": "array", "nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IssueReturnAll->EntityIds", "x-formatSpecifier": "Int64" }, "permissionId": { "title": "permissionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "IssueReturnAll->Permission_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "IssueReturnAll->FinancialYearPeriod_Id", "x-systemGenerated": true }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "IssueReturnAll->TransactedOn", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "ChangeRequisitionItemPermissionTreeResourceActionRequest": { "title": "ChangeRequisitionItemPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionItem->PermissionTree_Id" } ] } } }, "IssueAllRequisitionItemResourceActionRequest": { "title": "IssueAllRequisitionItemResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "IssueAllRequisitionItemResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "permissionId": { "title": "permissionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "IssueReturnAll->Permission_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "IssueReturnAll->FinancialYearPeriod_Id", "x-systemGenerated": true }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "IssueReturnAll->TransactedOn", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "IssueSpecificQuantityResourceActionRequest": { "title": "IssueSpecificQuantityResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "IssueSpecificQuantityResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "quantity" ], "properties": { "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_Id", "x-systemGenerated": true }, "itemCostInSiteCurrency": { "title": "itemCostInSiteCurrency", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->ItemCostInSiteCurrency", "x-systemGenerated": true }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->PermissionTree_Id", "x-systemGenerated": true }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "minimum": 0.0, "nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RequisitionItemTransaction->Quantity", "x-MinValueExpression": "RequisitionItemTransaction->TransactionType eq 'Issue'" }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionItemTransaction->TransactedOn", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "ReturnAllRequisitionItemResourceActionRequest": { "title": "ReturnAllRequisitionItemResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "ReturnAllRequisitionItemResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "permissionId": { "title": "permissionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "IssueReturnAll->Permission_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "IssueReturnAll->FinancialYearPeriod_Id", "x-systemGenerated": true }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "IssueReturnAll->TransactedOn", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "ReturnSpecificQuantityResourceActionRequest": { "title": "ReturnSpecificQuantityResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "ReturnSpecificQuantityResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "quantity" ], "properties": { "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_Id", "x-systemGenerated": true }, "itemCostInSiteCurrency": { "title": "itemCostInSiteCurrency", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->ItemCostInSiteCurrency", "x-systemGenerated": true }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->PermissionTree_Id", "x-systemGenerated": true }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "minimum": 0.0, "nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RequisitionItemTransaction->Quantity", "x-MinValueExpression": "RequisitionItemTransaction->TransactionType eq 'Issue'" }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionItemTransaction->TransactedOn", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "BatchChangeRequisitionItemPermissionTreeResourceActionRequest": { "title": "BatchChangeRequisitionItemPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequisitionItemPermissionTreeResourceActionRequest" } }, "BatchIssueSpecificQuantityRequest": { "title": "BatchIssueSpecificQuantityRequest", "type": "array", "items": { "$ref": "#/components/schemas/IssueSpecificQuantityResourceActionRequest" } }, "BatchReturnSpecificQuantityRequest": { "title": "BatchReturnSpecificQuantityRequest", "type": "array", "items": { "$ref": "#/components/schemas/ReturnSpecificQuantityResourceActionRequest" } }, "GetRequisitionItemFileAttachmentResourceActionResponse": { "title": "GetRequisitionItemFileAttachmentResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetRequisitionItemFileAttachmentResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "requisitionItemId": { "title": "requisitionItemId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->RequisitionItem_Id" }, "requisitionItemRequisitionId": { "title": "requisitionItemRequisitionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->RequisitionItem_Requisition_Id" }, "requisitionItemRequisitionCode": { "title": "requisitionItemRequisitionCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->RequisitionItem_Requisition_Code" }, "requisitionItemRequisitionWorkOrderId": { "title": "requisitionItemRequisitionWorkOrderId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->RequisitionItem_Requisition_WorkOrder_Id" }, "requisitionItemRequisitionWorkOrderCode": { "title": "requisitionItemRequisitionWorkOrderCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->RequisitionItem_Requisition_WorkOrder_Code" }, "requisitionItemRequisitionWorkOrderDescription": { "title": "requisitionItemRequisitionWorkOrderDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->RequisitionItem_Requisition_WorkOrder_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionItemFileAttachment->CreatedOn" }, "contentId": { "title": "contentId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->Content_Id" }, "contentFileLocationId": { "title": "contentFileLocationId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->Content_FileLocation_Id" }, "contentFileLocationDescription": { "title": "contentFileLocationDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->Content_FileLocation_Description" }, "contentFileLocationFileLocationType": { "title": "contentFileLocationFileLocationType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->Content_FileLocation_FileLocationType", "x-formatSpecifier": "FileContentStoreLocationType" }, "contentFileLocationOnKeyFileStoreId": { "title": "contentFileLocationOnKeyFileStoreId", "type": "string", "format": "uuid", "nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "RequisitionItemFileAttachment->Content_FileLocation_OnKeyFileStoreId" }, "contentSizeInBytes": { "title": "contentSizeInBytes", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->Content_SizeInBytes" }, "contentSizeInKb": { "title": "contentSizeInKb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->Content_SizeInKb" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->Content_SizeInMb" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->ContentVersion" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->EntityType", "x-formatSpecifier": "EntityType" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->FileCategory_Description" }, "fileCategoryAutoIsRestricted": { "title": "fileCategoryAutoIsRestricted", "type": "boolean", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->FileCategory_AutoIsRestricted" }, "fileFullName": { "title": "fileFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->FileFullName" }, "fileName": { "title": "fileName", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->FileName" }, "fileTypeId": { "title": "fileTypeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->FileType_Id" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->FileType_Extension" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->IsRestricted" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionItemFileAttachment->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->PermissionTree_Description" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetRequisitionItemFileAttachmentCollectionForRequisitionItemResourceActionResponse": { "title": "GetRequisitionItemFileAttachmentCollectionForRequisitionItemResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRequisitionItemFileAttachmentCollectionForRequisitionItemResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetRequisitionItemFileAttachmentCollectionForRequisitionItemResourceActionResponseItemProperties", "type": "object", "properties": { "fileFullName": { "title": "fileFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->Content_SizeInMb" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->IsRestricted" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->FileCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionItemFileAttachment->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionItemFileAttachment->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetRequisitionItemFileAttachmentCollectionResourceActionResponse": { "title": "GetRequisitionItemFileAttachmentCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRequisitionItemFileAttachmentCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetRequisitionItemFileAttachmentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "requisitionItemId": { "title": "requisitionItemId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->RequisitionItem_Id" }, "requisitionItemRequisitionCode": { "title": "requisitionItemRequisitionCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->RequisitionItem_Requisition_Code" }, "requisitionItemWorkOrderTaskSpareWorkOrderTaskWorkOrderCode": { "title": "requisitionItemWorkOrderTaskSpareWorkOrderTaskWorkOrderCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->RequisitionItem_WorkOrderTaskSpare_WorkOrderTask_WorkOrder_Code" }, "requisitionItemWorkOrderTaskSpareWorkOrderTaskTaskCode": { "title": "requisitionItemWorkOrderTaskSpareWorkOrderTaskTaskCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->RequisitionItem_WorkOrderTaskSpare_WorkOrderTask_TaskCode" }, "fileFullName": { "title": "fileFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->Content_SizeInMb" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->FileType_Extension" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->IsRestricted" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->FileCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionItemFileAttachment->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionItemFileAttachment->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateRequisitionItemFileAttachmentResourceActionRequest": { "title": "CreateRequisitionItemFileAttachmentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "requisitionItemId" ], "properties": { "requisitionItemId": { "title": "requisitionItemId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->RequisitionItem_Id" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->IsRestricted" }, "fileName": { "title": "fileName", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->FileName" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->FileCategory_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->PermissionTree_Id", "x-systemGenerated": true }, "file": { "type": "string", "format": "binary" } } }, "UpdateRequisitionItemFileAttachmentContentResourceActionRequest": { "title": "UpdateRequisitionItemFileAttachmentContentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->Version" }, "file": { "type": "string", "format": "binary" } } }, "UpdateRequisitionItemFileAttachmentResourceActionRequest": { "title": "UpdateRequisitionItemFileAttachmentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "fileCategoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->FileCategory_Id" }, { "title": "fileName", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->FileName" }, { "title": "isRestricted", "type": "boolean", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->IsRestricted" } ] } } }, "DeleteRequisitionItemFileAttachmentResourceResourceActionRequest": { "title": "DeleteRequisitionItemFileAttachmentResourceResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetRequisitionItemFileAttachmentResourceAction": { "title": "BatchGetRequisitionItemFileAttachmentResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Requisition Item File Attachment entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Requisition Item File Attachment entities", "items": { "$ref": "#/components/schemas/GetRequisitionItemFileAttachmentResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetRequisitionItemFileAttachmentContentHistoryResourceActionResponse": { "title": "GetRequisitionItemFileAttachmentContentHistoryResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Id" }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Version" }, "contentId": { "title": "contentId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_Id" }, "contentFileLocationId": { "title": "contentFileLocationId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_Id" }, "contentFileLocationDescription": { "title": "contentFileLocationDescription", "type": "string", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_Description" }, "contentFileLocationFileLocationType": { "title": "contentFileLocationFileLocationType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_FileLocationType", "x-formatSpecifier": "FileContentStoreLocationType" }, "contentFileLocationOnKeyFileStoreId": { "title": "contentFileLocationOnKeyFileStoreId", "type": "string", "format": "uuid", "nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_OnKeyFileStoreId" }, "contentSizeInBytes": { "title": "contentSizeInBytes", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInBytes" }, "contentSizeInKb": { "title": "contentSizeInKb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInKb" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInMb" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->ContentVersion" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FileAttachmentContentHistory->CreatedOn" }, "fileAttachmentId": { "title": "fileAttachmentId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->FileAttachment_Id" } } }, "GetRequisitionItemFileAttachmentContentHistoryResourceAction": { "title": "GetRequisitionItemFileAttachmentContentHistoryResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Requisition Item File Attachment entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Requisition Item File Attachment entities", "items": { "$ref": "#/components/schemas/GetRequisitionItemFileAttachmentContentHistoryResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateRequisitionItemFileAttachmentResourceActionRequest": { "title": "BatchCreateRequisitionItemFileAttachmentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "requisitionItemId" ], "properties": { "requisitionItemId": { "title": "requisitionItemId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->RequisitionItem_Id" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->IsRestricted" }, "fileName": { "title": "fileName", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->FileName" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemFileAttachment->FileCategory_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionItemFileAttachment->PermissionTree_Id", "x-systemGenerated": true }, "file": { "type": "array", "items": { "type": "string", "format": "binary" } } } }, "BatchUpdateRequisitionItemFileAttachmentResourceActionRequest": { "title": "BatchUpdateRequisitionItemFileAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateRequisitionItemFileAttachmentResourceActionRequest" } }, "BatchDeleteRequisitionItemFileAttachmentResourceActionRequest": { "title": "BatchDeleteRequisitionItemFileAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteRequisitionItemFileAttachmentResourceResourceActionRequest" } }, "GetRequisitionItemTransactionResourceActionResponse": { "title": "GetRequisitionItemTransactionResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetRequisitionItemTransactionResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionItemTransaction->CreatedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->PermissionTree_Description" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_Id" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_Code" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_Description" }, "financialYearPeriodFinancialYearId": { "title": "financialYearPeriodFinancialYearId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Id" }, "financialYearPeriodFinancialYearCode": { "title": "financialYearPeriodFinancialYearCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Code" }, "financialYearPeriodFinancialYearDescription": { "title": "financialYearPeriodFinancialYearDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Description" }, "itemCostInSiteCurrency": { "title": "itemCostInSiteCurrency", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->ItemCostInSiteCurrency" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->Quantity" }, "requisitionItemId": { "title": "requisitionItemId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_Id" }, "requisitionItemRequisitionId": { "title": "requisitionItemRequisitionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_Requisition_Id" }, "requisitionItemRequisitionCode": { "title": "requisitionItemRequisitionCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_Requisition_Code" }, "requisitionItemRequisitionWorkOrderId": { "title": "requisitionItemRequisitionWorkOrderId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Id" }, "requisitionItemRequisitionWorkOrderCode": { "title": "requisitionItemRequisitionWorkOrderCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Code" }, "requisitionItemRequisitionWorkOrderDescription": { "title": "requisitionItemRequisitionWorkOrderDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Description" }, "requisitionItemWorkOrderTaskSpareId": { "title": "requisitionItemWorkOrderTaskSpareId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_Id" }, "requisitionItemWorkOrderTaskSpareSpareType": { "title": "requisitionItemWorkOrderTaskSpareSpareType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_SpareType", "x-formatSpecifier": "WorkOrderTaskSpareType" }, "requisitionItemWorkOrderTaskSpareDescription": { "title": "requisitionItemWorkOrderTaskSpareDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_Description" }, "requisitionItemWorkOrderTaskSpareStockItemId": { "title": "requisitionItemWorkOrderTaskSpareStockItemId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_StockItem_Id" }, "requisitionItemWorkOrderTaskSpareStockItemMaterialMasterId": { "title": "requisitionItemWorkOrderTaskSpareStockItemMaterialMasterId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_StockItem_MaterialMaster_Id" }, "requisitionItemWorkOrderTaskSpareStockItemMaterialMasterDescription": { "title": "requisitionItemWorkOrderTaskSpareStockItemMaterialMasterDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_StockItem_MaterialMaster_Description" }, "totalCostInSiteCurrency": { "title": "totalCostInSiteCurrency", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->TotalCostInSiteCurrency" }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionItemTransaction->TransactedOn" }, "transactionType": { "title": "transactionType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->TransactionType", "x-formatSpecifier": "RequisitionItemTransactionType" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetCostingCollectionForRequisitionItemTransactionResourceActionResponse": { "title": "GetCostingCollectionForRequisitionItemTransactionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetCostingCollectionForRequisitionItemTransactionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetCostingCollectionForRequisitionItemTransactionResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Costing->Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "Costing->Quantity" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Costing->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "nullable": false, "x-propertyPath": "Costing->CostElement_Code" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Costing->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "nullable": false, "x-propertyPath": "Costing->CostCentre_Code" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Costing->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "nullable": false, "x-propertyPath": "Costing->GeneralLedger_Code" }, "totalCostInSiteCurrency": { "title": "totalCostInSiteCurrency", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "Costing->TotalCostInSiteCurrency" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Costing->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "nullable": false, "x-propertyPath": "Costing->Site_Code" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetRequisitionItemTransactionCollectionForRequisitionItemResourceActionResponse": { "title": "GetRequisitionItemTransactionCollectionForRequisitionItemResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRequisitionItemTransactionCollectionForRequisitionItemResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetRequisitionItemTransactionCollectionForRequisitionItemResourceActionResponseItemProperties", "type": "object", "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->PermissionTree_Description" }, "requisitionItemId": { "title": "requisitionItemId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_Id" }, "requisitionItemRequisitionId": { "title": "requisitionItemRequisitionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_Requisition_Id" }, "requisitionItemRequisitionCode": { "title": "requisitionItemRequisitionCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_Requisition_Code" }, "requisitionItemRequisitionWorkOrderId": { "title": "requisitionItemRequisitionWorkOrderId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Id" }, "requisitionItemRequisitionWorkOrderCode": { "title": "requisitionItemRequisitionWorkOrderCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Code" }, "requisitionItemRequisitionWorkOrderDescription": { "title": "requisitionItemRequisitionWorkOrderDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Description" }, "requisitionItemWorkOrderTaskSpareStockItemMaterialMasterCode": { "title": "requisitionItemWorkOrderTaskSpareStockItemMaterialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_StockItem_MaterialMaster_Code" }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionItemTransaction->TransactedOn" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->Quantity" }, "itemCostInSiteCurrency": { "title": "itemCostInSiteCurrency", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->ItemCostInSiteCurrency" }, "transactionType": { "title": "transactionType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->TransactionType", "x-formatSpecifier": "RequisitionItemTransactionType" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionItemTransaction->CreatedOn" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->CreatedByUser_Code" }, "totalCostInSiteCurrency": { "title": "totalCostInSiteCurrency", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->TotalCostInSiteCurrency" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_Id" }, "financialYearPeriodFinancialYearId": { "title": "financialYearPeriodFinancialYearId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Id" }, "financialYearPeriodFinancialYearCode": { "title": "financialYearPeriodFinancialYearCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Code" }, "financialYearPeriodFinancialYearDescription": { "title": "financialYearPeriodFinancialYearDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Description" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_Code" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetRequisitionItemTransactionCollectionForRequisitionResourceActionResponse": { "title": "GetRequisitionItemTransactionCollectionForRequisitionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRequisitionItemTransactionCollectionForRequisitionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetRequisitionItemTransactionCollectionForRequisitionResourceActionResponseItemProperties", "type": "object", "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->PermissionTree_Description" }, "requisitionItemId": { "title": "requisitionItemId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_Id" }, "requisitionItemRequisitionId": { "title": "requisitionItemRequisitionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_Requisition_Id" }, "requisitionItemRequisitionCode": { "title": "requisitionItemRequisitionCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_Requisition_Code" }, "requisitionItemRequisitionWorkOrderId": { "title": "requisitionItemRequisitionWorkOrderId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Id" }, "requisitionItemRequisitionWorkOrderCode": { "title": "requisitionItemRequisitionWorkOrderCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Code" }, "requisitionItemRequisitionWorkOrderDescription": { "title": "requisitionItemRequisitionWorkOrderDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Description" }, "requisitionItemWorkOrderTaskSpareStockItemMaterialMasterId": { "title": "requisitionItemWorkOrderTaskSpareStockItemMaterialMasterId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_StockItem_MaterialMaster_Id" }, "requisitionItemWorkOrderTaskSpareStockItemMaterialMasterCode": { "title": "requisitionItemWorkOrderTaskSpareStockItemMaterialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_StockItem_MaterialMaster_Code" }, "requisitionItemWorkOrderTaskSpareStockItemMaterialMasterDescription": { "title": "requisitionItemWorkOrderTaskSpareStockItemMaterialMasterDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_StockItem_MaterialMaster_Description" }, "requisitionItemWorkOrderTaskSpareSpareType": { "title": "requisitionItemWorkOrderTaskSpareSpareType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_SpareType", "x-formatSpecifier": "WorkOrderTaskSpareType" }, "requisitionItemWorkOrderTaskSpareCode": { "title": "requisitionItemWorkOrderTaskSpareCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_Code" }, "requisitionItemWorkOrderTaskSpareDescription": { "title": "requisitionItemWorkOrderTaskSpareDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_Description" }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionItemTransaction->TransactedOn" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->Quantity" }, "itemCostInSiteCurrency": { "title": "itemCostInSiteCurrency", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->ItemCostInSiteCurrency" }, "transactionType": { "title": "transactionType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->TransactionType", "x-formatSpecifier": "RequisitionItemTransactionType" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionItemTransaction->CreatedOn" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->CreatedByUser_Code" }, "totalCostInSiteCurrency": { "title": "totalCostInSiteCurrency", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->TotalCostInSiteCurrency" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_Id" }, "financialYearPeriodFinancialYearId": { "title": "financialYearPeriodFinancialYearId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Id" }, "financialYearPeriodFinancialYearCode": { "title": "financialYearPeriodFinancialYearCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Code" }, "financialYearPeriodFinancialYearDescription": { "title": "financialYearPeriodFinancialYearDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Description" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_Code" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetRequisitionItemTransactionCollectionResourceActionResponse": { "title": "GetRequisitionItemTransactionCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRequisitionItemTransactionCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetRequisitionItemTransactionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->PermissionTree_Description" }, "requisitionItemId": { "title": "requisitionItemId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_Id" }, "requisitionItemRequisitionId": { "title": "requisitionItemRequisitionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_Requisition_Id" }, "requisitionItemRequisitionCode": { "title": "requisitionItemRequisitionCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_Requisition_Code" }, "requisitionItemRequisitionWorkOrderId": { "title": "requisitionItemRequisitionWorkOrderId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Id" }, "requisitionItemRequisitionWorkOrderCode": { "title": "requisitionItemRequisitionWorkOrderCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Code" }, "requisitionItemRequisitionWorkOrderDescription": { "title": "requisitionItemRequisitionWorkOrderDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_Requisition_WorkOrder_Description" }, "requisitionItemWorkOrderTaskSpareDescription": { "title": "requisitionItemWorkOrderTaskSpareDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_Description" }, "requisitionItemWorkOrderTaskSpareStockItemMaterialMasterId": { "title": "requisitionItemWorkOrderTaskSpareStockItemMaterialMasterId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_StockItem_MaterialMaster_Id" }, "requisitionItemWorkOrderTaskSpareStockItemMaterialMasterCode": { "title": "requisitionItemWorkOrderTaskSpareStockItemMaterialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_StockItem_MaterialMaster_Code" }, "requisitionItemWorkOrderTaskSpareStockItemMaterialMasterDescription": { "title": "requisitionItemWorkOrderTaskSpareStockItemMaterialMasterDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_StockItem_MaterialMaster_Description" }, "requisitionItemWorkOrderTaskSpareSpareType": { "title": "requisitionItemWorkOrderTaskSpareSpareType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_SpareType", "x-formatSpecifier": "WorkOrderTaskSpareType" }, "requisitionItemWorkOrderTaskSpareCode": { "title": "requisitionItemWorkOrderTaskSpareCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->RequisitionItem_WorkOrderTaskSpare_Code" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_Id" }, "financialYearPeriodFinancialYearId": { "title": "financialYearPeriodFinancialYearId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Id" }, "financialYearPeriodFinancialYearCode": { "title": "financialYearPeriodFinancialYearCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Code" }, "financialYearPeriodFinancialYearDescription": { "title": "financialYearPeriodFinancialYearDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_FinancialYear_Description" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_Code" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->FinancialYearPeriod_Description" }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionItemTransaction->TransactedOn" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->Quantity" }, "itemCostInSiteCurrency": { "title": "itemCostInSiteCurrency", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->ItemCostInSiteCurrency" }, "totalCostInSiteCurrency": { "title": "totalCostInSiteCurrency", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->TotalCostInSiteCurrency" }, "transactionType": { "title": "transactionType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->TransactionType", "x-formatSpecifier": "RequisitionItemTransactionType" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionItemTransaction->CreatedOn" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItemTransaction->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItemTransaction->CreatedByUser_Code" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "UpdateRequisitionItemTransactionResourceActionRequest": { "title": "UpdateRequisitionItemTransactionResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" } } } }, "BatchGetRequisitionItemTransactionResourceAction": { "title": "BatchGetRequisitionItemTransactionResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Requisition Item Transaction entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Requisition Item Transaction entities", "items": { "$ref": "#/components/schemas/GetRequisitionItemTransactionResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchUpdateRequisitionItemTransactionResourceActionRequest": { "title": "BatchUpdateRequisitionItemTransactionResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateRequisitionItemTransactionResourceActionRequest" } }, "GetRequisitionStatusResourceActionResponse": { "title": "GetRequisitionStatusResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetRequisitionStatusResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatus->Code" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "RequisitionStatus->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatus->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatus->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatus->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionStatus->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatus->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatus->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatus->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionStatus->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionStatus->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatus->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatus->PermissionTree_Description" }, "applyStatusRestrictions": { "title": "applyStatusRestrictions", "type": "boolean", "nullable": true, "x-propertyPath": "RequisitionStatus->ApplyStatusRestrictions" }, "baseStatus": { "title": "baseStatus", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "RequisitionStatus->BaseStatus", "x-formatSpecifier": "RequisitionStatusBaseStatus" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatus->Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatus->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionStatus->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetRequisitionStatusCollectionResourceActionResponse": { "title": "GetRequisitionStatusCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRequisitionStatusCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetRequisitionStatusCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatus->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatus->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionStatus->SequenceNumber" }, "baseStatus": { "title": "baseStatus", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "RequisitionStatus->BaseStatus", "x-formatSpecifier": "RequisitionStatusBaseStatus" }, "applyStatusRestrictions": { "title": "applyStatusRestrictions", "type": "boolean", "nullable": true, "x-propertyPath": "RequisitionStatus->ApplyStatusRestrictions" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "RequisitionStatus->IsActive" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionStatusChangePermissionTreeLookupResourceActionResponse": { "title": "RequisitionStatusChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionStatusChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionStatusChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionStatusInsertPermissionTreeLookupResourceActionResponse": { "title": "RequisitionStatusInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionStatusInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionStatusInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateRequisitionStatusResourceActionRequest": { "title": "CreateRequisitionStatusResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateRequisitionStatusResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "permissionTreeId", "code", "description", "baseStatus" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionStatus->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "RequisitionStatus->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "RequisitionStatus->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionStatus->SequenceNumber" }, "baseStatus": { "title": "baseStatus", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "RequisitionStatus->BaseStatus", "x-formatSpecifier": "RequisitionStatusBaseStatus" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatus->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateRequisitionStatusResourceActionRequest": { "title": "UpdateRequisitionStatusResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "RequisitionStatus->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "RequisitionStatus->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionStatus->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatus->Notes" } ] } } }, "DeleteRequisitionStatusResourceActionRequest": { "title": "DeleteRequisitionStatusResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetRequisitionStatusResourceAction": { "title": "BatchGetRequisitionStatusResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Requisition Status entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Requisition Status entities", "items": { "$ref": "#/components/schemas/GetRequisitionStatusResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateRequisitionStatusResourceActionRequest": { "title": "BatchCreateRequisitionStatusResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateRequisitionStatusResourceActionRequest" } }, "BatchUpdateRequisitionStatusResourceActionRequest": { "title": "BatchUpdateRequisitionStatusResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateRequisitionStatusResourceActionRequest" } }, "BatchDeleteRequisitionStatusResourceActionRequest": { "title": "BatchDeleteRequisitionStatusResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteRequisitionStatusResourceActionRequest" } }, "ChangeRequisitionStatusIsActiveResourceActionRequest": { "title": "ChangeRequisitionStatusIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "RequisitionStatus->IsActive" } ] } } }, "ChangeRequisitionStatusPermissionTreeResourceActionRequest": { "title": "ChangeRequisitionStatusPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionStatus->PermissionTree_Id" } ] } } }, "BatchChangeRequisitionStatusIsActiveResourceActionRequest": { "title": "BatchChangeRequisitionStatusIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequisitionStatusIsActiveResourceActionRequest" } }, "BatchChangeRequisitionStatusPermissionTreeResourceActionRequest": { "title": "BatchChangeRequisitionStatusPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequisitionStatusPermissionTreeResourceActionRequest" } }, "GetRequisitionStatusAttributeResourceActionResponse": { "title": "GetRequisitionStatusAttributeResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetRequisitionStatusAttributeResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "requisitionStatusId": { "title": "requisitionStatusId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionStatusAttribute->RequisitionStatus_Id" }, "requisitionStatusCode": { "title": "requisitionStatusCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->RequisitionStatus_Code" }, "requisitionStatusDescription": { "title": "requisitionStatusDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->RequisitionStatus_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionStatusAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionStatusAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionStatusAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionStatusAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "RequisitionStatusAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "RequisitionStatusAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "RequisitionStatusAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "RequisitionStatusAttribute->Value", "x-formatSpecifier": "DynamicValue" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetRequisitionStatusAttributeCollectionForRequisitionStatusResourceActionResponse": { "title": "GetRequisitionStatusAttributeCollectionForRequisitionStatusResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRequisitionStatusAttributeCollectionForRequisitionStatusResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetRequisitionStatusAttributeCollectionForRequisitionStatusResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "RequisitionStatusAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "RequisitionStatusAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "RequisitionStatusAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionStatusAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionStatusAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetRequisitionStatusAttributeCollectionResourceActionResponse": { "title": "GetRequisitionStatusAttributeCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRequisitionStatusAttributeCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetRequisitionStatusAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->SequenceNumber" }, "requisitionStatusCode": { "title": "requisitionStatusCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusAttribute->RequisitionStatus_Code" }, "requisitionStatusDescription": { "title": "requisitionStatusDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusAttribute->RequisitionStatus_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "RequisitionStatusAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "RequisitionStatusAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "RequisitionStatusAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionStatusAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionStatusAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionStatusAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "RequisitionStatusAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionStatusAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionStatusAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "value": { "title": "value", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionStatusAttributeAttributeLookupResourceActionResponse": { "title": "RequisitionStatusAttributeAttributeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionStatusAttributeAttributeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionStatusAttributeAttributeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Attribute->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Attribute->Description" }, "allowAnyValue": { "title": "allowAnyValue", "type": "boolean", "nullable": false, "x-propertyPath": "Attribute->AllowAnyValue" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Attribute->DataType", "x-formatSpecifier": "DynamicValueType" }, "defaultValue": { "title": "defaultValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, "defaultAllowedValueId": { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id" }, "defaultAllowedValueValue": { "title": "defaultAllowedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultAllowedValueDescription": { "title": "defaultAllowedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Description" }, "explanation": { "title": "explanation", "type": "string", "nullable": true, "x-propertyPath": "Attribute->Explanation" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionStatusAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "RequisitionStatusAttributeChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionStatusAttributeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionStatusAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionStatusAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "RequisitionStatusAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionStatusAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionStatusAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionStatusAttributeRequisitionStatusLookupResourceActionResponse": { "title": "RequisitionStatusAttributeRequisitionStatusLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionStatusAttributeRequisitionStatusLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionStatusAttributeRequisitionStatusLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatus->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatus->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateRequisitionStatusAttributeResourceActionRequest": { "title": "CreateRequisitionStatusAttributeResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateRequisitionStatusAttributeResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "requisitionStatusId", "attributeId" ], "properties": { "requisitionStatusId": { "title": "requisitionStatusId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionStatusAttribute->RequisitionStatus_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionStatusAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "RequisitionStatusAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionStatusAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateRequisitionStatusAttributeResourceActionRequest": { "title": "UpdateRequisitionStatusAttributeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "value", "format": "composite", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusAttribute->Notes" } ] } } }, "DeleteRequisitionStatusAttributeResourceActionRequest": { "title": "DeleteRequisitionStatusAttributeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetRequisitionStatusAttributeResourceAction": { "title": "BatchGetRequisitionStatusAttributeResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Requisition Status Attribute entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Requisition Status Attribute entities", "items": { "$ref": "#/components/schemas/GetRequisitionStatusAttributeResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateRequisitionStatusAttributeResourceActionRequest": { "title": "BatchCreateRequisitionStatusAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateRequisitionStatusAttributeResourceActionRequest" } }, "BatchUpdateRequisitionStatusAttributeResourceActionRequest": { "title": "BatchUpdateRequisitionStatusAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateRequisitionStatusAttributeResourceActionRequest" } }, "BatchDeleteRequisitionStatusAttributeResourceActionRequest": { "title": "BatchDeleteRequisitionStatusAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteRequisitionStatusAttributeResourceActionRequest" } }, "ChangeRequisitionStatusAttributeIsActiveResourceActionRequest": { "title": "ChangeRequisitionStatusAttributeIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "RequisitionStatusAttribute->IsActive" } ] } } }, "ChangeRequisitionStatusAttributePermissionTreeResourceActionRequest": { "title": "ChangeRequisitionStatusAttributePermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionStatusAttribute->PermissionTree_Id" } ] } } }, "BatchChangeRequisitionStatusAttributeIsActiveResourceActionRequest": { "title": "BatchChangeRequisitionStatusAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequisitionStatusAttributeIsActiveResourceActionRequest" } }, "BatchChangeRequisitionStatusAttributePermissionTreeResourceActionRequest": { "title": "BatchChangeRequisitionStatusAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequisitionStatusAttributePermissionTreeResourceActionRequest" } }, "GetRequisitionStatusChangeHistoryResourceActionResponse": { "title": "GetRequisitionStatusChangeHistoryResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetRequisitionStatusChangeHistoryResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionStatusChangeHistory->CreatedOn" }, "elapsedTime": { "title": "elapsedTime", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RequisitionStatusChangeHistory->ElapsedTime" }, "isLatest": { "title": "isLatest", "type": "boolean", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->IsLatest" }, "newStatusId": { "title": "newStatusId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->NewStatus_Id" }, "newStatusCode": { "title": "newStatusCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->NewStatus_Code" }, "newStatusDescription": { "title": "newStatusDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->NewStatus_Description" }, "oldStatusId": { "title": "oldStatusId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->OldStatus_Id" }, "oldStatusCode": { "title": "oldStatusCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->OldStatus_Code" }, "oldStatusDescription": { "title": "oldStatusDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->OldStatus_Description" }, "predecessorId": { "title": "predecessorId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->Predecessor_Id" }, "predecessorRequisitionId": { "title": "predecessorRequisitionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->Predecessor_Requisition_Id" }, "predecessorRequisitionCode": { "title": "predecessorRequisitionCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->Predecessor_Requisition_Code" }, "remark": { "title": "remark", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->Remark" }, "requisitionId": { "title": "requisitionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->Requisition_Id" }, "requisitionCode": { "title": "requisitionCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->Requisition_Code" }, "requisitionRequestedOn": { "title": "requisitionRequestedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionStatusChangeHistory->Requisition_RequestedOn" }, "requisitionPermissionTreeId": { "title": "requisitionPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->Requisition_PermissionTree_Id" }, "requisitionPermissionTreeCode": { "title": "requisitionPermissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->Requisition_PermissionTree_Code" }, "requisitionPermissionTreeDescription": { "title": "requisitionPermissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->Requisition_PermissionTree_Description" }, "statusChangedOn": { "title": "statusChangedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionStatusChangeHistory->StatusChangedOn" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetRequisitionStatusChangeHistoryCollectionForRequisitionResourceActionResponse": { "title": "GetRequisitionStatusChangeHistoryCollectionForRequisitionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRequisitionStatusChangeHistoryCollectionForRequisitionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetRequisitionStatusChangeHistoryCollectionForRequisitionResourceActionResponseItemProperties", "type": "object", "properties": { "elapsedTime": { "title": "elapsedTime", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RequisitionStatusChangeHistory->ElapsedTime" }, "isLatest": { "title": "isLatest", "type": "boolean", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->IsLatest" }, "newStatusId": { "title": "newStatusId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->NewStatus_Id" }, "newStatusCode": { "title": "newStatusCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusChangeHistory->NewStatus_Code" }, "newStatusDescription": { "title": "newStatusDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusChangeHistory->NewStatus_Description" }, "oldStatusId": { "title": "oldStatusId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->OldStatus_Id" }, "oldStatusCode": { "title": "oldStatusCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusChangeHistory->OldStatus_Code" }, "oldStatusDescription": { "title": "oldStatusDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusChangeHistory->OldStatus_Description" }, "predecessorId": { "title": "predecessorId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->Predecessor_Id" }, "predecessorRequisitionCode": { "title": "predecessorRequisitionCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusChangeHistory->Predecessor_Requisition_Code" }, "remark": { "title": "remark", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->Remark" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionStatusChangeHistory->CreatedOn" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusChangeHistory->CreatedByUser_Code" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetRequisitionStatusChangeHistoryCollectionResourceActionResponse": { "title": "GetRequisitionStatusChangeHistoryCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRequisitionStatusChangeHistoryCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetRequisitionStatusChangeHistoryCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "elapsedTime": { "title": "elapsedTime", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RequisitionStatusChangeHistory->ElapsedTime" }, "isLatest": { "title": "isLatest", "type": "boolean", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->IsLatest" }, "newStatusId": { "title": "newStatusId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->NewStatus_Id" }, "newStatusCode": { "title": "newStatusCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusChangeHistory->NewStatus_Code" }, "newStatusDescription": { "title": "newStatusDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusChangeHistory->NewStatus_Description" }, "oldStatusId": { "title": "oldStatusId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->OldStatus_Id" }, "oldStatusCode": { "title": "oldStatusCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusChangeHistory->OldStatus_Code" }, "oldStatusDescription": { "title": "oldStatusDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusChangeHistory->OldStatus_Description" }, "predecessorId": { "title": "predecessorId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->Predecessor_Id" }, "predecessorRequisitionCode": { "title": "predecessorRequisitionCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusChangeHistory->Predecessor_Requisition_Code" }, "remark": { "title": "remark", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->Remark" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionStatusChangeHistory->CreatedOn" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusChangeHistory->CreatedByUser_Code" }, "requisitionId": { "title": "requisitionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusChangeHistory->Requisition_Id" }, "requisitionCode": { "title": "requisitionCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusChangeHistory->Requisition_Code" }, "requisitionRequestedOn": { "title": "requisitionRequestedOn", "type": "string", "format": "date-time", "nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionStatusChangeHistory->Requisition_RequestedOn" }, "requisitionPermissionTreeCode": { "title": "requisitionPermissionTreeCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusChangeHistory->Requisition_PermissionTree_Code" }, "requisitionPermissionTreeDescription": { "title": "requisitionPermissionTreeDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusChangeHistory->Requisition_PermissionTree_Description" }, "requisitionWorkOrderCode": { "title": "requisitionWorkOrderCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusChangeHistory->Requisition_WorkOrder_Code" }, "requisitionWorkOrderDescription": { "title": "requisitionWorkOrderDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusChangeHistory->Requisition_WorkOrder_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "BatchGetRequisitionStatusChangeHistoryResourceAction": { "title": "BatchGetRequisitionStatusChangeHistoryResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Requisition Status Change History entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Requisition Status Change History entities", "items": { "$ref": "#/components/schemas/GetRequisitionStatusChangeHistoryResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetRequisitionStatusDocumentResourceActionResponse": { "title": "GetRequisitionStatusDocumentResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetRequisitionStatusDocumentResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "requisitionStatusId": { "title": "requisitionStatusId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionStatusDocument->RequisitionStatus_Id" }, "requisitionStatusCode": { "title": "requisitionStatusCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->RequisitionStatus_Code" }, "requisitionStatusDescription": { "title": "requisitionStatusDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->RequisitionStatus_Description" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionStatusDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionStatusDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionStatusDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetRequisitionStatusDocumentCollectionForRequisitionStatusResourceActionResponse": { "title": "GetRequisitionStatusDocumentCollectionForRequisitionStatusResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRequisitionStatusDocumentCollectionForRequisitionStatusResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetRequisitionStatusDocumentCollectionForRequisitionStatusResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_FileType_Extension" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetRequisitionStatusDocumentCollectionResourceActionResponse": { "title": "GetRequisitionStatusDocumentCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRequisitionStatusDocumentCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetRequisitionStatusDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "requisitionStatusId": { "title": "requisitionStatusId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->RequisitionStatus_Id" }, "requisitionStatusCode": { "title": "requisitionStatusCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusDocument->RequisitionStatus_Code" }, "requisitionStatusDescription": { "title": "requisitionStatusDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusDocument->RequisitionStatus_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_FileType_Extension" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionStatusDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "RequisitionStatusDocumentChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionStatusDocumentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionStatusDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionStatusDocumentDocumentLookupResourceActionResponse": { "title": "RequisitionStatusDocumentDocumentLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionStatusDocumentDocumentLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionStatusDocumentDocumentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "DocumentRecord->Description" }, "fileLocation": { "title": "fileLocation", "type": "string", "nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, "fileFullName": { "title": "fileFullName", "type": "string", "nullable": true, "x-propertyPath": "DocumentRecord->FileFullName" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionStatusDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "RequisitionStatusDocumentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionStatusDocumentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionStatusDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "RequisitionStatusDocumentRequisitionStatusLookupResourceActionResponse": { "title": "RequisitionStatusDocumentRequisitionStatusLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RequisitionStatusDocumentRequisitionStatusLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "RequisitionStatusDocumentRequisitionStatusLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatus->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "RequisitionStatus->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateRequisitionStatusDocumentResourceActionRequest": { "title": "CreateRequisitionStatusDocumentResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateRequisitionStatusDocumentResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "requisitionStatusId", "documentRecordId" ], "properties": { "requisitionStatusId": { "title": "requisitionStatusId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionStatusDocument->RequisitionStatus_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionStatusDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionStatusDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateRequisitionStatusDocumentResourceActionRequest": { "title": "UpdateRequisitionStatusDocumentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "RequisitionStatusDocument->Notes" } ] } } }, "DeleteRequisitionStatusDocumentResourceActionRequest": { "title": "DeleteRequisitionStatusDocumentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetRequisitionStatusDocumentResourceAction": { "title": "BatchGetRequisitionStatusDocumentResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Requisition Status Document entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Requisition Status Document entities", "items": { "$ref": "#/components/schemas/GetRequisitionStatusDocumentResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateRequisitionStatusDocumentResourceActionRequest": { "title": "BatchCreateRequisitionStatusDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateRequisitionStatusDocumentResourceActionRequest" } }, "BatchUpdateRequisitionStatusDocumentResourceActionRequest": { "title": "BatchUpdateRequisitionStatusDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateRequisitionStatusDocumentResourceActionRequest" } }, "BatchDeleteRequisitionStatusDocumentResourceActionRequest": { "title": "BatchDeleteRequisitionStatusDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteRequisitionStatusDocumentResourceActionRequest" } }, "ChangeRequisitionStatusDocumentIsActiveResourceActionRequest": { "title": "ChangeRequisitionStatusDocumentIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "RequisitionStatusDocument->IsActive" } ] } } }, "ChangeRequisitionStatusDocumentPermissionTreeResourceActionRequest": { "title": "ChangeRequisitionStatusDocumentPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "RequisitionStatusDocument->PermissionTree_Id" } ] } } }, "BatchChangeRequisitionStatusDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeRequisitionStatusDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequisitionStatusDocumentPermissionTreeResourceActionRequest" } }, "BatchChangeRequisitionStatusDocumentIsActiveResourceActionRequest": { "title": "BatchChangeRequisitionStatusDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequisitionStatusDocumentIsActiveResourceActionRequest" } }, "GetStockItemResourceActionResponse": { "title": "GetStockItemResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetStockItemResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "StockItem->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "StockItem->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "StockItem->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItem->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "StockItem->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "StockItem->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItem->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItem->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "StockItem->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItem->PermissionTree_Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" }, "averageItemCost": { "title": "averageItemCost", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItem->AverageItemCost" }, "barcode": { "title": "barcode", "type": "string", "nullable": true, "x-propertyPath": "StockItem->Barcode" }, "categoryId": { "title": "categoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->Category_Id" }, "categoryCode": { "title": "categoryCode", "type": "string", "nullable": true, "x-propertyPath": "StockItem->Category_Code" }, "categoryDescription": { "title": "categoryDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItem->Category_Description" }, "classification": { "title": "classification", "type": "string", "nullable": true, "x-propertyPath": "StockItem->Classification" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItem->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "nullable": true, "x-propertyPath": "StockItem->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItem->CostElement_Description" }, "defaultStockItemBinId": { "title": "defaultStockItemBinId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->DefaultStockItemBin_Id" }, "defaultStockItemBinCode": { "title": "defaultStockItemBinCode", "type": "string", "nullable": true, "x-propertyPath": "StockItem->DefaultStockItemBin_Code" }, "defaultStockItemSupplierId": { "title": "defaultStockItemSupplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Id" }, "defaultStockItemSupplierSupplierId": { "title": "defaultStockItemSupplierSupplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Id" }, "defaultStockItemSupplierSupplierCode": { "title": "defaultStockItemSupplierSupplierCode", "type": "string", "nullable": true, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Code" }, "defaultStockItemSupplierSupplierDescription": { "title": "defaultStockItemSupplierSupplierDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Description" }, "highLifeExpectancy": { "title": "highLifeExpectancy", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StockItem->HighLifeExpectancy" }, "isInsuranceItem": { "title": "isInsuranceItem", "type": "boolean", "nullable": false, "x-propertyPath": "StockItem->IsInsuranceItem" }, "isStockItem": { "title": "isStockItem", "type": "boolean", "nullable": false, "x-propertyPath": "StockItem->IsStockItem" }, "itemSize": { "title": "itemSize", "type": "string", "nullable": true, "x-propertyPath": "StockItem->ItemSize" }, "leadTime": { "title": "leadTime", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StockItem->LeadTime" }, "lowLifeExpectancy": { "title": "lowLifeExpectancy", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StockItem->LowLifeExpectancy" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "nullable": true, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItem->MaterialMaster_Description" }, "materialMasterCommodityId": { "title": "materialMasterCommodityId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->MaterialMaster_Commodity_Id" }, "materialMasterCommodityCode": { "title": "materialMasterCommodityCode", "type": "string", "nullable": true, "x-propertyPath": "StockItem->MaterialMaster_Commodity_Code" }, "materialMasterCommodityDescription": { "title": "materialMasterCommodityDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItem->MaterialMaster_Commodity_Description" }, "maximumLevel": { "title": "maximumLevel", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItem->MaximumLevel" }, "mediumLifeExpectancy": { "title": "mediumLifeExpectancy", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StockItem->MediumLifeExpectancy" }, "minimumLevel": { "title": "minimumLevel", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItem->MinimumLevel" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "StockItem->Notes" }, "quantityOnHand": { "title": "quantityOnHand", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItem->QuantityOnHand" }, "replaceByDate": { "title": "replaceByDate", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItem->ReplaceByDate" }, "replacedOnDate": { "title": "replacedOnDate", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItem->ReplacedOnDate" }, "replaceWithStockItemId": { "title": "replaceWithStockItemId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->ReplaceWithStockItem_Id" }, "replaceWithStockItemMaterialMasterId": { "title": "replaceWithStockItemMaterialMasterId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->ReplaceWithStockItem_MaterialMaster_Id" }, "replaceWithStockItemMaterialMasterCode": { "title": "replaceWithStockItemMaterialMasterCode", "type": "string", "nullable": true, "x-propertyPath": "StockItem->ReplaceWithStockItem_MaterialMaster_Code" }, "replaceWithStockItemMaterialMasterDescription": { "title": "replaceWithStockItemMaterialMasterDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItem->ReplaceWithStockItem_MaterialMaster_Description" }, "replaceWithStockItemWarehouseId": { "title": "replaceWithStockItemWarehouseId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->ReplaceWithStockItem_Warehouse_Id" }, "replaceWithStockItemWarehouseCode": { "title": "replaceWithStockItemWarehouseCode", "type": "string", "nullable": true, "x-propertyPath": "StockItem->ReplaceWithStockItem_Warehouse_Code" }, "replaceWithStockItemWarehouseDescription": { "title": "replaceWithStockItemWarehouseDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItem->ReplaceWithStockItem_Warehouse_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "StockItem->SequenceNumber" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "nullable": true, "x-propertyPath": "StockItem->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItem->UnitOfMeasurement_Description" }, "warehouseId": { "title": "warehouseId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItem->Warehouse_Id" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "nullable": true, "x-propertyPath": "StockItem->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItem->Warehouse_Description" }, "warehouseSiteId": { "title": "warehouseSiteId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->Warehouse_Site_Id" }, "warehouseSiteCode": { "title": "warehouseSiteCode", "type": "string", "nullable": true, "x-propertyPath": "StockItem->Warehouse_Site_Code" }, "warehouseSiteDescription": { "title": "warehouseSiteDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItem->Warehouse_Site_Description" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetStockItemCollectionResourceActionResponse": { "title": "GetStockItemCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetStockItemCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetStockItemCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Description" }, "materialMasterCommodityId": { "title": "materialMasterCommodityId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->MaterialMaster_Commodity_Id" }, "materialMasterCommodityCode": { "title": "materialMasterCommodityCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Commodity_Code" }, "warehouseId": { "title": "warehouseId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->Warehouse_Id" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->Warehouse_Code" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" }, "averageItemCost": { "title": "averageItemCost", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItem->AverageItemCost" }, "quantityOnHand": { "title": "quantityOnHand", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItem->QuantityOnHand" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Code" }, "categoryId": { "title": "categoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->Category_Id" }, "categoryCode": { "title": "categoryCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->Category_Code" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->CostElement_Code" }, "defaultStockItemBinId": { "title": "defaultStockItemBinId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->DefaultStockItemBin_Id" }, "defaultStockItemBinCode": { "title": "defaultStockItemBinCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->DefaultStockItemBin_Code" }, "defaultStockItemSupplierId": { "title": "defaultStockItemSupplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Id" }, "defaultStockItemSupplierSupplierCode": { "title": "defaultStockItemSupplierSupplierCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Code" }, "defaultStockItemSupplierSupplierDescription": { "title": "defaultStockItemSupplierSupplierDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Description" }, "replaceWithStockItemMaterialMasterCode": { "title": "replaceWithStockItemMaterialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->ReplaceWithStockItem_MaterialMaster_Code" }, "replaceWithStockItemMaterialMasterDescription": { "title": "replaceWithStockItemMaterialMasterDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->ReplaceWithStockItem_MaterialMaster_Description" }, "replaceWithStockItemWarehouseCode": { "title": "replaceWithStockItemWarehouseCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->ReplaceWithStockItem_Warehouse_Code" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemCategoryLookupResourceActionResponse": { "title": "StockItemCategoryLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemCategoryLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemCategoryLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Category->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Category->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemChangePermissionTreeLookupResourceActionResponse": { "title": "StockItemChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemCostElementLookupResourceActionResponse": { "title": "StockItemCostElementLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemCostElementLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemCostElementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "CostElement->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "CostElement->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemDefaultBinLookupResourceActionResponse": { "title": "StockItemDefaultBinLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemDefaultBinLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemDefaultBinLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "StockItemBin->Code" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemDefaultSupplierLookupResourceActionResponse": { "title": "StockItemDefaultSupplierLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemDefaultSupplierLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemDefaultSupplierLookupResourceActionResponseItemProperties", "type": "object", "properties": { "supplierCode": { "title": "supplierCode", "type": "string", "nullable": false, "x-propertyPath": "StockItemSupplier->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItemSupplier->Supplier_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemInsertPermissionTreeLookupResourceActionResponse": { "title": "StockItemInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemMaterialMasterLookupResourceActionResponse": { "title": "StockItemMaterialMasterLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemMaterialMasterLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemMaterialMasterLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->AlternativeDescription" }, "barcode": { "title": "barcode", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->Barcode" }, "isStockItem": { "title": "isStockItem", "type": "boolean", "nullable": false, "x-propertyPath": "MaterialMaster->IsStockItem" }, "isInsuranceItem": { "title": "isInsuranceItem", "type": "boolean", "nullable": false, "x-propertyPath": "MaterialMaster->IsInsuranceItem" }, "itemSize": { "title": "itemSize", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->ItemSize" }, "leadTime": { "title": "leadTime", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "MaterialMaster->LeadTime" }, "lowLifeExpectancy": { "title": "lowLifeExpectancy", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "MaterialMaster->LowLifeExpectancy" }, "mediumLifeExpectancy": { "title": "mediumLifeExpectancy", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "MaterialMaster->MediumLifeExpectancy" }, "highLifeExpectancy": { "title": "highLifeExpectancy", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "MaterialMaster->HighLifeExpectancy" }, "minimumLevel": { "title": "minimumLevel", "type": "number", "format": "float", "nullable": true, "x-propertyPath": "MaterialMaster->MinimumLevel" }, "maximumLevel": { "title": "maximumLevel", "type": "number", "format": "float", "nullable": true, "x-propertyPath": "MaterialMaster->MaximumLevel" }, "categoryId": { "title": "categoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMaster->Category_Id" }, "categoryCode": { "title": "categoryCode", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->Category_Code" }, "categoryDescription": { "title": "categoryDescription", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->Category_Description" }, "commodityId": { "title": "commodityId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMaster->Commodity_Id" }, "commodityCode": { "title": "commodityCode", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->Commodity_Code" }, "commodityDescription": { "title": "commodityDescription", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->Commodity_Description" }, "classification": { "title": "classification", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->Classification" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMaster->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->CostElement_Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MaterialMaster->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MaterialMaster->SequenceNumber" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MaterialMaster->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "nullable": false, "x-propertyPath": "MaterialMaster->UnitOfMeasurement_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemWithReplaceWithStockItemLookupResourceActionResponse": { "title": "StockItemWithReplaceWithStockItemLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemWithReplaceWithStockItemLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemWithReplaceWithStockItemLookupResourceActionResponseItemProperties", "type": "object", "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" }, "warehouseId": { "title": "warehouseId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->Warehouse_Id" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->Warehouse_Code" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemUnitOfMeasurementLookupResourceActionResponse": { "title": "StockItemUnitOfMeasurementLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemUnitOfMeasurementLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemUnitOfMeasurementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "UnitOfMeasurement->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "UnitOfMeasurement->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemWarehouseLookupResourceActionResponse": { "title": "StockItemWarehouseLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemWarehouseLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemWarehouseLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Warehouse->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Warehouse->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateStockItemResourceActionRequest": { "title": "CreateStockItemResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateStockItemResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "warehouseId", "materialMasterId", "costElementId", "isInsuranceItem", "isStockItem", "permissionTreeId", "unitOfMeasurementId", "averageItemCost" ], "properties": { "warehouseId": { "title": "warehouseId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItem->Warehouse_Id" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Id" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" }, "barcode": { "title": "barcode", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "StockItem->Barcode" }, "categoryId": { "title": "categoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->Category_Id" }, "classification": { "title": "classification", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "StockItem->Classification" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItem->CostElement_Id" }, "highLifeExpectancy": { "title": "highLifeExpectancy", "type": "string", "format": "duration", "minimum": 0.0, "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StockItem->HighLifeExpectancy" }, "itemSize": { "title": "itemSize", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "StockItem->ItemSize" }, "isInsuranceItem": { "title": "isInsuranceItem", "type": "boolean", "nullable": false, "x-propertyPath": "StockItem->IsInsuranceItem" }, "isStockItem": { "title": "isStockItem", "type": "boolean", "nullable": false, "x-propertyPath": "StockItem->IsStockItem" }, "leadTime": { "title": "leadTime", "type": "string", "format": "duration", "minimum": 0.0, "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StockItem->LeadTime" }, "lowLifeExpectancy": { "title": "lowLifeExpectancy", "type": "string", "format": "duration", "minimum": 0.0, "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StockItem->LowLifeExpectancy" }, "maximumLevel": { "title": "maximumLevel", "type": "number", "format": "decimal", "minimum": 0.0, "nullable": true, "x-propertyPath": "StockItem->MaximumLevel" }, "mediumLifeExpectancy": { "title": "mediumLifeExpectancy", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StockItem->MediumLifeExpectancy" }, "minimumLevel": { "title": "minimumLevel", "type": "number", "format": "decimal", "minimum": 0.0, "nullable": true, "x-propertyPath": "StockItem->MinimumLevel" }, "notes": { "title": "notes", "type": "string", "minLength": 1, "nullable": true, "x-propertyPath": "StockItem->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItem->PermissionTree_Id" }, "quantityOnHand": { "title": "quantityOnHand", "type": "number", "format": "decimal", "minimum": 0.0, "nullable": true, "x-propertyPath": "StockItem->QuantityOnHand" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "StockItem->SequenceNumber" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Id" }, "replaceWithStockItemId": { "title": "replaceWithStockItemId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->ReplaceWithStockItem_Id" }, "replaceByDate": { "title": "replaceByDate", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItem->ReplaceByDate" }, "replacedOnDate": { "title": "replacedOnDate", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItem->ReplacedOnDate" }, "averageItemCost": { "title": "averageItemCost", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "StockItem->AverageItemCost" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateStockItemResourceActionRequest": { "title": "UpdateStockItemResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "alternativeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" }, { "title": "barcode", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "StockItem->Barcode" }, { "title": "categoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->Category_Id" }, { "title": "classification", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "StockItem->Classification" }, { "title": "costElementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItem->CostElement_Id" }, { "title": "defaultStockItemBinId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->DefaultStockItemBin_Id" }, { "title": "defaultStockItemSupplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Id" }, { "title": "highLifeExpectancy", "type": "string", "format": "duration", "minimum": 0.0, "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StockItem->HighLifeExpectancy" }, { "title": "itemSize", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "StockItem->ItemSize" }, { "title": "isInsuranceItem", "type": "boolean", "nullable": false, "x-propertyPath": "StockItem->IsInsuranceItem" }, { "title": "isStockItem", "type": "boolean", "nullable": false, "x-propertyPath": "StockItem->IsStockItem" }, { "title": "leadTime", "type": "string", "format": "duration", "minimum": 0.0, "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StockItem->LeadTime" }, { "title": "lowLifeExpectancy", "type": "string", "format": "duration", "minimum": 0.0, "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StockItem->LowLifeExpectancy" }, { "title": "maximumLevel", "type": "number", "format": "decimal", "minimum": 0.0, "nullable": true, "x-propertyPath": "StockItem->MaximumLevel" }, { "title": "mediumLifeExpectancy", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StockItem->MediumLifeExpectancy" }, { "title": "minimumLevel", "type": "number", "format": "decimal", "minimum": 0.0, "nullable": true, "x-propertyPath": "StockItem->MinimumLevel" }, { "title": "notes", "type": "string", "minLength": 1, "nullable": true, "x-propertyPath": "StockItem->Notes" }, { "title": "quantityOnHand", "type": "number", "format": "decimal", "minimum": 0.0, "nullable": true, "x-propertyPath": "StockItem->QuantityOnHand" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "StockItem->SequenceNumber" }, { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Id" }, { "title": "replaceWithStockItemId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->ReplaceWithStockItem_Id" }, { "title": "replaceByDate", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItem->ReplaceByDate" }, { "title": "replacedOnDate", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItem->ReplacedOnDate" }, { "title": "averageItemCost", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItem->AverageItemCost" } ] } } }, "DeleteStockItemResourceActionRequest": { "title": "DeleteStockItemResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetStockItemResourceAction": { "title": "BatchGetStockItemResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Stock Item entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Stock Item entities", "items": { "$ref": "#/components/schemas/GetStockItemResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateStockItemResourceActionRequest": { "title": "BatchCreateStockItemResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateStockItemResourceActionRequest" } }, "BatchUpdateStockItemResourceActionRequest": { "title": "BatchUpdateStockItemResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateStockItemResourceActionRequest" } }, "BatchDeleteStockItemResourceActionRequest": { "title": "BatchDeleteStockItemResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteStockItemResourceActionRequest" } }, "ChangeStockItemIsActiveResourceActionRequest": { "title": "ChangeStockItemIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "StockItem->IsActive" } ] } } }, "ChangeStockItemPermissionTreeResourceActionRequest": { "title": "ChangeStockItemPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItem->PermissionTree_Id" } ] } } }, "BatchChangeStockItemIsActiveResourceActionRequest": { "title": "BatchChangeStockItemIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeStockItemIsActiveResourceActionRequest" } }, "BatchChangeStockItemPermissionTreeResourceActionRequest": { "title": "BatchChangeStockItemPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeStockItemPermissionTreeResourceActionRequest" } }, "EntityMatchRecordSchema": { "type": "object", "additionalProperties": false, "required": [ "id", "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch.", "format": "int64", "example": 14324399978 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 } } }, "MatchUpdateStockItemResourceActionRequest": { "title": "MatchUpdateStockItemResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entities", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" } }, "records": { "title": "records", "type": "array", "description": "Collection of entities to apply the patch operations to", "items": { "$ref": "#/components/schemas/EntityMatchRecordSchema" }, "x-matchupdateproperties": [ { "title": "categoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItem->Category_Id" }, { "title": "classification", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "StockItem->Classification" }, { "title": "costElementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItem->CostElement_Id" }, { "title": "minimumLevel", "type": "number", "format": "decimal", "minimum": 0.0, "nullable": true, "x-propertyPath": "StockItem->MinimumLevel" }, { "title": "maximumLevel", "type": "number", "format": "decimal", "minimum": 0.0, "nullable": true, "x-propertyPath": "StockItem->MaximumLevel" } ] } } }, "GetStockItemAttributeResourceActionResponse": { "title": "GetStockItemAttributeResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetStockItemAttributeResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemAttribute->StockItem_Id" }, "stockItemMaterialMasterId": { "title": "stockItemMaterialMasterId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemAttribute->StockItem_MaterialMaster_Id" }, "stockItemMaterialMasterCode": { "title": "stockItemMaterialMasterCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemAttribute->StockItem_MaterialMaster_Code" }, "stockItemMaterialMasterDescription": { "title": "stockItemMaterialMasterDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItemAttribute->StockItem_MaterialMaster_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "StockItemAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItemAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": true, "x-propertyPath": "StockItemAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "StockItemAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItemAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItemAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItemAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "nullable": true, "x-propertyPath": "StockItemAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "StockItemAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "StockItemAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItemAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "StockItemAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "StockItemAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItemAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "StockItemAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "StockItemAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "StockItemAttribute->Value", "x-formatSpecifier": "DynamicValue" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetStockItemAttributeCollectionForStockItemResourceActionResponse": { "title": "GetStockItemAttributeCollectionForStockItemResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetStockItemAttributeCollectionForStockItemResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetStockItemAttributeCollectionForStockItemResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "StockItemAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": false, "x-propertyPath": "StockItemAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItemAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "StockItemAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItemAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "StockItemAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "StockItemAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "StockItemAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItemAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItemAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetStockItemAttributeCollectionResourceActionResponse": { "title": "GetStockItemAttributeCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetStockItemAttributeCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetStockItemAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "StockItemAttribute->SequenceNumber" }, "stockItemBarcode": { "title": "stockItemBarcode", "type": "string", "nullable": true, "x-propertyPath": "StockItemAttribute->StockItem_Barcode" }, "stockItemMaterialMasterCode": { "title": "stockItemMaterialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "StockItemAttribute->StockItem_MaterialMaster_Code" }, "stockItemMaterialMasterDescription": { "title": "stockItemMaterialMasterDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItemAttribute->StockItem_MaterialMaster_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": false, "x-propertyPath": "StockItemAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItemAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "StockItemAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItemAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "StockItemAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "StockItemAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "StockItemAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItemAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItemAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "StockItemAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "value": { "title": "value", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemAttributeAttributeLookupResourceActionResponse": { "title": "StockItemAttributeAttributeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemAttributeAttributeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemAttributeAttributeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Attribute->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Attribute->Description" }, "allowAnyValue": { "title": "allowAnyValue", "type": "boolean", "nullable": false, "x-propertyPath": "Attribute->AllowAnyValue" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Attribute->DataType", "x-formatSpecifier": "DynamicValueType" }, "defaultValue": { "title": "defaultValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, "defaultAllowedValueId": { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id" }, "defaultAllowedValueValue": { "title": "defaultAllowedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultAllowedValueDescription": { "title": "defaultAllowedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Description" }, "explanation": { "title": "explanation", "type": "string", "nullable": true, "x-propertyPath": "Attribute->Explanation" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "StockItemAttributeChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemAttributeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "StockItemAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemAttributeStockItemLookupResourceActionResponse": { "title": "StockItemAttributeStockItemLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemAttributeStockItemLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemAttributeStockItemLookupResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterCode": { "title": "materialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateStockItemAttributeResourceActionRequest": { "title": "CreateStockItemAttributeResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateStockItemAttributeResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "stockItemId", "attributeId" ], "properties": { "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemAttribute->StockItem_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "StockItemAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "StockItemAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "StockItemAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateStockItemAttributeResourceActionRequest": { "title": "UpdateStockItemAttributeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "value", "format": "composite", "nullable": true, "x-propertyPath": "StockItemAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "StockItemAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "StockItemAttribute->Notes" } ] } } }, "DeleteStockItemAttributeResourceActionRequest": { "title": "DeleteStockItemAttributeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetStockItemAttributeResourceAction": { "title": "BatchGetStockItemAttributeResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Stock Item Attribute entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Stock Item Attribute entities", "items": { "$ref": "#/components/schemas/GetStockItemAttributeResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateStockItemAttributeResourceActionRequest": { "title": "BatchCreateStockItemAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateStockItemAttributeResourceActionRequest" } }, "BatchUpdateStockItemAttributeResourceActionRequest": { "title": "BatchUpdateStockItemAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateStockItemAttributeResourceActionRequest" } }, "BatchDeleteStockItemAttributeResourceActionRequest": { "title": "BatchDeleteStockItemAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteStockItemAttributeResourceActionRequest" } }, "ChangeStockItemAttributeIsActiveResourceActionRequest": { "title": "ChangeStockItemAttributeIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "StockItemAttribute->IsActive" } ] } } }, "ChangeStockItemAttributePermissionTreeResourceActionRequest": { "title": "ChangeStockItemAttributePermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemAttribute->PermissionTree_Id" } ] } } }, "BatchChangeStockItemAttributeIsActiveResourceActionRequest": { "title": "BatchChangeStockItemAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeStockItemAttributeIsActiveResourceActionRequest" } }, "BatchChangeStockItemAttributePermissionTreeResourceActionRequest": { "title": "BatchChangeStockItemAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeStockItemAttributePermissionTreeResourceActionRequest" } }, "GetStockItemBinResourceActionResponse": { "title": "GetStockItemBinResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetStockItemBinResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "StockItemBin->Code" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "StockItemBin->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemBin->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemBin->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "StockItemBin->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItemBin->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemBin->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemBin->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "StockItemBin->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItemBin->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemBin->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemBin->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItemBin->PermissionTree_Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "StockItemBin->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "StockItemBin->SequenceNumber" }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemBin->StockItem_Id" }, "stockItemMaterialMasterId": { "title": "stockItemMaterialMasterId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemBin->StockItem_MaterialMaster_Id" }, "stockItemMaterialMasterCode": { "title": "stockItemMaterialMasterCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemBin->StockItem_MaterialMaster_Code" }, "stockItemAlternativeDescription": { "title": "stockItemAlternativeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItemBin->StockItem_AlternativeDescription" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetStockItemBinCollectionResourceActionResponse": { "title": "GetStockItemBinCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetStockItemBinCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetStockItemBinCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "StockItemBin->Code" }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemBin->StockItem_Id" }, "stockItemAlternativeDescription": { "title": "stockItemAlternativeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItemBin->StockItem_AlternativeDescription" }, "stockItemWarehouseId": { "title": "stockItemWarehouseId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemBin->StockItem_Warehouse_Id" }, "stockItemWarehouseCode": { "title": "stockItemWarehouseCode", "type": "string", "nullable": false, "x-propertyPath": "StockItemBin->StockItem_Warehouse_Code" }, "stockItemMaterialMasterId": { "title": "stockItemMaterialMasterId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemBin->StockItem_MaterialMaster_Id" }, "stockItemMaterialMasterCode": { "title": "stockItemMaterialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "StockItemBin->StockItem_MaterialMaster_Code" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "StockItemBin->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "StockItemBin->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "StockItemBin->IsActive" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItemBin->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItemBin->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetStockItemBinForStockItemCollectionResourceActionResponse": { "title": "GetStockItemBinForStockItemCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetStockItemBinForStockItemCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetStockItemBinForStockItemCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "StockItemBin->Code" }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemBin->StockItem_Id" }, "stockItemAlternativeDescription": { "title": "stockItemAlternativeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItemBin->StockItem_AlternativeDescription" }, "stockItemWarehouseId": { "title": "stockItemWarehouseId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemBin->StockItem_Warehouse_Id" }, "stockItemWarehouseCode": { "title": "stockItemWarehouseCode", "type": "string", "nullable": false, "x-propertyPath": "StockItemBin->StockItem_Warehouse_Code" }, "stockItemMaterialMasterId": { "title": "stockItemMaterialMasterId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemBin->StockItem_MaterialMaster_Id" }, "stockItemMaterialMasterCode": { "title": "stockItemMaterialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "StockItemBin->StockItem_MaterialMaster_Code" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "StockItemBin->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "StockItemBin->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "StockItemBin->IsActive" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItemBin->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItemBin->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemBinChangePermissionTreeLookupResourceActionResponse": { "title": "StockItemBinChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemBinChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemBinChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemBinInsertPermissionTreeLookupResourceActionResponse": { "title": "StockItemBinInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemBinInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemBinInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemBinStockItemLookupResourceActionResponse": { "title": "StockItemBinStockItemLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemBinStockItemLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemBinStockItemLookupResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterCode": { "title": "materialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateStockItemBinResourceActionRequest": { "title": "CreateStockItemBinResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateStockItemBinResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "code", "stockItemId" ], "properties": { "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "StockItemBin->Code" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemBin->PermissionTree_Id", "x-systemGenerated": true }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemBin->StockItem_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "StockItemBin->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "StockItemBin->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateStockItemBinResourceActionRequest": { "title": "UpdateStockItemBinResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "StockItemBin->Code" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "StockItemBin->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "StockItemBin->Notes" } ] } } }, "DeleteStockItemBinResourceActionRequest": { "title": "DeleteStockItemBinResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetStockItemBinResourceAction": { "title": "BatchGetStockItemBinResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Stock Item Bin entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Stock Item Bin entities", "items": { "$ref": "#/components/schemas/GetStockItemBinResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateStockItemBinResourceActionRequest": { "title": "BatchCreateStockItemBinResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateStockItemBinResourceActionRequest" } }, "BatchUpdateStockItemBinResourceActionRequest": { "title": "BatchUpdateStockItemBinResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateStockItemBinResourceActionRequest" } }, "BatchDeleteStockItemBinResourceActionRequest": { "title": "BatchDeleteStockItemBinResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteStockItemBinResourceActionRequest" } }, "ChangeStockItemBinIsActiveResourceActionRequest": { "title": "ChangeStockItemBinIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "StockItemBin->IsActive" } ] } } }, "ChangeStockItemBinPermissionTreeResourceActionRequest": { "title": "ChangeStockItemBinPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemBin->PermissionTree_Id" } ] } } }, "BatchChangeStockItemBinIsActiveResourceActionRequest": { "title": "BatchChangeStockItemBinIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeStockItemBinIsActiveResourceActionRequest" } }, "BatchChangeStockItemBinPermissionTreeResourceActionRequest": { "title": "BatchChangeStockItemBinPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeStockItemBinPermissionTreeResourceActionRequest" } }, "GetStockItemDocumentResourceActionResponse": { "title": "GetStockItemDocumentResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetStockItemDocumentResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemDocument->StockItem_Id" }, "stockItemMaterialMasterId": { "title": "stockItemMaterialMasterId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemDocument->StockItem_MaterialMaster_Id" }, "stockItemMaterialMasterCode": { "title": "stockItemMaterialMasterCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemDocument->StockItem_MaterialMaster_Code" }, "stockItemMaterialMasterDescription": { "title": "stockItemMaterialMasterDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItemDocument->StockItem_MaterialMaster_Description" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": true, "x-propertyPath": "StockItemDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "StockItemDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItemDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "StockItemDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItemDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItemDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItemDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "StockItemDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "StockItemDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItemDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "StockItemDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "StockItemDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "StockItemDocument->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetStockItemDocumentCollectionForStockItemResourceActionResponse": { "title": "GetStockItemDocumentCollectionForStockItemResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetStockItemDocumentCollectionForStockItemResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetStockItemDocumentCollectionForStockItemResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "StockItemDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": false, "x-propertyPath": "StockItemDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItemDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "StockItemDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "StockItemDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItemDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "StockItemDocument->DocumentRecord_FileType_Extension" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetStockItemDocumentCollectionResourceActionResponse": { "title": "GetStockItemDocumentCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetStockItemDocumentCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetStockItemDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemDocument->StockItem_Id" }, "stockItemMaterialMasterCode": { "title": "stockItemMaterialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "StockItemDocument->StockItem_MaterialMaster_Code" }, "stockItemMaterialMasterDescription": { "title": "stockItemMaterialMasterDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItemDocument->StockItem_MaterialMaster_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "StockItemDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": false, "x-propertyPath": "StockItemDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItemDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "StockItemDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "StockItemDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItemDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "StockItemDocument->DocumentRecord_FileType_Extension" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "StockItemDocumentChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemDocumentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemDocumentDocumentLookupResourceActionResponse": { "title": "StockItemDocumentDocumentLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemDocumentDocumentLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemDocumentDocumentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "DocumentRecord->Description" }, "fileLocation": { "title": "fileLocation", "type": "string", "nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, "fileFullName": { "title": "fileFullName", "type": "string", "nullable": true, "x-propertyPath": "DocumentRecord->FileFullName" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "StockItemDocumentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemDocumentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemDocumentStockItemLookupResourceActionResponse": { "title": "StockItemDocumentStockItemLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemDocumentStockItemLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemDocumentStockItemLookupResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterCode": { "title": "materialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateStockItemDocumentResourceActionRequest": { "title": "CreateStockItemDocumentResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateStockItemDocumentResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "stockItemId", "documentRecordId" ], "properties": { "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemDocument->StockItem_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "StockItemDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "StockItemDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateStockItemDocumentResourceActionRequest": { "title": "UpdateStockItemDocumentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "StockItemDocument->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "StockItemDocument->Notes" } ] } } }, "DeleteStockItemDocumentResourceActionRequest": { "title": "DeleteStockItemDocumentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetStockItemDocumentResourceAction": { "title": "BatchGetStockItemDocumentResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Stock Item Document entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Stock Item Document entities", "items": { "$ref": "#/components/schemas/GetStockItemDocumentResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateStockItemDocumentResourceActionRequest": { "title": "BatchCreateStockItemDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateStockItemDocumentResourceActionRequest" } }, "BatchUpdateStockItemDocumentResourceActionRequest": { "title": "BatchUpdateStockItemDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateStockItemDocumentResourceActionRequest" } }, "BatchDeleteStockItemDocumentResourceActionRequest": { "title": "BatchDeleteStockItemDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteStockItemDocumentResourceActionRequest" } }, "ChangeStockItemDocumentIsActiveResourceActionRequest": { "title": "ChangeStockItemDocumentIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "StockItemDocument->IsActive" } ] } } }, "ChangeStockItemDocumentPermissionTreeResourceActionRequest": { "title": "ChangeStockItemDocumentPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemDocument->PermissionTree_Id" } ] } } }, "BatchChangeStockItemDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeStockItemDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeStockItemDocumentPermissionTreeResourceActionRequest" } }, "BatchChangeStockItemDocumentIsActiveResourceActionRequest": { "title": "BatchChangeStockItemDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeStockItemDocumentIsActiveResourceActionRequest" } }, "GetStockItemFileAttachmentResourceActionResponse": { "title": "GetStockItemFileAttachmentResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetStockItemFileAttachmentResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemFileAttachment->StockItem_Id" }, "stockItemMaterialMasterId": { "title": "stockItemMaterialMasterId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemFileAttachment->StockItem_MaterialMaster_Id" }, "stockItemMaterialMasterCode": { "title": "stockItemMaterialMasterCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemFileAttachment->StockItem_MaterialMaster_Code" }, "stockItemMaterialMasterDescription": { "title": "stockItemMaterialMasterDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItemFileAttachment->StockItem_MaterialMaster_Description" }, "stockItemWarehouseId": { "title": "stockItemWarehouseId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemFileAttachment->StockItem_Warehouse_Id" }, "stockItemWarehouseCode": { "title": "stockItemWarehouseCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemFileAttachment->StockItem_Warehouse_Code" }, "stockItemWarehouseDescription": { "title": "stockItemWarehouseDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItemFileAttachment->StockItem_Warehouse_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemFileAttachment->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemFileAttachment->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "StockItemFileAttachment->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItemFileAttachment->CreatedOn" }, "contentId": { "title": "contentId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemFileAttachment->Content_Id" }, "contentFileLocationId": { "title": "contentFileLocationId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemFileAttachment->Content_FileLocation_Id" }, "contentFileLocationDescription": { "title": "contentFileLocationDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItemFileAttachment->Content_FileLocation_Description" }, "contentFileLocationFileLocationType": { "title": "contentFileLocationFileLocationType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "StockItemFileAttachment->Content_FileLocation_FileLocationType", "x-formatSpecifier": "FileContentStoreLocationType" }, "contentFileLocationOnKeyFileStoreId": { "title": "contentFileLocationOnKeyFileStoreId", "type": "string", "format": "uuid", "nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "StockItemFileAttachment->Content_FileLocation_OnKeyFileStoreId" }, "contentSizeInBytes": { "title": "contentSizeInBytes", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemFileAttachment->Content_SizeInBytes" }, "contentSizeInKb": { "title": "contentSizeInKb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItemFileAttachment->Content_SizeInKb" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItemFileAttachment->Content_SizeInMb" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "nullable": false, "x-propertyPath": "StockItemFileAttachment->ContentVersion" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "StockItemFileAttachment->EntityType", "x-formatSpecifier": "EntityType" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItemFileAttachment->FileCategory_Description" }, "fileCategoryAutoIsRestricted": { "title": "fileCategoryAutoIsRestricted", "type": "boolean", "nullable": true, "x-propertyPath": "StockItemFileAttachment->FileCategory_AutoIsRestricted" }, "fileFullName": { "title": "fileFullName", "type": "string", "nullable": true, "x-propertyPath": "StockItemFileAttachment->FileFullName" }, "fileName": { "title": "fileName", "type": "string", "nullable": false, "x-propertyPath": "StockItemFileAttachment->FileName" }, "fileTypeId": { "title": "fileTypeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemFileAttachment->FileType_Id" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "StockItemFileAttachment->FileType_Extension" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "nullable": false, "x-propertyPath": "StockItemFileAttachment->IsRestricted" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "StockItemFileAttachment->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemFileAttachment->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemFileAttachment->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "StockItemFileAttachment->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItemFileAttachment->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItemFileAttachment->PermissionTree_Description" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetStockItemFileAttachmentCollectionForStockItemResourceActionResponse": { "title": "GetStockItemFileAttachmentCollectionForStockItemResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetStockItemFileAttachmentCollectionForStockItemResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetStockItemFileAttachmentCollectionForStockItemResourceActionResponseItemProperties", "type": "object", "properties": { "fileFullName": { "title": "fileFullName", "type": "string", "nullable": true, "x-propertyPath": "StockItemFileAttachment->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItemFileAttachment->Content_SizeInMb" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "nullable": false, "x-propertyPath": "StockItemFileAttachment->IsRestricted" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "nullable": false, "x-propertyPath": "StockItemFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItemFileAttachment->FileCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": false, "x-propertyPath": "StockItemFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItemFileAttachment->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItemFileAttachment->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItemFileAttachment->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetStockItemFileAttachmentCollectionResourceActionResponse": { "title": "GetStockItemFileAttachmentCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetStockItemFileAttachmentCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetStockItemFileAttachmentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemFileAttachment->StockItem_Id" }, "stockItemMaterialMasterCode": { "title": "stockItemMaterialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "StockItemFileAttachment->StockItem_MaterialMaster_Code" }, "stockItemWarehouseCode": { "title": "stockItemWarehouseCode", "type": "string", "nullable": false, "x-propertyPath": "StockItemFileAttachment->StockItem_Warehouse_Code" }, "fileFullName": { "title": "fileFullName", "type": "string", "nullable": true, "x-propertyPath": "StockItemFileAttachment->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItemFileAttachment->Content_SizeInMb" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "StockItemFileAttachment->FileType_Extension" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "nullable": false, "x-propertyPath": "StockItemFileAttachment->IsRestricted" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "nullable": false, "x-propertyPath": "StockItemFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItemFileAttachment->FileCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": false, "x-propertyPath": "StockItemFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItemFileAttachment->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItemFileAttachment->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItemFileAttachment->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateStockItemFileAttachmentResourceActionRequest": { "title": "CreateStockItemFileAttachmentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "stockItemId" ], "properties": { "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemFileAttachment->StockItem_Id" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "nullable": false, "x-propertyPath": "StockItemFileAttachment->IsRestricted" }, "fileName": { "title": "fileName", "type": "string", "nullable": false, "x-propertyPath": "StockItemFileAttachment->FileName" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemFileAttachment->FileCategory_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemFileAttachment->PermissionTree_Id", "x-systemGenerated": true }, "file": { "type": "string", "format": "binary" } } }, "UpdateStockItemFileAttachmentContentResourceActionRequest": { "title": "UpdateStockItemFileAttachmentContentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "x-propertyPath": "StockItemFileAttachment->Version" }, "file": { "type": "string", "format": "binary" } } }, "UpdateStockItemFileAttachmentResourceActionRequest": { "title": "UpdateStockItemFileAttachmentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "fileCategoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemFileAttachment->FileCategory_Id" }, { "title": "fileName", "type": "string", "nullable": false, "x-propertyPath": "StockItemFileAttachment->FileName" }, { "title": "isRestricted", "type": "boolean", "nullable": false, "x-propertyPath": "StockItemFileAttachment->IsRestricted" } ] } } }, "DeleteStockItemFileAttachmentResourceResourceActionRequest": { "title": "DeleteStockItemFileAttachmentResourceResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetStockItemFileAttachmentResourceAction": { "title": "BatchGetStockItemFileAttachmentResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Stock Item File Attachment entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Stock Item File Attachment entities", "items": { "$ref": "#/components/schemas/GetStockItemFileAttachmentResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetStockItemFileAttachmentContentHistoryResourceActionResponse": { "title": "GetStockItemFileAttachmentContentHistoryResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Id" }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Version" }, "contentId": { "title": "contentId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_Id" }, "contentFileLocationId": { "title": "contentFileLocationId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_Id" }, "contentFileLocationDescription": { "title": "contentFileLocationDescription", "type": "string", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_Description" }, "contentFileLocationFileLocationType": { "title": "contentFileLocationFileLocationType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_FileLocationType", "x-formatSpecifier": "FileContentStoreLocationType" }, "contentFileLocationOnKeyFileStoreId": { "title": "contentFileLocationOnKeyFileStoreId", "type": "string", "format": "uuid", "nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_OnKeyFileStoreId" }, "contentSizeInBytes": { "title": "contentSizeInBytes", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInBytes" }, "contentSizeInKb": { "title": "contentSizeInKb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInKb" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInMb" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->ContentVersion" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FileAttachmentContentHistory->CreatedOn" }, "fileAttachmentId": { "title": "fileAttachmentId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->FileAttachment_Id" } } }, "GetStockItemFileAttachmentContentHistoryResourceAction": { "title": "GetStockItemFileAttachmentContentHistoryResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Stock Item File Attachment entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Stock Item File Attachment entities", "items": { "$ref": "#/components/schemas/GetStockItemFileAttachmentContentHistoryResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateStockItemFileAttachmentResourceActionRequest": { "title": "BatchCreateStockItemFileAttachmentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "stockItemId" ], "properties": { "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemFileAttachment->StockItem_Id" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "nullable": false, "x-propertyPath": "StockItemFileAttachment->IsRestricted" }, "fileName": { "title": "fileName", "type": "string", "nullable": false, "x-propertyPath": "StockItemFileAttachment->FileName" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemFileAttachment->FileCategory_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemFileAttachment->PermissionTree_Id", "x-systemGenerated": true }, "file": { "type": "array", "items": { "type": "string", "format": "binary" } } } }, "BatchUpdateStockItemFileAttachmentResourceActionRequest": { "title": "BatchUpdateStockItemFileAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateStockItemFileAttachmentResourceActionRequest" } }, "BatchDeleteStockItemFileAttachmentResourceActionRequest": { "title": "BatchDeleteStockItemFileAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteStockItemFileAttachmentResourceResourceActionRequest" } }, "GetStockItemSupplierResourceActionResponse": { "title": "GetStockItemSupplierResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetStockItemSupplierResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "StockItemSupplier->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemSupplier->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemSupplier->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "StockItemSupplier->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItemSupplier->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemSupplier->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemSupplier->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "StockItemSupplier->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StockItemSupplier->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemSupplier->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemSupplier->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItemSupplier->PermissionTree_Description" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemSupplier->Currency_Id" }, "currencyCode": { "title": "currencyCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemSupplier->Currency_Code" }, "currencyDescription": { "title": "currencyDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItemSupplier->Currency_Description" }, "leadTime": { "title": "leadTime", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StockItemSupplier->LeadTime" }, "minimumOrderQuantity": { "title": "minimumOrderQuantity", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItemSupplier->MinimumOrderQuantity" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "StockItemSupplier->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "StockItemSupplier->SequenceNumber" }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemSupplier->StockItem_Id" }, "stockItemMaterialMasterId": { "title": "stockItemMaterialMasterId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemSupplier->StockItem_MaterialMaster_Id" }, "stockItemMaterialMasterCode": { "title": "stockItemMaterialMasterCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemSupplier->StockItem_MaterialMaster_Code" }, "stockItemAlternativeDescription": { "title": "stockItemAlternativeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItemSupplier->StockItem_AlternativeDescription" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemSupplier->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "nullable": true, "x-propertyPath": "StockItemSupplier->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItemSupplier->Supplier_Description" }, "supplierPartNumber": { "title": "supplierPartNumber", "type": "string", "nullable": true, "x-propertyPath": "StockItemSupplier->SupplierPartNumber" }, "unitCost": { "title": "unitCost", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "StockItemSupplier->UnitCost" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetStockItemSupplierCollectionResourceActionResponse": { "title": "GetStockItemSupplierCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetStockItemSupplierCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetStockItemSupplierCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemSupplier->StockItem_Id" }, "stockItemWarehouseCode": { "title": "stockItemWarehouseCode", "type": "string", "nullable": false, "x-propertyPath": "StockItemSupplier->StockItem_Warehouse_Code" }, "stockItemMaterialMasterCode": { "title": "stockItemMaterialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "StockItemSupplier->StockItem_MaterialMaster_Code" }, "stockItemAlternativeDescription": { "title": "stockItemAlternativeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItemSupplier->StockItem_AlternativeDescription" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemSupplier->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "nullable": false, "x-propertyPath": "StockItemSupplier->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItemSupplier->Supplier_Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "StockItemSupplier->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "StockItemSupplier->SequenceNumber" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetStockItemSuppliersForStockItemCollectionResourceActionResponse": { "title": "GetStockItemSuppliersForStockItemCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetStockItemSuppliersForStockItemCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetStockItemSuppliersForStockItemCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemSupplier->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "nullable": false, "x-propertyPath": "StockItemSupplier->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "nullable": false, "x-propertyPath": "StockItemSupplier->Supplier_Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "StockItemSupplier->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "StockItemSupplier->SequenceNumber" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemSupplierChangePermissionTreeLookupResourceActionResponse": { "title": "StockItemSupplierChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemSupplierChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemSupplierChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "LookupStockItemSupplierCurrencyLookupResourceActionResponse": { "title": "LookupStockItemSupplierCurrencyLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "LookupStockItemSupplierCurrencyLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "LookupStockItemSupplierCurrencyLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Currency->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Currency->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemSupplierInsertPermissionTreeLookupResourceActionResponse": { "title": "StockItemSupplierInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemSupplierInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemSupplierInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemSupplierStockItemLookupResourceActionResponse": { "title": "StockItemSupplierStockItemLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemSupplierStockItemLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemSupplierStockItemLookupResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterCode": { "title": "materialMasterCode", "type": "string", "nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "StockItemSupplierSupplierLookupResourceActionResponse": { "title": "StockItemSupplierSupplierLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StockItemSupplierSupplierLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "StockItemSupplierSupplierLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Supplier->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Supplier->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateStockItemSupplierResourceActionRequest": { "title": "CreateStockItemSupplierResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateStockItemSupplierResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "stockItemId", "supplierId" ], "properties": { "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemSupplier->StockItem_Id" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemSupplier->Supplier_Id" }, "supplierPartNumber": { "title": "supplierPartNumber", "type": "string", "nullable": true, "x-propertyPath": "StockItemSupplier->SupplierPartNumber" }, "leadTime": { "title": "leadTime", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StockItemSupplier->LeadTime" }, "unitCost": { "title": "unitCost", "type": "number", "format": "decimal", "minimum": 0.0, "nullable": true, "x-propertyPath": "StockItemSupplier->UnitCost" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemSupplier->Currency_Id", "x-systemGenerated": true }, "minimumOrderQuantity": { "title": "minimumOrderQuantity", "type": "number", "format": "decimal", "minimum": 0.0, "nullable": true, "x-propertyPath": "StockItemSupplier->MinimumOrderQuantity" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "StockItemSupplier->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemSupplier->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "StockItemSupplier->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateStockItemSupplierResourceActionRequest": { "title": "UpdateStockItemSupplierResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "supplierPartNumber", "type": "string", "nullable": true, "x-propertyPath": "StockItemSupplier->SupplierPartNumber" }, { "title": "leadTime", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StockItemSupplier->LeadTime" }, { "title": "unitCost", "type": "number", "format": "decimal", "minimum": 0.0, "nullable": true, "x-propertyPath": "StockItemSupplier->UnitCost" }, { "title": "currencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "StockItemSupplier->Currency_Id" }, { "title": "minimumOrderQuantity", "type": "number", "format": "decimal", "minimum": 0.0, "nullable": true, "x-propertyPath": "StockItemSupplier->MinimumOrderQuantity" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "StockItemSupplier->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "StockItemSupplier->SequenceNumber" } ] } } }, "DeleteStockItemSupplierResourceActionRequest": { "title": "DeleteStockItemSupplierResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetStockItemSupplierResourceAction": { "title": "BatchGetStockItemSupplierResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Stock Item Supplier entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Stock Item Supplier entities", "items": { "$ref": "#/components/schemas/GetStockItemSupplierResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateStockItemSupplierResourceActionRequest": { "title": "BatchCreateStockItemSupplierResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateStockItemSupplierResourceActionRequest" } }, "BatchUpdateStockItemSupplierResourceActionRequest": { "title": "BatchUpdateStockItemSupplierResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateStockItemSupplierResourceActionRequest" } }, "BatchDeleteStockItemSupplierResourceActionRequest": { "title": "BatchDeleteStockItemSupplierResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteStockItemSupplierResourceActionRequest" } }, "ChangeStockItemSupplierIsActiveResourceActionRequest": { "title": "ChangeStockItemSupplierIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "StockItemSupplier->IsActive" } ] } } }, "ChangeStockItemSupplierPermissionTreeResourceActionRequest": { "title": "ChangeStockItemSupplierPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "StockItemSupplier->PermissionTree_Id" } ] } } }, "BatchChangeStockItemSupplierIsActiveResourceActionRequest": { "title": "BatchChangeStockItemSupplierIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeStockItemSupplierIsActiveResourceActionRequest" } }, "BatchChangeStockItemSupplierPermissionTreeResourceActionRequest": { "title": "BatchChangeStockItemSupplierPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeStockItemSupplierPermissionTreeResourceActionRequest" } }, "GetWarehouseResourceActionResponse": { "title": "GetWarehouseResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetWarehouseResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Warehouse->Code" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "Warehouse->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Warehouse->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "Warehouse->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "Warehouse->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Warehouse->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Warehouse->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "Warehouse->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "Warehouse->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Warehouse->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Warehouse->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "Warehouse->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "Warehouse->PermissionTree_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Warehouse->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "nullable": true, "x-propertyPath": "Warehouse->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "nullable": true, "x-propertyPath": "Warehouse->Site_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Warehouse->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "nullable": true, "x-propertyPath": "Warehouse->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "nullable": true, "x-propertyPath": "Warehouse->CostCentre_Description" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Warehouse->Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Warehouse->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Warehouse->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetWarehouseCollectionResourceActionResponse": { "title": "GetWarehouseCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetWarehouseCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetWarehouseCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Warehouse->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Warehouse->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Warehouse->SequenceNumber" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Warehouse->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "nullable": false, "x-propertyPath": "Warehouse->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "nullable": false, "x-propertyPath": "Warehouse->CostCentre_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Warehouse->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "nullable": false, "x-propertyPath": "Warehouse->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "nullable": false, "x-propertyPath": "Warehouse->Site_Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Warehouse->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Warehouse->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Warehouse->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "WarehouseChangePermissionTreeLookupResourceActionResponse": { "title": "WarehouseChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "WarehouseChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "WarehouseChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "WarehouseCostCentreLookupResourceActionResponse": { "title": "WarehouseCostCentreLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "WarehouseCostCentreLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "WarehouseCostCentreLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "CostCentre->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "CostCentre->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "WarehouseInsertPermissionTreeLookupResourceActionResponse": { "title": "WarehouseInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "WarehouseInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "WarehouseInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "WarehouseSiteLookupResourceActionResponse": { "title": "WarehouseSiteLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "WarehouseSiteLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "WarehouseSiteLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Site->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Site->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateWarehouseResourceActionRequest": { "title": "CreateWarehouseResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateWarehouseResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "siteId", "code", "description", "costCentreId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Warehouse->PermissionTree_Id", "x-systemGenerated": true }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Warehouse->Site_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "Warehouse->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "Warehouse->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Warehouse->SequenceNumber" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Warehouse->CostCentre_Id" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Warehouse->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateWarehouseResourceActionRequest": { "title": "UpdateWarehouseResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "Warehouse->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "Warehouse->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Warehouse->SequenceNumber" }, { "title": "costCentreId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Warehouse->CostCentre_Id" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Warehouse->Notes" } ] } } }, "DeleteWarehouseResourceActionRequest": { "title": "DeleteWarehouseResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetWarehouseResourceAction": { "title": "BatchGetWarehouseResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Warehouse entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Warehouse entities", "items": { "$ref": "#/components/schemas/GetWarehouseResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateWarehouseResourceActionRequest": { "title": "BatchCreateWarehouseResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateWarehouseResourceActionRequest" } }, "BatchUpdateWarehouseResourceActionRequest": { "title": "BatchUpdateWarehouseResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateWarehouseResourceActionRequest" } }, "BatchDeleteWarehouseResourceActionRequest": { "title": "BatchDeleteWarehouseResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteWarehouseResourceActionRequest" } }, "ChangeWarehouseIsActiveResourceActionRequest": { "title": "ChangeWarehouseIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "Warehouse->IsActive" } ] } } }, "ChangeWarehousePermissionTreeResourceActionRequest": { "title": "ChangeWarehousePermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Warehouse->PermissionTree_Id" } ] } } }, "ChangeWarehouseSiteResourceActionRequest": { "title": "ChangeWarehouseSiteResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "siteId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Warehouse->Site_Id" } ] } } }, "BatchChangeWarehouseIsActiveResourceActionRequest": { "title": "BatchChangeWarehouseIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeWarehouseIsActiveResourceActionRequest" } }, "BatchChangeWarehousePermissionTreeResourceActionRequest": { "title": "BatchChangeWarehousePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeWarehousePermissionTreeResourceActionRequest" } }, "BatchChangeWarehouseSiteResourceActionRequest": { "title": "BatchChangeWarehouseSiteResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeWarehouseSiteResourceActionRequest" } }, "GetWarehouseAttributeResourceActionResponse": { "title": "GetWarehouseAttributeResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetWarehouseAttributeResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "warehouseId": { "title": "warehouseId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "WarehouseAttribute->Warehouse_Id" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "nullable": true, "x-propertyPath": "WarehouseAttribute->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "nullable": true, "x-propertyPath": "WarehouseAttribute->Warehouse_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "WarehouseAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "WarehouseAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "WarehouseAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WarehouseAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": true, "x-propertyPath": "WarehouseAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "WarehouseAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "WarehouseAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "WarehouseAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WarehouseAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "WarehouseAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "WarehouseAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "WarehouseAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "WarehouseAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": true, "x-propertyPath": "WarehouseAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": true, "x-propertyPath": "WarehouseAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "nullable": true, "x-propertyPath": "WarehouseAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "WarehouseAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "WarehouseAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "WarehouseAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "WarehouseAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "WarehouseAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "WarehouseAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "WarehouseAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "WarehouseAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "WarehouseAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "WarehouseAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "WarehouseAttribute->Value", "x-formatSpecifier": "DynamicValue" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetWarehouseAttributeCollectionForWarehouseResourceActionResponse": { "title": "GetWarehouseAttributeCollectionForWarehouseResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetWarehouseAttributeCollectionForWarehouseResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetWarehouseAttributeCollectionForWarehouseResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "WarehouseAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "WarehouseAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": false, "x-propertyPath": "WarehouseAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": false, "x-propertyPath": "WarehouseAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "WarehouseAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "WarehouseAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "WarehouseAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "WarehouseAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "WarehouseAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "WarehouseAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WarehouseAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WarehouseAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetWarehouseAttributeCollectionResourceActionResponse": { "title": "GetWarehouseAttributeCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetWarehouseAttributeCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetWarehouseAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "warehouseId": { "title": "warehouseId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "WarehouseAttribute->Warehouse_Id" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "nullable": false, "x-propertyPath": "WarehouseAttribute->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "nullable": false, "x-propertyPath": "WarehouseAttribute->Warehouse_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "WarehouseAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "WarehouseAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": false, "x-propertyPath": "WarehouseAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": false, "x-propertyPath": "WarehouseAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "WarehouseAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "WarehouseAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "WarehouseAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "WarehouseAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "WarehouseAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "WarehouseAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WarehouseAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WarehouseAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "WarehouseAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "WarehouseAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "WarehouseAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "WarehouseAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "value": { "title": "value", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "WarehouseAttributeAttributeLookupResourceActionResponse": { "title": "WarehouseAttributeAttributeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "WarehouseAttributeAttributeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "WarehouseAttributeAttributeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Attribute->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Attribute->Description" }, "allowAnyValue": { "title": "allowAnyValue", "type": "boolean", "nullable": false, "x-propertyPath": "Attribute->AllowAnyValue" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Attribute->DataType", "x-formatSpecifier": "DynamicValueType" }, "defaultValue": { "title": "defaultValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, "defaultAllowedValueId": { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id" }, "defaultAllowedValueValue": { "title": "defaultAllowedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultAllowedValueDescription": { "title": "defaultAllowedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Description" }, "explanation": { "title": "explanation", "type": "string", "nullable": true, "x-propertyPath": "Attribute->Explanation" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "WarehouseAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "WarehouseAttributeChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "WarehouseAttributeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "WarehouseAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "WarehouseAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "WarehouseAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "WarehouseAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "WarehouseAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "WarehouseAttributeWarehouseLookupResourceActionResponse": { "title": "WarehouseAttributeWarehouseLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "WarehouseAttributeWarehouseLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "WarehouseAttributeWarehouseLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Warehouse->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Warehouse->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateWarehouseAttributeResourceActionRequest": { "title": "CreateWarehouseAttributeResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateWarehouseAttributeResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "warehouseId", "attributeId" ], "properties": { "warehouseId": { "title": "warehouseId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "WarehouseAttribute->Warehouse_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "WarehouseAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "WarehouseAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "WarehouseAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "WarehouseAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "WarehouseAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "WarehouseAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateWarehouseAttributeResourceActionRequest": { "title": "UpdateWarehouseAttributeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "value", "format": "composite", "nullable": true, "x-propertyPath": "WarehouseAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "WarehouseAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "WarehouseAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "WarehouseAttribute->Notes" } ] } } }, "DeleteWarehouseAttributeResourceActionRequest": { "title": "DeleteWarehouseAttributeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetWarehouseAttributeResourceAction": { "title": "BatchGetWarehouseAttributeResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Warehouse Attribute entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Warehouse Attribute entities", "items": { "$ref": "#/components/schemas/GetWarehouseAttributeResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateWarehouseAttributeResourceActionRequest": { "title": "BatchCreateWarehouseAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateWarehouseAttributeResourceActionRequest" } }, "BatchUpdateWarehouseAttributeResourceActionRequest": { "title": "BatchUpdateWarehouseAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateWarehouseAttributeResourceActionRequest" } }, "BatchDeleteWarehouseAttributeResourceActionRequest": { "title": "BatchDeleteWarehouseAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteWarehouseAttributeResourceActionRequest" } }, "ChangeWarehouseAttributeIsActiveResourceActionRequest": { "title": "ChangeWarehouseAttributeIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "WarehouseAttribute->IsActive" } ] } } }, "ChangeWarehouseAttributePermissionTreeResourceActionRequest": { "title": "ChangeWarehouseAttributePermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "WarehouseAttribute->PermissionTree_Id" } ] } } }, "BatchChangeWarehouseAttributePermissionTreeResourceActionRequest": { "title": "BatchChangeWarehouseAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeWarehouseAttributePermissionTreeResourceActionRequest" } }, "BatchChangeWarehouseAttributeIsActiveResourceActionRequest": { "title": "BatchChangeWarehouseAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeWarehouseAttributeIsActiveResourceActionRequest" } }, "GetWarehouseDocumentResourceActionResponse": { "title": "GetWarehouseDocumentResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetWarehouseDocumentResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "warehouseId": { "title": "warehouseId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "WarehouseDocument->Warehouse_Id" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "nullable": true, "x-propertyPath": "WarehouseDocument->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "nullable": true, "x-propertyPath": "WarehouseDocument->Warehouse_Description" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": true, "x-propertyPath": "WarehouseDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "WarehouseDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "WarehouseDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "WarehouseDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WarehouseDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "WarehouseDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "WarehouseDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "WarehouseDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WarehouseDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "WarehouseDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "WarehouseDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "WarehouseDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "WarehouseDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": true, "x-propertyPath": "WarehouseDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": true, "x-propertyPath": "WarehouseDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "WarehouseDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "WarehouseDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "WarehouseDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "WarehouseDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "WarehouseDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "WarehouseDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "WarehouseDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "WarehouseDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "WarehouseDocument->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetWarehouseDocumentCollectionForWarehouseResourceActionResponse": { "title": "GetWarehouseDocumentCollectionForWarehouseResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetWarehouseDocumentCollectionForWarehouseResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetWarehouseDocumentCollectionForWarehouseResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "WarehouseDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "WarehouseDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": false, "x-propertyPath": "WarehouseDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": false, "x-propertyPath": "WarehouseDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "WarehouseDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "WarehouseDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "WarehouseDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "WarehouseDocument->DocumentRecord_FileType_Extension" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetWarehouseDocumentCollectionResourceActionResponse": { "title": "GetWarehouseDocumentCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetWarehouseDocumentCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetWarehouseDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "warehouseId": { "title": "warehouseId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "WarehouseDocument->Warehouse_Id" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "nullable": false, "x-propertyPath": "WarehouseDocument->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "nullable": false, "x-propertyPath": "WarehouseDocument->Warehouse_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "WarehouseDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "WarehouseDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": false, "x-propertyPath": "WarehouseDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": false, "x-propertyPath": "WarehouseDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "WarehouseDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "WarehouseDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "WarehouseDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "WarehouseDocument->DocumentRecord_FileType_Extension" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "WarehouseDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "WarehouseDocumentChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "WarehouseDocumentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "WarehouseDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "WarehouseDocumentDocumentLookupResourceActionResponse": { "title": "WarehouseDocumentDocumentLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "WarehouseDocumentDocumentLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "WarehouseDocumentDocumentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "DocumentRecord->Description" }, "fileLocation": { "title": "fileLocation", "type": "string", "nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, "fileFullName": { "title": "fileFullName", "type": "string", "nullable": true, "x-propertyPath": "DocumentRecord->FileFullName" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "WarehouseDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "WarehouseDocumentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "WarehouseDocumentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "WarehouseDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "WarehouseDocumentWarehouseLookupResourceActionResponse": { "title": "WarehouseDocumentWarehouseLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "WarehouseDocumentWarehouseLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "WarehouseDocumentWarehouseLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Warehouse->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Warehouse->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateWarehouseDocumentResourceActionRequest": { "title": "CreateWarehouseDocumentResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateWarehouseDocumentResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "warehouseId", "documentRecordId" ], "properties": { "warehouseId": { "title": "warehouseId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "WarehouseDocument->Warehouse_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "WarehouseDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "WarehouseDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "WarehouseDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "WarehouseDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateWarehouseDocumentResourceActionRequest": { "title": "UpdateWarehouseDocumentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "WarehouseDocument->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "WarehouseDocument->Notes" } ] } } }, "DeleteWarehouseDocumentResourceActionRequest": { "title": "DeleteWarehouseDocumentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetWarehouseDocumentResourceAction": { "title": "BatchGetWarehouseDocumentResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Warehouse Document entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Warehouse Document entities", "items": { "$ref": "#/components/schemas/GetWarehouseDocumentResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateWarehouseDocumentResourceActionRequest": { "title": "BatchCreateWarehouseDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateWarehouseDocumentResourceActionRequest" } }, "BatchUpdateWarehouseDocumentResourceActionRequest": { "title": "BatchUpdateWarehouseDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateWarehouseDocumentResourceActionRequest" } }, "BatchDeleteWarehouseDocumentResourceActionRequest": { "title": "BatchDeleteWarehouseDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteWarehouseDocumentResourceActionRequest" } }, "ChangeWarehouseDocumentIsActiveResourceActionRequest": { "title": "ChangeWarehouseDocumentIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "WarehouseDocument->IsActive" } ] } } }, "ChangeWarehouseDocumentPermissionTreeResourceActionRequest": { "title": "ChangeWarehouseDocumentPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "WarehouseDocument->PermissionTree_Id" } ] } } }, "BatchChangeWarehouseDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeWarehouseDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeWarehouseDocumentPermissionTreeResourceActionRequest" } }, "BatchChangeWarehouseDocumentIsActiveResourceActionRequest": { "title": "BatchChangeWarehouseDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeWarehouseDocumentIsActiveResourceActionRequest" } } }, "responses": { "default": { "description": "Error response - operation failed" }, "created": { "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "description": "Id of the resource created", "schema": { "type": "integer", "format": "Int64" }, "example": 1582413583401002 }, "OnKey-Resource-Location": { "description": "Uri to fetch the created resource", "schema": { "type": "string" }, "example": "/api/tenants/{client}/{connection}/Modules/GEN/Languages/1582413583401002" } } }, "accepted": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "description": "Request id for the Background Task created", "schema": { "type": "integer", "format": "Int64" }, "example": 1582413583401002 }, "OnKey-Request-Location": { "description": "URI to poll for the asynchronous execution status of the request", "schema": { "type": "string" }, "example": "/api/tenants/{client}/{connection}/Modules/System/BackgroundTasks/1582413583401002" } } }, "scheduled": { "description": "Request was successfully scheduled for asynchronous execution using a Scheduled Background Task", "headers": { "OnKey-Resource-Id": { "description": "Id of the Scheduled Background Task resource created", "schema": { "type": "integer", "format": "Int64" }, "example": 1582413583401002 }, "OnKey-Resource-Location": { "description": "Uri to fetch the Scheduled Background Task resource", "schema": { "type": "string" }, "example": "/api/tenants/{client}/{connection}/Modules/System/ScheduledBackgroundTasks/1582413583401002" }, "OnKey-Job-Id": { "description": "Job id of the job schedule created", "schema": { "type": "string", "format": "Uuid" }, "example": "cc4820be-e990-4161-85ff-eec4bbde2acb" }, "OnKey-Job-Schedule-Location": { "description": "URI to fetch the job schedule for the asynchronous execution of the request", "schema": { "type": "string" }, "example": "/api/tenants/{client}/{connection}/Modules/System/Jobs/cc4820be-e990-4161-85ff-eec4bbde2acb/Schedule" } } } }, "parameters": { "ExecutionMode": { "name": "mode", "in": "query", "description": "Execution mode to use for executing the batch operation", "schema": { "$ref": "#/components/schemas/OperationExecutionMode" } }, "Async": { "name": "async", "in": "query", "description": "Enqueue the operation asynchronously using a Background Task.", "schema": { "type": "boolean" } }, "AsyncDescription": { "name": "description", "in": "query", "description": "Optional description for the asynchronous execution of the Background Task.", "schema": { "type": "string", "nullable": true } }, "Schedule": { "name": "schedule", "in": "query", "description": "Optional cron expression to schedule the asynchronous execution of the Background Task.", "schema": { "type": "string", "nullable": true } }, "ScheduleFrom": { "name": "from", "in": "query", "description": "Optional future date at which a recurring schedule for the asynchronous execution of the Background Task should start. If no value is provided the current UTC date and time is used.", "schema": { "type": "string", "nullable": true } }, "Filter": { "name": "$filter", "in": "query", "description": "Filter expression to apply on the resource to limit the response data returned, e.g. $filter=id gt 0 and code startswith 'ABCD'", "schema": { "type": "string", "nullable": true } }, "OrderBy": { "name": "$orderby", "in": "query", "description": "Comma separated list of the data properties on the resource to order the response data returned, e.g. $orderby=id DESC,code ASC", "schema": { "type": "string", "nullable": true } }, "Param": { "name": "$param", "in": "query", "description": "Comma separated list of key/value pairs to parameterise `$filter` expressions to limit the response data returned, e.g. $param=@code:'JUMA'", "schema": { "type": "string", "nullable": true } }, "Select": { "name": "$select", "in": "query", "description": "Comma separated list of the data properties on the resource to return, e.g. $select=id,code,description", "schema": { "type": "string", "nullable": true } }, "Skip": { "name": "$skip", "in": "query", "description": "Number of items to skip. Use in combination with `$top` to page through the response data returned, e.g. $skip=20", "schema": { "type": "string", "nullable": true } }, "Top": { "name": "$top", "in": "query", "description": "Number of items to return in the response data, e.g. $top=20", "schema": { "type": "string", "nullable": true } } }, "securitySchemes": { "Bearer": { "type": "http", "description": "Use the JWT access token received by authenticating with your configured On Key Identity Provider", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "Bearer": [] } ], "tags": [ { "name": "Category" }, { "name": "Commodity" }, { "name": "Material Master" }, { "name": "Material Master Attribute" }, { "name": "Material Master Bin" }, { "name": "Material Master Document" }, { "name": "Material Master Supplier" }, { "name": "Requisition" }, { "name": "Requisition Attribute" }, { "name": "Requisition Document" }, { "name": "Requisition File Attachment" }, { "name": "Requisition Item" }, { "name": "Requisition Item File Attachment" }, { "name": "Requisition Item Transaction" }, { "name": "Requisition Status" }, { "name": "Requisition Status Attribute" }, { "name": "Requisition Status Change History" }, { "name": "Requisition Status Document" }, { "name": "Stock Item" }, { "name": "Stock Item Attribute" }, { "name": "Stock Item Bin" }, { "name": "Stock Item Document" }, { "name": "Stock Item File Attachment" }, { "name": "Stock Item Supplier" }, { "name": "Warehouse" }, { "name": "Warehouse Attribute" }, { "name": "Warehouse Document" } ], "x-tagGroups": [ { "name": "MM", "tags": [ "Category", "Commodity", "Material Master", "Material Master Attribute", "Material Master Bin", "Material Master Document", "Material Master Supplier", "Requisition", "Requisition Attribute", "Requisition Document", "Requisition File Attachment", "Requisition Item", "Requisition Item File Attachment", "Requisition Item Transaction", "Requisition Status", "Requisition Status Attribute", "Requisition Status Change History", "Requisition Status Document", "Stock Item", "Stock Item Attribute", "Stock Item Bin", "Stock Item Document", "Stock Item File Attachment", "Stock Item Supplier", "Warehouse", "Warehouse Attribute", "Warehouse Document" ] } ] }