Jump to

• Request
• Response
• Examples

Update one line

patch

/fscmRestApi/resources/11.13.18.05/inventoryReplenishRequests/{GroupId}/child/replenishRequestLines/{ReplenishmentIntId}

Request

Path Parameters

• GroupId(required): integer(int64)
  Value that uniquely identifies the replenish request group.
• ReplenishmentIntId(required): integer(int64)
  Value that uniquely identifies replenishment record.

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 (int64)
  Value that uniquely identifies the item.
• ItemNumber: string
  Title: Item

  Maximum Length: 300

  Number that uniquely identifies the item.
• LocatorId: integer (int64)
  Value that uniquely identifies the locator.
• LocatorName: string
  Title: Locator

  Maximum Length: 255

  Name of the locator.
• OrganizationCode: string
  Title: Organization Code

  Maximum Length: 18

  Abbreviation that identifies the organization.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization.
• OverrideReplenishCountType: string
  Type of override replenish count for the request.
• OverrideReplenishCountTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of override replenish count for the request.
• Quantity: number
  Title: Quantity

  Quantity of the replenishment in the request.
• replenishRequestLineDFFs: array Flexfields
  Title: Flexfields

  The Flexfields resource manages the descriptive flexfields for the replenish request.
• Subinventory: string
  Title: Subinventory

  Maximum Length: 10

  Subinventory to use when sourcing the request.
• SubinventoryGroup: string
  Title: Subinventory Group

  Maximum Length: 100

  Name of the subinventory group.
• UnitOfMeasure: string
  Maximum Length: 25

  Unit of measure for this item and request.
• UOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure for this item and request.

{
    "type":"object",
    "properties":{
        "UnitOfMeasure":{
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure for this item and request.",
            "nullable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "LocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the locator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity of the replenishment in the request.",
            "nullable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "OverrideReplenishCountType":{
            "type":"string",
            "description":"Type of override replenish count for the request.",
            "nullable":true
        },
        "SubinventoryGroup":{
            "title":"Subinventory Group",
            "maxLength":"100",
            "type":"string",
            "description":"Name of the subinventory group.",
            "nullable":true
        },
        "LocatorName":{
            "title":"Locator",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the locator.",
            "nullable":true
        },
        "ItemNumber":{
            "title":"Item",
            "maxLength":"300",
            "type":"string",
            "description":"Number that uniquely identifies the item.",
            "nullable":true
        },
        "replenishRequestLineDFFs":{
            "title":"Flexfields",
            "type":"array",
            "description":"The Flexfields resource manages the descriptive flexfields for the replenish request.",
            "items":{
                "$ref":"#/components/schemas/inventoryReplenishRequests-replenishRequestLines-replenishRequestLineDFFs-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "Subinventory":{
            "title":"Subinventory",
            "maxLength":"10",
            "type":"string",
            "description":"Subinventory to use when sourcing the request.",
            "nullable":true
        },
        "OverrideReplenishCountTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of override replenish count for the request.",
            "nullable":true
        },
        "OrganizationCode":{
            "title":"Organization Code",
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the organization.",
            "nullable":true
        },
        "UOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for this item and request.",
            "nullable":true
        }
    }
}

Nested Schema : Flexfields

Type: array

Title: Flexfields

The Flexfields resource manages the descriptive flexfields for the replenish request.

Show Source

• Array of: object schema

{
    "title":"Flexfields",
    "type":"array",
    "description":"The Flexfields resource manages the descriptive flexfields for the replenish request.",
    "items":{
        "$ref":"#/components/schemas/inventoryReplenishRequests-replenishRequestLines-replenishRequestLineDFFs-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context name of the descriptive flexfield that the application uses to replenish request lines.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Display value of the descriptive flexfield that the application uses to replenish request lines.
• ReplenishmentIntId: integer (int64)
  Value that uniquely identifies the replenishment.

{
    "type":"object",
    "properties":{
        "ReplenishmentIntId":{
            "type":"integer",
            "description":"Value that uniquely identifies the replenishment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Display value of the descriptive flexfield that the application uses to replenish request lines.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "description":"Context name of the descriptive flexfield that the application uses to replenish request lines.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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 : inventoryReplenishRequests-replenishRequestLines-item-response

Type: object

Show Source

• ErrorMessageCode: string
  Title: Error

  Read Only: true

  Maximum Length: 50

  Abbreviation that identifies the error that occurred when processing the request.
• ErrorMessageText: string
  Title: Error

  Read Only: true

  Maximum Length: 240

  Text of the error message that occurred when processing the request.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the item.
• ItemNumber: string
  Title: Item

  Maximum Length: 300

  Number that uniquely identifies the item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocatorId: integer (int64)
  Value that uniquely identifies the locator.
• LocatorName: string
  Title: Locator

  Maximum Length: 255

  Name of the locator.
• NotPlannedRecords: number
  Read Only: true

  Value that specifies the number of records that are not planned in a replenishment request.
• OrganizationCode: string
  Title: Organization Code

  Maximum Length: 18

  Abbreviation that identifies the organization.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization.
• OverrideReplenishCountType: string
  Type of override replenish count for the request.
• OverrideReplenishCountTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of override replenish count for the request.
• ProcessingStatus: string
  Title: Processing Status

  Read Only: true

  Maximum Length: 18

  Default Value: PENDING

  Processing status of this request.
• Quantity: number
  Title: Quantity

  Quantity of the replenishment in the request.
• ReplenishmentIntId: integer (int64)
  Read Only: true

  Value that uniquely identifies replenishment record.
• replenishRequestLineDFFs: array Flexfields
  Title: Flexfields

  The Flexfields resource manages the descriptive flexfields for the replenish request.
• Subinventory: string
  Title: Subinventory

  Maximum Length: 10

  Subinventory to use when sourcing the request.
• SubinventoryGroup: string
  Title: Subinventory Group

  Maximum Length: 100

  Name of the subinventory group.
• UnitOfMeasure: string
  Maximum Length: 25

  Unit of measure for this item and request.
• UOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure for this item and request.

{
    "type":"object",
    "properties":{
        "ErrorMessageCode":{
            "title":"Error",
            "maxLength":"50",
            "type":"string",
            "description":"Abbreviation that identifies the error that occurred when processing the request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure for this item and request.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the locator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReplenishmentIntId":{
            "type":"integer",
            "description":"Value that uniquely identifies replenishment record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity of the replenishment in the request.",
            "nullable":true,
            "x-queryable":true
        },
        "NotPlannedRecords":{
            "type":"number",
            "description":"Value that specifies the number of records that are not planned in a replenishment request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OverrideReplenishCountType":{
            "type":"string",
            "description":"Type of override replenish count for the request.",
            "nullable":true,
            "x-queryable":true
        },
        "SubinventoryGroup":{
            "title":"Subinventory Group",
            "maxLength":"100",
            "type":"string",
            "description":"Name of the subinventory group.",
            "nullable":true,
            "x-queryable":true
        },
        "LocatorName":{
            "title":"Locator",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the locator.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item",
            "maxLength":"300",
            "type":"string",
            "description":"Number that uniquely identifies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "replenishRequestLineDFFs":{
            "title":"Flexfields",
            "type":"array",
            "description":"The Flexfields resource manages the descriptive flexfields for the replenish request.",
            "items":{
                "$ref":"#/components/schemas/inventoryReplenishRequests-replenishRequestLines-replenishRequestLineDFFs-item-response"
            },
            "x-cardinality":"1"
        },
        "Subinventory":{
            "title":"Subinventory",
            "maxLength":"10",
            "type":"string",
            "description":"Subinventory to use when sourcing the request.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessageText":{
            "title":"Error",
            "maxLength":"240",
            "type":"string",
            "description":"Text of the error message that occurred when processing the request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OverrideReplenishCountTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of override replenish count for the request.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Organization Code",
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProcessingStatus":{
            "title":"Processing Status",
            "maxLength":"18",
            "type":"string",
            "description":"Processing status of this request.",
            "nullable":true,
            "readOnly":true,
            "default":"PENDING",
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for this item and request.",
            "nullable":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 : Flexfields

Type: array

Title: Flexfields

The Flexfields resource manages the descriptive flexfields for the replenish request.

Show Source

• Array of: object inventoryReplenishRequests-replenishRequestLines-replenishRequestLineDFFs-item-response

{
    "title":"Flexfields",
    "type":"array",
    "description":"The Flexfields resource manages the descriptive flexfields for the replenish request.",
    "items":{
        "$ref":"#/components/schemas/inventoryReplenishRequests-replenishRequestLines-replenishRequestLineDFFs-item-response"
    },
    "x-cardinality":"1"
}

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."
        }
    }
}

Nested Schema : inventoryReplenishRequests-replenishRequestLines-replenishRequestLineDFFs-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context name of the descriptive flexfield that the application uses to replenish request lines.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Display value of the descriptive flexfield that the application uses to replenish request lines.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReplenishmentIntId: integer (int64)
  Value that uniquely identifies the replenishment.

{
    "type":"object",
    "properties":{
        "ReplenishmentIntId":{
            "type":"integer",
            "description":"Value that uniquely identifies the replenishment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Display value of the descriptive flexfield that the application uses to replenish request lines.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "description":"Context name of the descriptive flexfield that the application uses to replenish request lines.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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"
    }
}

Links

replenishRequestLineDFFs

Operation: /fscmRestApi/resources/11.13.18.05/inventoryReplenishRequests/{GroupId}/child/replenishRequestLines/{ReplenishmentIntId}/child/replenishRequestLineDFFs

Parameters:

• GroupId: $request.path.GroupId
• ReplenishmentIntId: $request.path.ReplenishmentIntId

The Flexfields resource manages the descriptive flexfields for the replenish request.

Back to Top

Examples

This example describes how to update one line.

Example cURL Command

Use the following cURL command to submit a request on the REST resource to update a specific attribute in a replenish request line.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/GroupId/child/replenishRequestLines/ReplenishmentIntId"

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.

{
  "Subinventory": "P123" 
}

Example Response Body

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

{
  "ErrorMessageCode" : null,
  "ErrorMessageText" : null,
  "InventoryItemId" : null,
  "ItemNumber" : "INV-100",
  "LocatorId" : null,
  "LocatorName" : null,
  "OrganizationCode" : "M1",
  "OrganizationId" : 207,
  "UnitOfMeasure" : null,
  "UOMCode" : null,
  "Quantity" : 100,
  "ReplenishmentIntId" : 1005,
  "Subinventory" : "P123",
  "ProcessingStatus" : "PENDING",
  "SubinventoryGroup" : null,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/1005/child/replenishRequestLines/1005",
    "name" : "replenishRequestLines",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/1005/child/replenishRequestLines/1005",
    "name" : "replenishRequestLines",
    "kind" : "item"
  }, {
    "rel" : "parent",
    "href" : "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/1005",
    "name" : "inventoryReplenishRequests",
    "kind" : "item"
  }, {
    "rel" : "child",
    "href" : "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/1005/child/replenishRequestLines/1005/child/replenishRequestLineDFFs",
    "name" : "replenishRequestLineDFFs",
    "kind" : "collection"
  } ]

Back to Top