Jump to

• Request
• Response
• Examples

Update one inventory attribute exception

patch

/fscmRestApi/resources/11.13.18.05/inventoryAttributeExceptions/{AttributeExceptionId}

Request

Path Parameters

• AttributeExceptionId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AttributeExceptionId: integer (int64)
  Value that uniquely identifies the inventory attribute exception.
• CatalogName: string
  Maximum Length: 255

  Name of the item catalog.
• CategoryCode: string
  Maximum Length: 255

  Abbreviation that identifies the item category.
• CategoryName: string
  Maximum Length: 255

  Name of the item category.
• ItemNumber: string
  Maximum Length: 255

  Name of the item.
• OrganizationCode: string
  Maximum Length: 255

  Abbreviation that 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.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the inventory organization.",
            "nullable":true
        },
        "CategoryCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the item category.",
            "nullable":true
        },
        "ItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the item.",
            "nullable":true
        },
        "AttributeExceptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory attribute exception.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization.",
            "nullable":true
        },
        "CategoryName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the item category.",
            "nullable":true
        },
        "CatalogName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the item catalog.",
            "nullable":true
        },
        "TrackingEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether capturing of the inventory attribute is enabled or disabled.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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.

Body ()

Root Schema : inventoryAttributeExceptions-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the attribute exception.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item category. The value of this column is null if the attribute control is defined for an item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the inventory organization.",
            "nullable":true,
            "x-queryable":true
        },
        "CategoryCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the item category.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the attribute exception.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the attribute exception.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item. The value of this column is NULL if the attribute control is defined for an item category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InvAttributeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the name of the inventory attribute for which the control is defined.",
            "nullable":false,
            "x-queryable":true
        },
        "CatalogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item catalog. The value of this column is null if the attribute control is defined for an item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AttributeExceptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory attribute exception.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization.",
            "nullable":true,
            "x-queryable":true
        },
        "CategoryName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the item category.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CatalogName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the item catalog.",
            "nullable":true,
            "x-queryable":true
        },
        "InvAttributeExceptionType":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the attribute exception.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login information of the user who most recently updated the attribute exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TrackingEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether capturing of the inventory attribute is enabled or disabled.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

This example describes how to update one inventory attribute exception.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions/AttributeExceptionId"

Example 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.

{
        "TrackingEnabledFlag": "Y"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "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" : true,
  "InvAttributeExceptionType" : "I",
  "InvAttributeCode" : "COUNTRY_OF_ORIGIN_CODE",
  "CreatedBy" : "SCMOPERATIONS",
  "CreationDate" : "2023-07-27T12:26:14+00:00",
  "LastUpdatedBy" : "SCMOPERATIONS",
  "LastUpdateDate" : "2023-07-27T12:29:56+00:00",
  "LastUpdateLogin" : "00B73547B7CBD2E1E063AE6015ACD468",
  "ObjectVersionNumber" : 2,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions/300100580146714",
    "name" : "inventoryAttributeExceptions",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername/fscmRestApi/resources/version/inventoryAttributeExceptions/300100580146714",
    "name" : "inventoryAttributeExceptions",
    "kind" : "item"
  } ]
}

Back to Top