Jump to

• Request
• Response
• Examples

Create validation

post

/fscmRestApi/resources/11.13.18.05/validateInventoryTransactionQuantities

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• InventoryItemId: integer
  Value that uniquely identifies the item.
• ItemNumber: string
  Number that identifies the inventory item.
• LocatorId: string
  Value that uniquely identifies the locator.
• LotNumber: string
  Lot number of the item.
• OrganizationCode: string
  Abbreviation that identifies the inventory organization.
• OrganizationId: integer
  Value that uniquely identifies the inventory organization.
• OwningEntityId: integer
  Value that uniquely identifies the owning entity.
• ReturnMessageName: string
  Name of the error message when the request fails. If the request is successful, then this attribute value is empty.
• ReturnMessageText: string
  Text of the error message when the request fails. If the request is successful, then this attribute value is empty.
• ReturnStatus: string
  Return status from the call to the validate service.
• Revision: string
  Revision of the item.
• SecondaryQuantity: number
  Transaction quantity in the secondary unit of measure.
• SecondaryUnitOfMeasure: string
  Secondary unit of measure.
• SecondaryUOMCode: string
  Abbreviation that identifies the secondary unit of measure.
• Subinventory: string
  Name of the subinventory.
• TransactionQuantity: number
  Quantity to validate in the unit of measure that the transaction uses.
• TransactionTypeId: integer
  Value that uniquely identifies the transaction type.
• TransactionTypeName: string
  Name of the transaction type.
• TransactionUnitOfMeasure: string
  Unit of measure that the transaction uses.
• TransactionUOMCode: string
  Abbreviation that identifies the unit of measure that the transaction uses.

{
    "type":"object",
    "properties":{
        "TransactionTypeName":{
            "type":"string",
            "description":"Name of the transaction type.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryUnitOfMeasure":{
            "type":"string",
            "description":"Secondary unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transaction type.",
            "nullable":true,
            "x-queryable":false
        },
        "LocatorId":{
            "type":"string",
            "description":"Value that uniquely identifies the locator.",
            "nullable":true,
            "x-queryable":false
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionUnitOfMeasure":{
            "type":"string",
            "description":"Unit of measure that the transaction uses.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnMessageName":{
            "type":"string",
            "description":"Name of the error message when the request fails. If the request is successful, then this attribute value is empty.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnMessageText":{
            "type":"string",
            "description":"Text of the error message when the request fails. If the request is successful, then this attribute value is empty.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemNumber":{
            "type":"string",
            "description":"Number that identifies the inventory item.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryQuantity":{
            "type":"number",
            "description":"Transaction quantity in the secondary unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "Revision":{
            "type":"string",
            "description":"Revision of the item.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionQuantity":{
            "type":"number",
            "description":"Quantity to validate in the unit of measure that the transaction uses.",
            "nullable":true,
            "x-queryable":false
        },
        "Subinventory":{
            "type":"string",
            "description":"Name of the subinventory.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionUOMCode":{
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure that the transaction uses.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnStatus":{
            "type":"string",
            "description":"Return status from the call to the validate service.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryUOMCode":{
            "type":"string",
            "description":"Abbreviation that identifies the secondary unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "OrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization.",
            "nullable":true,
            "x-queryable":false
        },
        "OwningEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the owning entity.",
            "nullable":true,
            "x-queryable":false
        },
        "LotNumber":{
            "type":"string",
            "description":"Lot number of the item.",
            "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 : validateInventoryTransactionQuantities-item-response

Type: object

Show Source

• InventoryItemId: integer
  Value that uniquely identifies the item.
• ItemNumber: string
  Number that identifies the inventory item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocatorId: string
  Value that uniquely identifies the locator.
• LotNumber: string
  Lot number of the item.
• OrganizationCode: string
  Abbreviation that identifies the inventory organization.
• OrganizationId: integer
  Value that uniquely identifies the inventory organization.
• OwningEntityId: integer
  Value that uniquely identifies the owning entity.
• ReturnMessageName: string
  Name of the error message when the request fails. If the request is successful, then this attribute value is empty.
• ReturnMessageText: string
  Text of the error message when the request fails. If the request is successful, then this attribute value is empty.
• ReturnStatus: string
  Return status from the call to the validate service.
• Revision: string
  Revision of the item.
• SecondaryQuantity: number
  Transaction quantity in the secondary unit of measure.
• SecondaryUnitOfMeasure: string
  Secondary unit of measure.
• SecondaryUOMCode: string
  Abbreviation that identifies the secondary unit of measure.
• Subinventory: string
  Name of the subinventory.
• TransactionQuantity: number
  Quantity to validate in the unit of measure that the transaction uses.
• TransactionTypeId: integer
  Value that uniquely identifies the transaction type.
• TransactionTypeName: string
  Name of the transaction type.
• TransactionUnitOfMeasure: string
  Unit of measure that the transaction uses.
• TransactionUOMCode: string
  Abbreviation that identifies the unit of measure that the transaction uses.

{
    "type":"object",
    "properties":{
        "TransactionTypeName":{
            "type":"string",
            "description":"Name of the transaction type.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryUnitOfMeasure":{
            "type":"string",
            "description":"Secondary unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transaction type.",
            "nullable":true,
            "x-queryable":false
        },
        "LocatorId":{
            "type":"string",
            "description":"Value that uniquely identifies the locator.",
            "nullable":true,
            "x-queryable":false
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionUnitOfMeasure":{
            "type":"string",
            "description":"Unit of measure that the transaction uses.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnMessageName":{
            "type":"string",
            "description":"Name of the error message when the request fails. If the request is successful, then this attribute value is empty.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnMessageText":{
            "type":"string",
            "description":"Text of the error message when the request fails. If the request is successful, then this attribute value is empty.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemNumber":{
            "type":"string",
            "description":"Number that identifies the inventory item.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryQuantity":{
            "type":"number",
            "description":"Transaction quantity in the secondary unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "Revision":{
            "type":"string",
            "description":"Revision of the item.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionQuantity":{
            "type":"number",
            "description":"Quantity to validate in the unit of measure that the transaction uses.",
            "nullable":true,
            "x-queryable":false
        },
        "Subinventory":{
            "type":"string",
            "description":"Name of the subinventory.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionUOMCode":{
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure that the transaction uses.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnStatus":{
            "type":"string",
            "description":"Return status from the call to the validate service.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryUOMCode":{
            "type":"string",
            "description":"Abbreviation that identifies the secondary unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "OrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OwningEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the owning entity.",
            "nullable":true,
            "x-queryable":false
        },
        "LotNumber":{
            "type":"string",
            "description":"Lot number of the item.",
            "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 validate the quantity for an inventory transaction.

Example cURL Command

Use the following cURL command to submit a request on the REST resource. This example validates the quantity for inventory item INV-100, in subinventory ABCSUB01, in organization 207, for the miscellaneous issue transaction:

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

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.

{
  "OrganizationId" : 207,
  "ItemNumber" : "INV-100",
  "Subinventory" : "ABCSUB01",
  "TransactionTypeName" : "Miscellaneous issue",
  "TransactionUnitOfMeasure" : "Each",
  "TransactionQuantity" : 99
}

Example Response Body

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

{
  "OrganizationCode" : null,
  "OrganizationId" : 207,
  "ItemNumber" : "INV-100",
  "InventoryItemId" : 663913,
  "TransactionTypeName" : "Miscellaneous issue",
  "TransactionTypeId" : 32,
  "Revision" : null,
  "Subinventory" : "ABCSUB01",
  "LocatorId" : null,
  "LotNumber" : null,
  "OwningEntityId" : null,
  "TransactionQuantity" : 10,
  "TransactionUnitOfMeasure" : "Each",
  "TransactionUOMCode" : "Ea",
  "SecondaryQuantity" : null,
  "SecondaryUnitOfMeasure" : null,
  "SecondaryUOMCode" : null,
  "ReturnStatus" : "SUCCESS",
  "ReturnMessageName" : null,
  "ReturnMessageText" : null
}

Back to Top