Jump to

• Request
• Response
• Examples

Create a usage

post

/fscmRestApi/resources/11.13.18.05/unitOfMeasureUsages

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

• Item: string
  Maximum Length: 300

  Name of the inventory item.
• ItemId: integer (int64)
  Title: Item ID

  Value that uniquely identifies the inventory item.
• OrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the inventory organization.
• OrganizationId: integer (int64)
  Title: Organization ID

  Value that uniquely identifies the inventory organization.
• OrganizationName: string
  Maximum Length: 240

  Name of the inventory organization.
• Subinventory: string
  Maximum Length: 10

  Name of the subinventory.
• UnitOfMeasure: string
  Title: UOM Name

  Maximum Length: 25

  Name of the unit of measure associated with the combination of unit of measure usage type, organization, item, and optionally the subinventory.
• UOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure associated with the combination of unit of measure usage type, organization, item, and optionally the subinventory.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the inventory organization.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "Item":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the inventory item.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Name of the unit of measure associated with the combination of unit of measure usage type, organization, item, and optionally the subinventory.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "Subinventory":{
            "maxLength":10,
            "type":"string",
            "description":"Name of the subinventory.",
            "nullable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "OrganizationId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ItemId":{
            "title":"Item ID",
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure associated with the combination of unit of measure usage type, organization, item, and optionally the subinventory.",
            "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 : unitOfMeasureUsages-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the unit of measure usage.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the unit of measure usage.
• Item: string
  Maximum Length: 300

  Name of the inventory item.
• ItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  Description of the inventory item.
• ItemId: integer (int64)
  Title: Item ID

  Value that uniquely identifies the inventory item.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the unit of measure usage.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the unit of measure usage.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the inventory organization.
• OrganizationId: integer (int64)
  Title: Organization ID

  Value that uniquely identifies the inventory organization.
• OrganizationName: string
  Maximum Length: 240

  Name of the inventory organization.
• Subinventory: string
  Maximum Length: 10

  Name of the subinventory.
• UnitOfMeasure: string
  Title: UOM Name

  Maximum Length: 25

  Name of the unit of measure associated with the combination of unit of measure usage type, organization, item, and optionally the subinventory.
• UOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure associated with the combination of unit of measure usage type, organization, item, and optionally the subinventory.
• UOMUsageId: integer (int64)
  Read Only: true

  Value that uniquely identifies the unit of measure usage.
• UOMUsageType: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Name that identifies the unit of measure usage type. A list of accepted values is defined in the lookup type ORA_INV_UOM_USAGE.
• UOMUsageTypeCode: string
  Read Only: true

  Maximum Length: 30

  Default Value: STOCKING

  Abbreviation that identifies the unit of measure usage type. A list of accepted values is defined in the lookup type ORA_INV_UOM_USAGE.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the unit of measure usage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the inventory organization.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the unit of measure usage.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the unit of measure usage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Name of the unit of measure associated with the combination of unit of measure usage type, organization, item, and optionally the subinventory.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "UOMUsageTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure usage type. A list of accepted values is defined in the lookup type ORA_INV_UOM_USAGE.",
            "nullable":false,
            "readOnly":true,
            "default":"STOCKING",
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the inventory item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "title":"Item ID",
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Item":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the inventory item.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "UOMUsageType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Name that identifies the unit of measure usage type. A list of accepted values is defined in the lookup type ORA_INV_UOM_USAGE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Subinventory":{
            "maxLength":10,
            "type":"string",
            "description":"Name of the subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMUsageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the unit of measure usage.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure associated with the combination of unit of measure usage type, organization, item, and optionally the subinventory.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the unit of measure usage.",
            "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 a usage.

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

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.

{
	"OrganizationCode": "V1",
	"Item": "INV-101",
	"Subinventory": "ABCSUB01",
	"UnitOfMeasure": "Box of 5"
}

Example Response Body

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

{
	"UOMUsageId": 300100182825083,
	"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
	"CreationDate": "2019-06-07T23:25:36+00:00",
	"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
	"LastUpdateDate": "2019-06-07T23:25:36.093+00:00",
	"OrganizationId": 204,
	"OrganizationCode": "V1",
	"OrganizationName": "Vision Operations",
	"ItemId": 663914,
	"Item": "INV-101",
	"ItemDescription": "Lot Item",
	"Subinventory": "ABCSUB01",
	"UOMUsageTypeCode": "STOCKING",
	"UOMUsageType": "Stocking",
	"UOMCode": "BX5",
	"UnitOfMeasure": "Box of 5",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/unitOfMeasureUsages/300100182825083",
		"name": "unitOfMeasureUsages",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/unitOfMeasureUsages/300100182825083",
		"name": "unitOfMeasureUsages",
		"kind": "item"
	}
	]
}

Back to Top