1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Supply Chain Planning
  4. Vendor-Managed Inventory Relationships

Get one relationship

get

/fscmRestApi/resources/11.13.18.05/vmiRelationships/{vmiRelationshipsUniqID}

Request

Path Parameters
  • 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.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the vendor-managed inventory relationship.
  • Title: Creation Date
    Read Only: true
    Date and time when the user created the vendor-managed inventory relationship.
  • Value that uniquely identifies the inventory item in the relationship.
  • 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.
  • Read Only: true
    Maximum Length: 255
    Abbreviation that identifies the inventory planning owner of the vendor-managed inventory replenishments for the relationship. A list of accepted values is defined in the lookup type ORA_VCS_VMI_INV_PLAN_OWNER.
  • Read Only: true
    Maximum Length: 2400
    Category that the application assigns to the item.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Description of the item.
  • Number that identifies the item.
  • Title: Last Updated Date
    Read Only: true
    Date and time when the user most recently updated the vendor-managed inventory relationship.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    Login of the user who most recently updated the vendor-managed inventory relationship.
  • Links
  • Maximum Length: 255
    Identifies the source of the minimum and maximum quantities used to manage vendor-managed inventory replenishments. Values include Supplier or Enterprise.
  • Maximum Length: 255
    Abbreviation that identifies the source of the minimum and maximum quantities used to manage vendor-managed inventory replenishments. Values include ORA_VCS_MIN_MAX_ORIGIN_SUP or ORA_VCS_MIN_MAX_ORIGIN_ENT.
  • Abbreviation that identifies the organization that receives the item.
  • Value that uniquely identifies the organization in the relationship. This organization receives the shipment. It's a primary key that the application generates when it creates an organization.
  • Read Only: true
    Maximum Length: 240
    Name of the organization that receives the item.
  • Value that uniquely identifies the relationship.
  • Title: Relationship
    Maximum Length: 9
    Number that identifies the relationship.
  • Value that uniquely identifies the requisition requester for the relationship.
  • Maximum Length: 255
    Login that the user used when requesting the requisition for the relationship.
  • Maximum Length: 255
    Value that indicates the level at which the replenishment process is managed. Values include Organization and Subinventory.
  • Title: Scope
    Maximum Length: 30
    Default Value: ORA_VCS_SCOPE_SHIP_TO_ORG
    Abbreviation that indicates the level at which the replenishment process is managed. Values include ORA_VCS_SCOPE_SHIP_TO_ORG and ORA_VCS_SCOPE_SHIP_TO_SUB. A list of accepted values is defined in the lookup type
    ORA_VCS_VMI_RELATIONSHIP_SCOPE.
  • Maximum Length: 255
    Value that identifies the current state of the vendor-managed inventory relationship. Values include Active or Inactive.
  • Title: Status
    Maximum Length: 30
    Default Value: ORA_VCS_STATUS_VMI_RL_ACTIVE
    Abbreviation that Identifies the current state of the vendor-managed inventory relationship. Values include ORA_VCS_STATUS_VMI_REL_ACTIVE or ORA_VCS_STATUS_VMI_REL_INACTIVE. A list of accepted values is defined in the lookup type ORA_VCS_VMI_RELATIONSHIP_STATUS.
  • Read Only: true
    Alternate name of the supplier that ships the item.
  • Read Only: true
    Maximum Length: 30
    Data universal numbering system of the supplier who ships the item.
  • Value that uniquely identifies the supplier who ships the item. It's a primary key that the application generates when it creates the supplier.
  • Name of the supplier that ships the item.
  • Maximum Length: 255
    Number of the supplier that ships the item.
  • Subinventory Relationships
    Title: Subinventory Relationships
    The Subinventory Relationships resource manages subinventory relationships that are configured for vendor-managed inventory.
Nested Schema : Subinventory Relationships
Type: array
Title: Subinventory Relationships
The Subinventory Relationships resource manages subinventory relationships that are configured for vendor-managed inventory.
Show Source
Nested Schema : vmiRelationships-vmiSubinventories-item-response
Type: object
Show Source
Links
vmiSubinventories
Parameters:
  • vmiRelationshipsUniqID: $request.path.vmiRelationshipsUniqID
The Subinventory Relationships resource manages subinventory relationships that are configured for vendor-managed inventory.
Back to Top

Examples

This example describes how to get one relationship.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/vmiRelationships/vmiRelationshipsUniqID"

For example, the following command gets one relationship:

curl -u username:password "https://servername/fscmRestApi/resources/version/vmiRelationships/77016"

Example Response Body

The following shows an example of the response body in JSON format.

{
    "RelationshipId": 300100183437370,
    "RelationshipNumber": "77016",
    "SupplierId": 12,
    "SupplierName": "CV_SuppA01",
    "SupplierNumber": "1011",
    "SupplierDUNS": null,
    "SupplierAlternateName": null,
    "OrganizationId": 204,
    "OrganizationCode": "V1",
    "OrganizationName": "Vision Operations",
    "InventoryItemId": 300100092864032,
    "ItemNumber": "SCC-CNTRDL-01",
    "ItemDescription": "DL Controller V1",
    "ItemCategory": "Miscellaneous_1",
    "Scope": "Organization",
    "ScopeCode": "ORA_VCS_SCOPE_SHIP_TO_ORG",
    "Status": "Active",
    "StatusCode": "ORA_VCS_STATUS_VMI_RL_ACTIVE",
    "InventoryPlanningOwner": "Supplier",
    "InventoryPlanningOwnerCode": "ORA_VCS_INV_OWNER_SUP",
    "MinMaxQuantitySource": "Supplier",
    "MinMaxQuantitySourceCode": "ORA_VCS_MIN_MAX_ORIGIN_SUP",
    "RequisitionRequesterPersonId": null,
    "RequisitionRequesterUserName": null,
    "CreatedBy": "SCC_MANAGER",
    "CreationDate": "2018-10-23T07:44:02+00:00",
    "LastUpdatedBy": "SCC_MANAGER",
    "LastUpdateDate": "2018-10-23T07:45:23.297+00:00",
    "links": [
        {
            ...
        }
        },
        {
            ...
        }
        },
        {
            ...
        }
        }
    ]
}
Back to Top