Jump to

• Request
• Response
• Examples

Update one item transaction default

patch

/fscmRestApi/resources/11.13.18.05/itemTransactionDefaults/{TransactionDefaultsId}

Request

Path Parameters

• TransactionDefaultsId(required): integer(int64)
  Value that uniquely identifies the item transaction default.

Header Parameters

• Metadata-Context: string
  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: string
  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

• DefaultTypeMeaning: string
  Maximum Length: 255

  Meaning of the code that indicates the default type.
• ItemDescription: string
  Maximum Length: 255

  Description of the item.
• ItemKeyword: string
  Maximum Length: 255

  Value used to search for an item transaction default using an item keyword.
• ItemNumber: string
  Maximum Length: 255

  Number that identifies the item.
• Locator: string
  Maximum Length: 255

  Value that uniquely identifies the locator of the item transaction default.
• LocatorId: integer (int64)
  Value that uniquely identifies the locator of the item transaction default.
• OrganizationCode: string
  Maximum Length: 255

  Value that uniquely identifies the organization of the item transaction default.
• OrganizationName: string
  Maximum Length: 255

  Value that uniquely identifies the organization of the item transaction default.
• PrimaryImageURL: string
  Maximum Length: 4000

  Value that provides a reference to the image of the item for which the transaction default is created or updated.
• SubDefault: string
  Maximum Length: 11

  Value that identifies both subinventory and locator defaults.
• SubinventoryCode: string
  Maximum Length: 10

  Value that uniquely identifies the subinventory of the item transaction default.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the organization of the item transaction default.",
            "nullable":true
        },
        "Locator":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the locator of the item transaction default.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SubinventoryCode"
                ]
            }
        },
        "ItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true
        },
        "DefaultTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Meaning of the code that indicates the default type.",
            "nullable":true
        },
        "SubDefault":{
            "maxLength":11,
            "type":"string",
            "description":"Value that identifies both subinventory and locator defaults.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "LocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the locator  of the item transaction default.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "SubinventoryCode"
                ]
            }
        },
        "OrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the organization of the item transaction default.",
            "nullable":true
        },
        "SubinventoryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Value that uniquely identifies the subinventory of the item transaction default.",
            "nullable":false
        },
        "ItemDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the item.",
            "nullable":true
        },
        "ItemKeyword":{
            "maxLength":255,
            "type":"string",
            "description":"Value used to search for an item transaction default using an item keyword.",
            "nullable":true
        },
        "PrimaryImageURL":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that provides a reference to the image of the item for which the transaction default is created or updated.",
            "nullable":true,
            "x-queryable":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:
  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.

Body ()

Root Schema : itemTransactionDefaults-item-response

Type: object

Show Source

• DefaultType: string
  Title: Default For

  Maximum Length: 30

  Code indicating the default type.
• DefaultTypeMeaning: string
  Maximum Length: 255

  Meaning of the code that indicates the default type.
• InventoryItemId: integer (int64)
  ID that identifies the item.
• ItemDescription: string
  Maximum Length: 255

  Description of the item.
• ItemKeyword: string
  Maximum Length: 255

  Value used to search for an item transaction default using an item keyword.
• ItemNumber: string
  Maximum Length: 255

  Number that identifies the item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Locator: string
  Maximum Length: 255

  Value that uniquely identifies the locator of the item transaction default.
• LocatorId: integer (int64)
  Value that uniquely identifies the locator of the item transaction default.
• OrganizationCode: string
  Maximum Length: 255

  Value that uniquely identifies the organization of the item transaction default.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization of the item transaction default.
• OrganizationName: string
  Maximum Length: 255

  Value that uniquely identifies the organization of the item transaction default.
• PrimaryImageURL: string
  Maximum Length: 4000

  Value that provides a reference to the image of the item for which the transaction default is created or updated.
• SubDefault: string
  Maximum Length: 11

  Value that identifies both subinventory and locator defaults.
• SubinventoryCode: string
  Maximum Length: 10

  Value that uniquely identifies the subinventory of the item transaction default.
• TransactionDefaultsId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item transaction default.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the organization of the item transaction default.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultType":{
            "title":"Default For",
            "maxLength":30,
            "type":"string",
            "description":"Code indicating the default type.",
            "nullable":false,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"ID that identifies the item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the locator  of the item transaction default.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "SubinventoryCode"
                ]
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization of the item transaction default.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubinventoryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Value that uniquely identifies the subinventory of the item transaction default.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "Locator":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the locator of the item transaction default.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SubinventoryCode"
                ]
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionDefaultsId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item transaction default.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DefaultTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Meaning of the code that indicates the default type.",
            "nullable":true,
            "x-queryable":true
        },
        "SubDefault":{
            "maxLength":11,
            "type":"string",
            "description":"Value that identifies both subinventory and locator defaults.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the organization of the item transaction default.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemKeyword":{
            "maxLength":255,
            "type":"string",
            "description":"Value used to search for an item transaction default using an item keyword.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryImageURL":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that provides a reference to the image of the item for which the transaction default is created or updated.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 item transaction default.

Note:

At least one of these attributes, Locator, Locatorid, and SubinventoryCode, is requird in the request payload.

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/itemTransactionDefaults/TransactionDefaultsId"

For example:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/itemTransactionDefaults/300100574673224?onlyData=true"

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.

{
"Locator": "ABC1.1.1"
}

Example Response Body

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

{

  "TransactionDefaultsId" : 300100574673224,

  "OrganizationId" : 207,

  "OrganizationCode" : "M1",

  "OrganizationName" : "Seattle Manufacturing",

  "InventoryItemId" : 663913,

  "ItemNumber" : "INV-100",

  "ItemDescription" : "Plain Item",

  "DefaultType" : "5",

  "DefaultTypeMeaning" : "Miscellaneous receipt",

  "SubinventoryCode" : "ABCSUB01",

  "LocatorId" : 3134,

  "Locator" : "ABC1.1.1",

  "SubDefault" : "ABCSUB01",

  "ItemKeyword" : null

}

Back to Top