Create inventory attribute exceptions
/fscmRestApi/resources/11.13.18.05/inventoryAttributeExceptions
Request
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
- application/json
object
-
AttributeExceptionId: integer
(int64)
Value that uniquely identifies the inventory attribute exception.
-
CatalogId: integer
(int64)
Value that uniquely identifies the item catalog. The value of this column is null if the attribute control is defined for an item.
-
CatalogName: string
Maximum Length:
255
Name of the item catalog. -
CategoryCode: string
Maximum Length:
255
Abbreviation that identifies the item category. -
CategoryId: integer
(int64)
Value that uniquely identifies the item category. The value of this column is null if the attribute control is defined for an item.
-
CategoryName: string
Maximum Length:
255
Name of the item category. -
InvAttributeCode: string
Maximum Length:
30
Indicates the name of the inventory attribute for which the control is defined. -
InvAttributeExceptionType: string
Maximum Length:
30
Indicates whether the control is defined for the item or the item category. A value of I indicates that the control is defined at the item level. A value of C indicates that the control is defined at the item category level. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item. The value of this column is NULL if the attribute control is defined for an item category.
-
ItemNumber: string
Maximum Length:
255
Name of the item. -
OrganizationCode: string
Maximum Length:
255
Abbreviation that identifies the inventory organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
OrganizationName: string
Maximum Length:
255
Name of the inventory organization. -
TrackingEnabledFlag: boolean
Maximum Length:
1
Indicates whether capturing of the inventory attribute is enabled or disabled.
Response
- application/json
Default Response
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
object
-
AttributeExceptionId: integer
(int64)
Value that uniquely identifies the inventory attribute exception.
-
CatalogId: integer
(int64)
Value that uniquely identifies the item catalog. The value of this column is null if the attribute control is defined for an item.
-
CatalogName: string
Maximum Length:
255
Name of the item catalog. -
CategoryCode: string
Maximum Length:
255
Abbreviation that identifies the item category. -
CategoryId: integer
(int64)
Value that uniquely identifies the item category. The value of this column is null if the attribute control is defined for an item.
-
CategoryName: string
Maximum Length:
255
Name of the item category. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the attribute exception. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the attribute exception. -
InvAttributeCode: string
Maximum Length:
30
Indicates the name of the inventory attribute for which the control is defined. -
InvAttributeExceptionType: string
Maximum Length:
30
Indicates whether the control is defined for the item or the item category. A value of I indicates that the control is defined at the item level. A value of C indicates that the control is defined at the item category level. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item. The value of this column is NULL if the attribute control is defined for an item category.
-
ItemNumber: string
Maximum Length:
255
Name of the item. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the attribute exception. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the attribute exception. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login information of the user who most recently updated the attribute exception. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried. -
OrganizationCode: string
Maximum Length:
255
Abbreviation that identifies the inventory organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
OrganizationName: string
Maximum Length:
255
Name of the inventory organization. -
TrackingEnabledFlag: boolean
Maximum Length:
1
Indicates whether capturing of the inventory attribute is enabled or disabled.
array
Links
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
These examples describe how to create inventory attribute exceptions.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions"
Example 1
This example describes how to create one inventory attribute exception for an item.
Example 1 Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{ "OrganizationCode":"PDSCM1", "ItemNumber":"INV-100", "InvAttributeExceptionType":"I", "InvAttributeCode":"COUNTRY_OF_ORIGIN_CODE", "TrackingEnabledFlag":"N" }
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{ "AttributeExceptionId" : 300100580146699, "OrganizationName" : null, "OrganizationCode" : "PDSCM1", "OrganizationId" : 300100200568379, "ItemNumber" : "INV-101", "InventoryItemId" : 663914, "CatalogName" : null, "CatalogId" : null, "CategoryName" : null, "CategoryCode" : null, "CategoryId" : null, "TrackingEnabledFlag" : false, "InvAttributeExceptionType" : "I", "InvAttributeCode" : "COUNTRY_OF_ORIGIN_CODE", "CreatedBy" : "SCMOPERATIONS", "CreationDate" : "2023-07-27T12:09:42+00:00", "LastUpdatedBy" : "SCMOPERATIONS", "LastUpdateDate" : "2023-07-27T12:09:42.554+00:00", "LastUpdateLogin" : "00B73A3F0FC41539E063496115AC6E9D", "ObjectVersionNumber" : 1, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions/300100580146699", "name" : "inventoryAttributeExceptions", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions/300100580146699", "name" : "inventoryAttributeExceptions", "kind" : "item" } ] }
Example 2
This example describes how to create one inventory attribute exception for a category.
Example 2 Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{ "OrganizationCode":"PDSCM1", "CatalogName":"A Catalog", "CategoryName":"A1 First Level Category", "InvAttributeExceptionType":"C", "InvAttributeCode":"COUNTRY_OF_ORIGIN_CODE", "TrackingEnabledFlag":"N" }
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
{ "ProcessingFlag": "true", "TransactionInterfaceId": 300100587169621, "OrganizationId": null, "OrganizationCode": "M3", "InventoryItemId": null, "ItemNumber": "INV-101", "Revision": null, "SourceSubinventoryCode": "MFGSUB12", "SourceLocatorId": null, "SourceLocatorName": null, "DestinationSubinventoryCode": null, "DestinationLocatorId": null, "DestinationLocatorName": null, "PrimaryTransactionQuantity": 20, "TransactionQuantity": 20, "TransactionUOMCode": "Ea", "TransactionUOMName": "Each", "SecondaryTransactionQuantity": null, "SecondaryUOMCode": null, "SecondaryUOMName": null, "AllocatedQuantity": null, "ShortQuantity": null, "TransactionDate": "2023-03-16", "TransactionTypeId": null, "TransactionTypeName": "Work in Process Material Issue", "MovementRequestHeaderId": null, "MovementRequestHeaderNumber": "5590989", "MovementRequestLineId": null, "MovementRequestLineNumber": 2, "SourceCode": "WMS", "TransactionReference": "AA_WO_100", "ExternalSystemTransactionReference": "24021", "ExternalSystemPackingUnit": "24021", "ReasonId": null, "ReasonName": null, "StatusCode": "ORA_ERROR", "Status": null, "ErrorCode": null, "ErrorExplanation": "The value of the attribute MoveOrderHeaderNumber isn't valid.", "OwningOrganizationId": 606, "OwningOrganizationCode": "M3", "OwningTradingPartnerTypeCode": "2", "OwningTradingPartnerType": "Inventory organization", "ProcurementBUName": null, "VendorName": null, "VendorNumber": null, "ConsignmentAgreementNumber": null, "lots": [ { "LotNumber": "MFGLOT1", "PrimaryQuantity": null, "TransactionQuantity": 10, "SecondaryTransactionQuantity": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions/300100587169621/child/lots/00020000000EACED00057708000110F09CE52755000000074D46474C4F5431", "name": "lots", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions/300100587169621/child/lots/00020000000EACED00057708000110F09CE52755000000074D46474C4F5431", "name": "lots", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions/300100587169621", "name": "inventoryAttributeExceptions", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions/300100587169621/child/lots/00020000000EACED00057708000110F09CE52755000000074D46474C4F5431/child/lotSerials", "name": "lotSerials", "kind": "collection" } ] }, { "LotNumber": "MFGLOT2", "PrimaryQuantity": null, "TransactionQuantity": 10, "SecondaryTransactionQuantity": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions/300100587169621/child/lots/00020000000EACED00057708000110F09CE52755000000074D46474C4F5432", "name": "lots", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions/300100587169621/child/lots/00020000000EACED00057708000110F09CE52755000000074D46474C4F5432", "name": "lots", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions/300100587169621", "name": "inventoryAttributeExceptions", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions/300100587169621/child/lots/00020000000EACED00057708000110F09CE52755000000074D46474C4F5432/child/lotSerials", "name": "lotSerials", "kind": "collection" } ] } ], "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions/300100587169621", "name": "inventoryAttributeExceptions", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions/300100587169621", "name": "inventoryAttributeExceptions", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions/300100587169621/child/DFF", "name": "DFF", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions/300100587169621/child/lots", "name": "lots", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions/300100587169621/child/serials", "name": "serials", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions/300100587169621/child/trackingAttributesDFF", "name": "trackingAttributesDFF", "kind": "collection" } ] }
Example 3
This example describes how to create multiple inventory attribute exceptions.
Example 3 Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{ "parts": [ { "id": "229111713", "path": "/inventoryAttributeExceptions", "operation": "create", "payload": { "OrganizationCode": "PDSCM1", "ItemNumber": "INV-100", "InvAttributeExceptionType": "I", "InvAttributeCode": "COUNTRY_OF_ORIGIN_CODE", "TrackingEnabledFlag": "N" } }, { "id": "229112010", "path": "/inventoryAttributeExceptions", "operation": "create", "payload": { "OrganizationCode": "PDSCM1", "ItemNumber": "INV-101", "InvAttributeExceptionType": "I", "InvAttributeCode": "COUNTRY_OF_ORIGIN_CODE", "TrackingEnabledFlag": "N" } } ] }
Example 3 Response Body
The following example includes the contents of the response body in JSON format:
{ "parts":[{"id":"229111713","path":"https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions","operation":"create","payload" : { "AttributeExceptionId" : 300100580146714, "OrganizationName" : "Seattle Manufacturing for PDSC", "OrganizationCode" : "PDSCM1", "OrganizationId" : 300100200568379, "ItemNumber" : "INV-100", "InventoryItemId" : 663913, "CatalogName" : null, "CatalogId" : null, "CategoryName" : null, "CategoryCode" : null, "CategoryId" : null, "TrackingEnabledFlag" : false, "InvAttributeExceptionType" : "I", "InvAttributeCode" : "COUNTRY_OF_ORIGIN_CODE", "CreatedBy" : "SCMOPERATIONS", "CreationDate" : "2023-07-27T12:26:14+00:00", "LastUpdatedBy" : "SCMOPERATIONS", "LastUpdateDate" : "2023-07-27T12:26:14.161+00:00", "LastUpdateLogin" : "00B743FA3FB71535E063496115AC3A0A", "ObjectVersionNumber" : 1, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions/300100580146714", "name" : "inventoryAttributeExceptions", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions/300100580146714", "name" : "inventoryAttributeExceptions", "kind" : "item" } ] } }, { "id" : "229112010", "path" : "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions", "operation" : "create", "payload" : { "AttributeExceptionId" : 300100580146715, "OrganizationName" : "Seattle Manufacturing for PDSC", "OrganizationCode" : "PDSCM1", "OrganizationId" : 300100200568379, "ItemNumber" : "INV-101", "InventoryItemId" : 663914, "CatalogName" : null, "CatalogId" : null, "CategoryName" : null, "CategoryCode" : null, "CategoryId" : null, "TrackingEnabledFlag" : false, "InvAttributeExceptionType" : "I", "InvAttributeCode" : "COUNTRY_OF_ORIGIN_CODE", "CreatedBy" : "SCMOPERATIONS", "CreationDate" : "2023-07-27T12:26:14.109+00:00", "LastUpdatedBy" : "SCMOPERATIONS", "LastUpdateDate" : "2023-07-27T12:26:14.187+00:00", "LastUpdateLogin" : "00B743FA3FB71535E063496115AC3A0A", "ObjectVersionNumber" : 1, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions/300100580146715", "name" : "inventoryAttributeExceptions", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions/300100580146715", "name" : "inventoryAttributeExceptions", "kind" : "item" } ] } } ] }