Jump to

• Request
• Response
• Examples

Create quantities

post

/fscmRestApi/resources/11.13.18.05/collaborationSupplierOnHandQuantities

Request

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ItemNumber: string
  Number that identifies the item.
• ProcurementBUName: string
  Name of the business unit. The application assigns the supplier to this business unit.
• Quantity: number
  Quantity of the on-hand inventory for the item.
• SupplierItemNumber: string
  Number that identifies the item referred to by the supplier.
• SupplierName: string
  Maximum Length: 255

  Name of the supplier that holds the on-hand inventory for the item.
• SupplierSiteName: string
  Name of the supplier site that holds the on-hand inventory for the item.
• UnitOfMeasure: string
  Unit of measure for the item.
• UOMCode: string
  Abbreviation that identifies the unit of measure for the item.

{
    "type":"object",
    "properties":{
        "SupplierItemNumber":{
            "type":"string",
            "description":"Number that identifies the item referred to by the supplier.",
            "nullable":true
        },
        "ItemNumber":{
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true
        },
        "UnitOfMeasure":{
            "type":"string",
            "description":"Unit of measure for the item.",
            "nullable":true
        },
        "SupplierName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier that holds the on-hand inventory for the item.",
            "nullable":true
        },
        "ProcurementBUName":{
            "type":"string",
            "description":"Name of the business unit. The application assigns the supplier to this business unit.",
            "nullable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the on-hand inventory for the item.",
            "nullable":true
        },
        "SupplierSiteName":{
            "type":"string",
            "description":"Name of the supplier site that holds the on-hand inventory for the item.",
            "nullable":true
        },
        "UOMCode":{
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the item.",
            "nullable":true
        }
    }
}

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 : collaborationSupplierOnHandQuantities-item-response

Type: object

Show Source

• BaseQuantity: number
  Read Only: true

  Quantity of the on-hand inventory for the item in the base unit of measure.
• BaseUnitOfMeasure: string
  Read Only: true

  Maximum Length: 255

  Base unit of measure for the item.
• BaseUOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the base unit of measure for the item.
• CollaborationItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the collaboration item for the supplier on-hand quantity.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the on-hand quantity.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the on-hand quantity.
• InventoryItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the inventory item for the supplier on-hand quantity.
• ItemNumber: string
  Number that identifies the item.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the on-hand quantity.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 32

  Login of the user who most recently updated the on-hand quantity.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanningItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the planning item for the supplier on-hand quantity.
• ProcurementBUId: integer (int64)
  Title: Business Unit ID

  Read Only: true

  Value that uniquely identifies the business unit.
• ProcurementBUName: string
  Name of the business unit. The application assigns the supplier to this business unit.
• PublishedBy: string
  Read Only: true

  Maximum Length: 255

  User who most recently published the on-hand quantity.
• PublishedDate: string (date-time)
  Read Only: true

  Date when the on-hand quantity was published.
• PublishSource: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Value that indicates the type of user who performed the publish action. Values include Enterprise or Supplier.
• PublishSourceCode: string
  Read Only: true

  Maximum Length: 64

  Default Value: ORA_VCS_ENTERPRISE_VAL

  Abbreviation that identifies the type of user who performed the publish action. A list of accepted values is defined in the lookup type ORA_VCS_PARTY_ORIGIN. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.
• Quantity: number
  Quantity of the on-hand inventory for the item.
• SupplierId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier in the collaboration order forecast. This supplier sends the shipment. It's a primary key that the application generates when it creates the supplier.
• SupplierItemNumber: string
  Number that identifies the item referred to by the supplier.
• SupplierName: string
  Maximum Length: 255

  Name of the supplier that holds the on-hand inventory for the item.
• SupplierOnHandId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier on-hand quantity.
• SupplierSiteId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier site. This supplier site holds the on-hand inventory for the item. It's a primary key that the application generates when it creates the supplier site.
• SupplierSiteName: string
  Name of the supplier site that holds the on-hand inventory for the item.
• UnitOfMeasure: string
  Unit of measure for the item.
• UOMCode: string
  Abbreviation that identifies the unit of measure for the item.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the on-hand quantity.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierItemNumber":{
            "type":"string",
            "description":"Number that identifies the item referred to by the supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierOnHandId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier on-hand quantity.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PublishSource":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Value that indicates the type of user who performed the publish action. Values include Enterprise or Supplier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PublishedBy":{
            "maxLength":255,
            "type":"string",
            "description":"User who most recently published the on-hand quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteName":{
            "type":"string",
            "description":"Name of the supplier site that holds the on-hand inventory for the item.",
            "nullable":true,
            "x-queryable":true
        },
        "BaseUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the base unit of measure for the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site. This supplier site holds the on-hand inventory for the item. It's a primary key that the application generates when it creates the supplier site.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UOMCode":{
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"Value that uniquely identifies the business unit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"number_edit",
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":32,
            "type":"string",
            "description":"Login of the user who most recently updated the on-hand quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the on-hand quantity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "type":"string",
            "description":"Unit of measure for the item.",
            "nullable":true,
            "x-queryable":true
        },
        "CollaborationItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration item for the supplier on-hand quantity.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item for the supplier on-hand quantity.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BaseQuantity":{
            "type":"number",
            "description":"Quantity of the on-hand inventory for the item in the base unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the on-hand inventory for the item.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier in the collaboration order forecast. This supplier sends the shipment. It's a primary key that the application generates when it creates the supplier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier that holds the on-hand inventory for the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcurementBUName":{
            "type":"string",
            "description":"Name of the business unit. The application assigns the supplier to this business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning item for the supplier on-hand quantity.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BaseUnitOfMeasure":{
            "maxLength":255,
            "type":"string",
            "description":"Base unit of measure for the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PublishedDate":{
            "type":"string",
            "description":"Date when the on-hand quantity was published.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PublishSourceCode":{
            "maxLength":64,
            "type":"string",
            "description":"Abbreviation that identifies the type of user who performed the publish action. A list of accepted values is defined in the lookup type ORA_VCS_PARTY_ORIGIN. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_VCS_ENTERPRISE_VAL",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the on-hand quantity.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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 create quantities.

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/collaborationSupplierOnHandQuantities"

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

{
	"SupplierName": "CV_SuppD01",
	"SupplierSiteName": "CV_SuppD01Site1",
	"ItemNumber": "SCC-CNTRDL-01",
	"Quantity": 150,
	"UOMCode": "Ea"
}

Example Response Body

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

{
}

Back to Top