Jump to

• Request
• Response
• Examples

Create validation

post

/fscmRestApi/resources/11.13.18.05/validateReturnQuantities

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

• ConsignedItems: string
  Default Value: N

  Contains one of the following values: Y or N. If Y, then the item is consigned. If N, then the item is not consigned. The default value is N.
• ErrorCode: string
  Abbreviation that identifies the message that describes the error that occurred when validating the quantity. If the Return Status attribute contains a value of SUCCESS, then the Error Code attribute is empty.
• ErrorExplanation: string
  Message that describes the error that occurred when validating the quantity. If the Return Status attribute contains a value of SUCCESS, then the Error Explanation attribute is empty.
• ParentTransactionId: integer
  Value that uniquely identifies the parent of the transaction to return.
• Quantity: number
  Quantity recommended to return.
• ReturnStatus: string
  Status returned by the application when validating the quantity. Valid values are SUCCESS, ERROR, and WARNING. SUCCESS: the application successfully validated the quantity for the transaction. ERROR: this validation failed. WARNING: the validation found a potential problem, but allows the transaction to continue.
• SecondaryQuantity: number
  Secondary quantity recommended to return.
• SecondaryUnitOfMeasure: string
  Unit of measure for the secondary quantity recommended to return.
• SecondaryUOMCode: string
  Abbreviation that identifies the secondary unit of measure.
• SourceDocumentCode: string
  Abbreviation that identifies the document type of the shipment. Valid values include PO, RMA, TRANSFER ORDER, or INVENTORY.
• UnitOfMeasure: string
  Unit of measure for the quantity recommended to return.
• UOMCode: string
  Abbreviation that identifies the unit of measure.

{
    "type":"object",
    "properties":{
        "UnitOfMeasure":{
            "type":"string",
            "description":"Unit of measure for the quantity recommended to return.",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorExplanation":{
            "type":"string",
            "description":"Message that describes the error that occurred when validating the quantity. If the Return Status attribute contains a value of SUCCESS, then the Error Explanation attribute is empty.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryUnitOfMeasure":{
            "type":"string",
            "description":"Unit of measure for the secondary quantity recommended to return.",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity recommended to return.",
            "nullable":true,
            "x-queryable":false
        },
        "ConsignedItems":{
            "type":"string",
            "description":"Contains one of the following values: Y or N. If Y, then the item is consigned. If N, then the item is not consigned. The default value is N.",
            "nullable":true,
            "default":"N",
            "x-queryable":false
        },
        "SecondaryQuantity":{
            "type":"number",
            "description":"Secondary quantity recommended to return.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnStatus":{
            "type":"string",
            "description":"Status returned by the application when validating the quantity. Valid values are SUCCESS, ERROR, and WARNING. SUCCESS: the application successfully validated the quantity for the transaction. ERROR: this validation failed. WARNING: the validation found a potential problem, but allows the transaction to continue.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryUOMCode":{
            "type":"string",
            "description":"Abbreviation that identifies the secondary unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentTransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent of the transaction to return.",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorCode":{
            "type":"string",
            "description":"Abbreviation that identifies the message that describes the error that occurred when validating the quantity. If the Return Status attribute contains a value of SUCCESS, then the Error Code attribute is empty.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentCode":{
            "type":"string",
            "description":"Abbreviation that identifies the \ndocument type of the shipment. Valid values include PO, RMA, TRANSFER ORDER, or INVENTORY.",
            "nullable":true,
            "x-queryable":false
        },
        "UOMCode":{
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "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(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 : validateReturnQuantities-item-response

Type: object

Show Source

• AvailableQuantity: number
  Read Only: true

  Quantity available to return.
• ConsignedItems: string
  Default Value: N

  Contains one of the following values: Y or N. If Y, then the item is consigned. If N, then the item is not consigned. The default value is N.
• ErrorCode: string
  Abbreviation that identifies the message that describes the error that occurred when validating the quantity. If the Return Status attribute contains a value of SUCCESS, then the Error Code attribute is empty.
• ErrorExplanation: string
  Message that describes the error that occurred when validating the quantity. If the Return Status attribute contains a value of SUCCESS, then the Error Explanation attribute is empty.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParentTransactionId: integer
  Value that uniquely identifies the parent of the transaction to return.
• Quantity: number
  Quantity recommended to return.
• ReturnStatus: string
  Status returned by the application when validating the quantity. Valid values are SUCCESS, ERROR, and WARNING. SUCCESS: the application successfully validated the quantity for the transaction. ERROR: this validation failed. WARNING: the validation found a potential problem, but allows the transaction to continue.
• SecondaryQuantity: number
  Secondary quantity recommended to return.
• SecondaryUnitOfMeasure: string
  Unit of measure for the secondary quantity recommended to return.
• SecondaryUOMCode: string
  Abbreviation that identifies the secondary unit of measure.
• SourceDocumentCode: string
  Abbreviation that identifies the document type of the shipment. Valid values include PO, RMA, TRANSFER ORDER, or INVENTORY.
• UnitOfMeasure: string
  Unit of measure for the quantity recommended to return.
• UOMCode: string
  Abbreviation that identifies the unit of measure.

{
    "type":"object",
    "properties":{
        "UnitOfMeasure":{
            "type":"string",
            "description":"Unit of measure for the quantity recommended to return.",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorExplanation":{
            "type":"string",
            "description":"Message that describes the error that occurred when validating the quantity. If the Return Status attribute contains a value of SUCCESS, then the Error Explanation attribute is empty.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryUnitOfMeasure":{
            "type":"string",
            "description":"Unit of measure for the secondary quantity recommended to return.",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity recommended to return.",
            "nullable":true,
            "x-queryable":false
        },
        "ConsignedItems":{
            "type":"string",
            "description":"Contains one of the following values: Y or N. If Y, then the item is consigned. If N, then the item is not consigned. The default value is N.",
            "nullable":true,
            "default":"N",
            "x-queryable":false
        },
        "AvailableQuantity":{
            "type":"number",
            "description":"Quantity available to return.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "SecondaryQuantity":{
            "type":"number",
            "description":"Secondary quantity recommended to return.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnStatus":{
            "type":"string",
            "description":"Status returned by the application when validating the quantity. Valid values are SUCCESS, ERROR, and WARNING. SUCCESS: the application successfully validated the quantity for the transaction. ERROR: this validation failed. WARNING: the validation found a potential problem, but allows the transaction to continue.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryUOMCode":{
            "type":"string",
            "description":"Abbreviation that identifies the secondary unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParentTransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent of the transaction to return.",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorCode":{
            "type":"string",
            "description":"Abbreviation that identifies the message that describes the error that occurred when validating the quantity. If the Return Status attribute contains a value of SUCCESS, then the Error Code attribute is empty.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentCode":{
            "type":"string",
            "description":"Abbreviation that identifies the \ndocument type of the shipment. Valid values include PO, RMA, TRANSFER ORDER, or INVENTORY.",
            "nullable":true,
            "x-queryable":false
        },
        "UOMCode":{
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "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 returned quantities that a user enters against the quantities that are available to return.

Example cURL Command

Use the following cURL command to submit a request on the REST resource. This example validates a quantity of 1, on source document PO, for transaction 3041458:

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

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.

{
"Quantity" : "1",
"UOMCode" : "Ea",
"SourceDocumentCode" : "PO",
"ParentTransactionId" : "3041458"
}

Example Response Body

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

{
  "ParentTransactionId" : 3041458,
  "Quantity" : 1,
  "ErrorCode" : null,
  "ErrorExplanation" : null,
  "ReturnStatus" : "SUCCESS",
  "SecondaryQuantity" : 0.08333,
  "SecondaryUOMCode" : "DZ",
  "SecondaryUnitOfMeasure" : null,
  "SourceDocumentCode" : "PO",
  "UOMCode" : "Ea",
  "UnitOfMeasure" : null,
  "ConsignedItems" : "N"
}

Back to Top