Jump to

• Request
• Response
• Examples

Get one quantity

get

/fscmRestApi/resources/11.13.18.05/collaborationSupplierOnHandQuantities/{SupplierOnHandId}

Request

Path Parameters

• SupplierOnHandId(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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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

Type: object

Show Source

• BaseQuantity: number
  Title: Item Primary UOM Quantity

  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
  Title: Item Primary UOM

  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
  Title: Item

  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
  Title: Procurement BU

  Name of the business unit. The application assigns the supplier to this business unit.
• PublishedBy: string
  Title: Published By

  Read Only: true

  Maximum Length: 255

  User who most recently published the on-hand quantity.
• PublishedDate: string (date-time)
  Title: Published Date

  Read Only: true

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

  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
  Title: Quantity

  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
  Title: Supplier Item

  Number that identifies the item referred to by the supplier.
• SupplierName: string
  Title: Supplier

  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
  Title: Supplier Site

  Name of the supplier site that holds the on-hand inventory for the item.
• UnitOfMeasure: string
  Title: UOM

  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":{
            "title":"Supplier Item",
            "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":"Publish Source",
            "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":{
            "title":"Published By",
            "maxLength":"255",
            "type":"string",
            "description":"User who most recently published the on-hand quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteName":{
            "title":"Supplier Site",
            "type":"string",
            "description":"Name of the supplier site that holds the on-hand inventory for the item.",
            "nullable":true,
            "x-queryable":true
        },
        "BaseUOMCode":{
            "title":"Item Primary UOM",
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the base unit of measure for the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item",
            "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":{
            "title":"UOM",
            "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":{
            "title":"Item Primary UOM Quantity",
            "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":{
            "title":"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":{
            "title":"Supplier",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the supplier that holds the on-hand inventory for the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcurementBUName":{
            "title":"Procurement BU",
            "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":{
            "title":"Published Date",
            "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 get one one quantity.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/collaborationSupplierOnHandQuantities/SupplierOnHandId"

For example, the following command gets one quantity:

curl -u username:password "https://servername/fscmRestApi/resources/version/collaborationSupplierOnHandQuantities/7127"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"SupplierOnHandId": 7127,
	"SupplierId": 100000012050091,
	"SupplierName": "CV_SuppD01",
	"SupplierSiteId": 100000012050114,
	"SupplierSiteName": "CV_SuppD01Site1",
	"InventoryItemId": 300100092864032,
	"PlanningItemId": 734219,
	"CollaborationItemId": 2039,
	"ItemNumber": "SCC-CNTRDL-01",
	"SupplierItemNumber": "SCC-Supplier-CNTRDL-1",
	"Quantity": 500,
	"UOMCode": "Ea",
	"UnitOfMeasure": "Each",
	"BaseQuantity": 500,
	"BaseUOMCode": "Ea",
	"BaseUnitOfMeasure": "Each",
	"ProcurementBUId": 204,
	"ProcurementBUName": "Vision Operations",
	"PublishedDate": "2019-11-06T16:15:45.274+00:00",
	"PublishedBy": null,
	"PublishSourceCode": "_ENTERPRISE_VAL",
	"PublishSource": "Enterprise",
	"CreatedBy": "COLLABPLANNER",
	"CreationDate": "2019-11-04T17:23:33+00:00",
	"LastUpdatedBy": "951C72132DC84471E053D48DF50A43FD",
	"LastUpdateDate": "2019-11-06T16:14:56+00:00",
	"links": [
	{
		...
	},
	{
		...
	}
	]
}

Back to Top