Jump to

• Request
• Response
• Examples

Update one subinventory relationship

patch

/fscmRestApi/resources/11.13.18.05/vmiRelationships/{vmiRelationshipsUniqID}/child/vmiSubinventories/{vmiSubinventoriesUniqID}

Request

Path Parameters

• vmiRelationshipsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Vendor-Managed Inventory Relationships resource and used to uniquely identify an instance of Vendor-Managed Inventory Relationships. The client should not generate the hash key value. Instead, the client should query on the Vendor-Managed Inventory Relationships collection resource in order to navigate to a specific instance of Vendor-Managed Inventory Relationships to get the hash key.
• vmiSubinventoriesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Subinventory Relationships resource and used to uniquely identify an instance of Subinventory Relationships. The client should not generate the hash key value. Instead, the client should query on the Subinventory Relationships collection resource in order to navigate to a specific instance of Subinventory Relationships to get the hash key.

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

• MinMaxQuantitySource: string
  Title: Min-Max Quantity Source

  Maximum Length: 255

  Value that indicates the source of the minimum and maximum quantities used to manage vendor-managed inventory replenishments. Valid values include Enterprise and Supplier.
• MinMaxQuantitySourceCode: string
  Title: Min-Max Quantity Source

  Maximum Length: 255

  Value that uniquely identifies the source of the minimum and maximum quantities used to manage vendor-managed inventory replenishments. Valid values include ORA_VCS_MIN_MAX_ORIGIN_ENT and ORA_VCS_MIN_MAX_ORIGIN_SUP.
• RequisitionRequesterPersonId: integer (int64)
  Title: Requisition Requester

  Value that uniquely identifies the requisition requester for the relationship.
• RequisitionRequesterUserName: string
  Title: Requisition Requester

  Maximum Length: 255

  Login that the user used when requesting the requisition for the relationship.

{
    "type":"object",
    "properties":{
        "MinMaxQuantitySource":{
            "title":"Min-Max Quantity Source",
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the source of the minimum and maximum quantities used to manage vendor-managed inventory replenishments. Valid values include Enterprise and Supplier.",
            "nullable":true
        },
        "RequisitionRequesterPersonId":{
            "title":"Requisition Requester",
            "type":"integer",
            "description":"Value that uniquely identifies the requisition requester for the relationship.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "MinMaxQuantitySourceCode":{
            "title":"Min-Max Quantity Source",
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the source of the minimum and maximum quantities used to manage vendor-managed inventory replenishments. Valid values include ORA_VCS_MIN_MAX_ORIGIN_ENT and ORA_VCS_MIN_MAX_ORIGIN_SUP.",
            "nullable":true
        },
        "RequisitionRequesterUserName":{
            "title":"Requisition Requester",
            "maxLength":"255",
            "type":"string",
            "description":"Login that the user used when requesting the requisition for the relationship.",
            "nullable":true
        }
    }
}

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 : vmiRelationships-vmiSubinventories-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the vendor-managed inventory relationship.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the vendor-managed inventory relationship.
• InventoryPlanningOwner: string
  Title: Inventory Planning Owner

  Read Only: true

  Maximum Length: 255

  Value that identifies the inventory planning owner of the vendor-managed inventory replenishments for the relationship. Valid values include Supplier, Enterprise, or Unresolved planning owner.
• InventoryPlanningOwnerCode: string
  Title: Inventory Planning Owner

  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the inventory planning owner of the vendor-managed inventory replenishments for the relationship. Valid values include ORA_VCS_INV_OWNER_SUP, ORA_VCS_INV_OWNER_ENT, ORA_VCS_INV_OWNER_NOT_SUPPORT, or ORA_VCS_INV_OWNER_INVALID.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the vendor-managed inventory relationship.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Login of the user who most recently updated the vendor-managed inventory relationship.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MinMaxQuantitySource: string
  Title: Min-Max Quantity Source

  Maximum Length: 255

  Value that indicates the source of the minimum and maximum quantities used to manage vendor-managed inventory replenishments. Valid values include Enterprise and Supplier.
• MinMaxQuantitySourceCode: string
  Title: Min-Max Quantity Source

  Maximum Length: 255

  Value that uniquely identifies the source of the minimum and maximum quantities used to manage vendor-managed inventory replenishments. Valid values include ORA_VCS_MIN_MAX_ORIGIN_ENT and ORA_VCS_MIN_MAX_ORIGIN_SUP.
• RelationshipId: integer (int64)
  Value that uniquely identifies the relationship.
• RelationshipNumber: string
  Title: Relationship

  Read Only: true

  Maximum Length: 9

  Number that identifies the relationship.
• RequisitionRequesterPersonId: integer (int64)
  Title: Requisition Requester

  Value that uniquely identifies the requisition requester for the relationship.
• RequisitionRequesterUserName: string
  Title: Requisition Requester

  Maximum Length: 255

  Login that the user used when requesting the requisition for the relationship.
• Subinventory: string
  Title: Subinventory

  Maximum Length: 10

  Value that uniquely identifies the subinventory of an organization in the relationship. This subinventory is the final destination for the item in the replenishment request.
• SubinventoryDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 50

  Description of the subinventory.
• SubinventoryId: integer (int64)
  Title: Subinventory

  Read Only: true

  Value that uniquely identifies the subinventory.
• SubinventoryRelationshipId: integer (int64)
  Value that uniquely identifies the subinventory relationship.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Login of the user who most recently updated the vendor-managed inventory relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the vendor-managed inventory relationship.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the vendor-managed inventory relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryPlanningOwner":{
            "title":"Inventory Planning Owner",
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the inventory planning owner of the vendor-managed inventory replenishments for the relationship. Valid values include Supplier, Enterprise, or Unresolved planning owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionRequesterPersonId":{
            "title":"Requisition Requester",
            "type":"integer",
            "description":"Value that uniquely identifies the requisition requester for the relationship.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MinMaxQuantitySourceCode":{
            "title":"Min-Max Quantity Source",
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the source of the minimum and maximum quantities used to manage vendor-managed inventory replenishments. Valid values include ORA_VCS_MIN_MAX_ORIGIN_ENT and ORA_VCS_MIN_MAX_ORIGIN_SUP.",
            "nullable":true,
            "x-queryable":true
        },
        "SubinventoryId":{
            "title":"Subinventory",
            "type":"integer",
            "description":"Value that uniquely identifies the subinventory.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubinventoryDescription":{
            "title":"Description",
            "maxLength":"50",
            "type":"string",
            "description":"Description of the subinventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryPlanningOwnerCode":{
            "title":"Inventory Planning Owner",
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the inventory planning owner of the vendor-managed inventory replenishments for the relationship. Valid values include ORA_VCS_INV_OWNER_SUP, ORA_VCS_INV_OWNER_ENT, ORA_VCS_INV_OWNER_NOT_SUPPORT, or ORA_VCS_INV_OWNER_INVALID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipNumber":{
            "title":"Relationship",
            "maxLength":"9",
            "type":"string",
            "description":"Number that identifies the relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies the relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Subinventory":{
            "title":"Subinventory",
            "maxLength":"10",
            "type":"string",
            "description":"Value that uniquely identifies the subinventory of an organization in the relationship. This subinventory is the final destination for the item in the replenishment request.",
            "nullable":false,
            "x-queryable":true
        },
        "MinMaxQuantitySource":{
            "title":"Min-Max Quantity Source",
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the source of the minimum and maximum quantities used to manage vendor-managed inventory replenishments. Valid values include Enterprise and Supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequisitionRequesterUserName":{
            "title":"Requisition Requester",
            "maxLength":"255",
            "type":"string",
            "description":"Login that the user used when requesting the requisition for the relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "SubinventoryRelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies the subinventory relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the vendor-managed inventory relationship.",
            "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 update one subinventory relationship.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/vmiRelationships/vmiRelationshipsUniqID/child/vmiSubinventories/vmiSubinventoriesUniqID"

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 updates.

{
"MinMaxQuantitySourceCode": "ORA_VCS_MIN_MAX_ORIGIN_ENT"
}

Example Response Body

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

{
    "RelationshipId": 300100176385880,
    "RelationshipNumber": "45002",
    "SubinventoryRelationshipId": 300100176385881,
    "SubinventoryId": 300100152283616,
    "Subinventory": "VMIMFG3-01",
    "SubinventoryDescription": "VMIMFG3 Subinventory 1",
    "InventoryPlanningOwner": "Supplier",
    "InventoryPlanningOwnerCode": "ORA_VCS_INV_OWNER_SUP",
    "MinMaxQuantitySource": "Enterprise",
    "MinMaxQuantitySourceCode": "ORA_VCS_MIN_MAX_ORIGIN_ENT",
    "RequisitionRequesterPersonId": 300100073936640,
    "RequisitionRequesterUserName": "VMI_OPERATIONS",
    "CreatedBy": "SCC_OPERATIONS",
    "CreationDate": "2018-10-24T19:48:49.551+00:00",
    "LastUpdatedBy": "SCC_OPERATIONS",
    "LastUpdateDate": "2018-10-24T20:23:44.011+00:00",
    "links": [
        {
            ...
        },
        {
            ...
        },
        {
            ...
        }
    ]
}

Back to Top