Jump to

• Request
• Response

GET action not supported

get

/fscmRestApi/resources/11.13.18.05/validateReceiveQuantities

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey
    Finder Variables:
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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(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 : validateReceiveQuantities

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/validateReceiveQuantities-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"InventoryManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object validateReceiveQuantities-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/validateReceiveQuantities-item-response"
    }
}

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

Type: object

Show Source

• ASNLineNumber: string
  Line number of the advance shipment notice.
• AvailableQuantity: number
  Read Only: true

  Quantity available to receive.
• DocumentLineNumber: string
  Line number for the document.
• DocumentNumber: string
  Document number that identifies one of the following: the purchase order number for a purchase order, advance shipment notice, or advance shipment billing notice; the number for the return material authorization for the source document code of type RMA; the in-transit shipment number for the source document code of type INVENTORY; or the transfer order number for the source document code of type TRANSFER ORDER.
• DocumentScheduleNumber: string
  Schedule number for the document.
• 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.
• FromOrganizationCode: string
  Abbreviation that identifies the name of the organization that is the point of origin of the shipment. This value is empty for purchase orders and advanced shipment notices.
• FromOrganizationId: string
  Value that uniquely identifies the organization that is the point of origin of the shipment. This value is empty for purchase orders and advance shipment notices.
• ItemId: integer
  Value that uniquely identifies the item.
• ItemNumber: string
  Number that identifies the item to receive. This item is any part, material, product, or service that contains unique attributes when compared to other items.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• POHeaderId: integer
  Value that uniquely identifies the purchase order header.
• POLineId: integer
  Value that uniquely identifies the purchase order line.
• POLineLocationId: integer
  Value that uniquely identifies the purchase order schedule.
• Quantity: string
  Quantity recommended to receive.
• ReceiptAdviceHeaderId: integer
  Value that uniquely identifies the receipt advice header.
• ReceiptAdviceLineId: integer
  Value that uniquely identifies receipt advice line.
• RedwoodFlag: boolean
  Default Value: false

  Contains one of the following values: true or false. If true, then navigation to the Validate Receive Quantities REST API is from the Responsive Redwood Self-Service Receiving Application. If false, then navigation to the Validate Receive Quantities REST API isn't from the Responsive Redwood Self-Service Receiving Application. The default value is false.
• 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 receive.
• SecondaryUnitOfMeasure: string
  Unit of measure for the secondary quantity recommended to receive.
• SecondaryUOMCode: string
  Abbreviation that identifies the secondary unit of measure.
• ShipmentHeaderId: integer
  Value that uniquely identifies the shipment header.
• ShipmentLineId: integer
  Value that uniquely identifies the shipment line.
• ShipmentNumber: string
  Number that identifies the shipment for an advance shipment notice or transfer order depending on the document type.
• SoldToLegalEntity: string
  Legal entity that is liable for the purchase order amount.
• SourceDocumentCode: string
  Document type of the shipment. Valid values include PO, RMA, TRANSFER ORDER, or INVENTORY.
• SourceSystem: string
  Application that captures the source document for the order line. The source system identifies the trading partner systems that receiving uses, such as Oracle Order Management Cloud, the customer of a logistics service, or an order management application that resides outside of Oracle.
• ToOrganizationCode: string
  Abbreviation that identifies the ship-to organization.
• ToOrganizationId: integer
  Value that uniquely identifies the ship-to organization.
• UnitOfMeasure: string
  Unit of measure for the quantity recommended to receive.
• UOMCode: string
  Abbreviation that identifies the unit of measure.

{
    "type":"object",
    "properties":{
        "FromOrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the name of the organization that is the point of origin of the shipment. This value is empty for purchase orders and advanced shipment notices.",
            "nullable":true,
            "x-queryable":false
        },
        "ToOrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the ship-to organization.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryUnitOfMeasure":{
            "type":"string",
            "description":"Unit of measure for the secondary quantity recommended to receive.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipmentNumber":{
            "type":"string",
            "description":"Number that identifies the shipment for an advance shipment notice or transfer order depending on the document type.",
            "nullable":true,
            "x-queryable":false
        },
        "ReceiptAdviceLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies receipt advice line.",
            "nullable":true,
            "x-queryable":false
        },
        "SoldToLegalEntity":{
            "type":"string",
            "description":"Legal entity that is liable for the purchase order amount.",
            "nullable":true,
            "x-queryable":false
        },
        "POLineLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order schedule.",
            "nullable":true,
            "x-queryable":false
        },
        "AvailableQuantity":{
            "type":"number",
            "description":"Quantity available to receive.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "nullable":true,
            "x-queryable":false
        },
        "DocumentScheduleNumber":{
            "type":"string",
            "description":"Schedule number for the document.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemNumber":{
            "type":"string",
            "description":"Number that identifies the item to receive. This item is any part, material, product, or service that contains unique attributes when compared to other items.",
            "nullable":true,
            "x-queryable":false
        },
        "POHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order header.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryUOMCode":{
            "type":"string",
            "description":"Abbreviation that identifies the secondary unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "DocumentLineNumber":{
            "type":"string",
            "description":"Line number for the document.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "POLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order line.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipmentLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shipment line.",
            "nullable":true,
            "x-queryable":false
        },
        "UOMCode":{
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "FromOrganizationId":{
            "type":"string",
            "description":"Value that uniquely identifies the organization that is the point of origin of the shipment. This value is empty for purchase orders and advance shipment notices.",
            "nullable":true,
            "x-queryable":false
        },
        "UnitOfMeasure":{
            "type":"string",
            "description":"Unit of measure for the quantity recommended to receive.",
            "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
        },
        "ASNLineNumber":{
            "type":"string",
            "description":"Line number of the advance shipment notice.",
            "nullable":true,
            "x-queryable":false
        },
        "RedwoodFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then navigation to the Validate Receive Quantities REST API is from the Responsive Redwood Self-Service Receiving Application. If false, then navigation to the Validate Receive Quantities REST API isn't from the Responsive Redwood Self-Service Receiving Application. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "Quantity":{
            "type":"string",
            "description":"Quantity recommended to receive.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipmentHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shipment header.",
            "nullable":true,
            "x-queryable":false
        },
        "ToOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to organization.",
            "nullable":true,
            "x-queryable":false
        },
        "DocumentNumber":{
            "type":"string",
            "description":"Document number that identifies one of the following: the purchase order number for a purchase order, advance shipment notice, or advance shipment billing notice; the number for the return material authorization for the source document code of type RMA; the in-transit shipment number for the source document code of type INVENTORY; or the transfer order number for the source document code of type TRANSFER ORDER.",
            "nullable":true,
            "x-queryable":false
        },
        "ReceiptAdviceHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receipt advice header.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryQuantity":{
            "type":"number",
            "description":"Secondary quantity recommended to receive.",
            "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
        },
        "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":"Document type of the shipment. Valid values include PO, RMA, TRANSFER ORDER, or INVENTORY.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystem":{
            "type":"string",
            "description":"Application that captures the source document for the order line. The source system identifies the trading partner systems that receiving uses, such as Oracle Order Management Cloud, the customer of a logistics service, or an order management application that resides outside of Oracle.",
            "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