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

Get all relationships

get

/fscmRestApi/resources/11.13.18.05/vmiRelationships

Request

Query Parameters
  • 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
  • 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 Finds relationships according to the specified primary key criteria.
      Finder Variables
      • RelationshipId; integer; Value that uniquely identifies the vendor-managed inventory relationship.
    • RowFinder Find vendor-managed inventory relationships according to the relationship number.
      Finder Variables
      • RelationshipNumber; integer; Number that uniquely identifies the vendor-managed inventory relationship.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CreatedBy; string; User who created the vendor-managed inventory relationship.
    • CreationDate; string; Date and time when the user created the vendor-managed inventory relationship.
    • InventoryItemId; integer; Value that uniquely identifies the inventory item in the relationship.
    • InventoryPlanningOwner; string; 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; 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.
    • ItemCategory; string; Category that the application assigns to the item.
    • ItemDescription; string; Description of the item.
    • ItemNumber; string; Number that identifies the item.
    • LastUpdateDate; string; Date and time when the user most recently updated the vendor-managed inventory relationship.
    • LastUpdatedBy; string; Login of the user who most recently updated the vendor-managed inventory relationship.
    • MinMaxQuantitySource; string; Identifies the source of the minimum and maximum quantities used to manage vendor-managed inventory replenishments. Values include Supplier or Enterprise.
    • MinMaxQuantitySourceCode; string; 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.
    • OrganizationCode; string; Abbreviation that identifies the organization that receives the item.
    • OrganizationId; integer; 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.
    • OrganizationName; string; Name of the organization that receives the item.
    • RelationshipId; integer; Value that uniquely identifies the relationship.
    • RelationshipNumber; string; Number that identifies the relationship.
    • RequisitionRequesterPersonId; integer; Value that uniquely identifies the requisition requester for the relationship.
    • RequisitionRequesterUserName; string; Login that the user used when requesting the requisition for the relationship.
    • Scope; string; Value that indicates the level at which the replenishment process is managed. Values include Organization and Subinventory.
    • ScopeCode; string; 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.
    • Status; string; Value that identifies the current state of the vendor-managed inventory relationship. Values include Active or Inactive.
    • StatusCode; string; 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.
    • SupplierAlternateName; string; Alternate name of the supplier that ships the item.
    • SupplierDUNS; string; Data universal numbering system of the supplier who ships the item.
    • SupplierId; integer; Value that uniquely identifies the supplier who ships the item. It's a primary key that the application generates when it creates the supplier.
    • SupplierName; string; Name of the supplier that ships the item.
    • SupplierNumber; string; Number of the supplier that ships the item.
  • 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
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested 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
Back to Top

Examples

This example describes how to get all relationships.

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"

Example Response Body

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

{
    "items": [
        {
            "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": [
                {
                    ...
                    }
                },
                {
                    ...
                },
                {
     ...
                }
            ]
        },
        {
            "RelationshipId": 300100176282385,
            "RelationshipNumber": "15013",
            "SupplierId": 21,
            "SupplierName": "CV_SuppA02",
            "SupplierNumber": "1013",
            "SupplierDUNS": null,
            "SupplierAlternateName": "AND",
            "OrganizationId": 204,
            "OrganizationCode": "V1",
            "OrganizationName": "Vision Operations",
            "InventoryItemId": 300100092864032,
            "ItemNumber": "SCC-CNTRDL-01",
            "ItemDescription": "DL Controller V1",
            "ItemCategory": "Miscellaneous_1",
            "Scope": "Subinventory",
            "ScopeCode": "ORA_VCS_SCOPE_SHIP_TO_SUB",
            "Status": "Active",
            "StatusCode": "ORA_VCS_STATUS_VMI_RL_ACTIVE",
            "InventoryPlanningOwner": null,
            "InventoryPlanningOwnerCode": null,
            "MinMaxQuantitySource": "Enterprise",
            "MinMaxQuantitySourceCode": "ORA_VCS_MIN_MAX_ORIGIN_ENT",
            "RequisitionRequesterPersonId": null,
            "RequisitionRequesterUserName": null,
            "CreatedBy": "SCC_MANAGER",
            "CreationDate": "2018-09-26T15:14:09+00:00",
            "LastUpdatedBy": "SCC_MANAGER",
            "LastUpdateDate": "2018-10-11T13:50:57+00:00",
            "links": [
                {
                    ...
                    }
                },
                {
                    ...
                },
                {
     ...
                }
            ]
        },
        {
            "RelationshipId": 300100182624811,
            "RelationshipNumber": "75001",
            "SupplierId": 12,
            "SupplierName": "CV_SuppA01",
            "SupplierNumber": "1011",
            "SupplierDUNS": null,
            "SupplierAlternateName": null,
            "OrganizationId": 204,
            "OrganizationCode": "V1",
            "OrganizationName": "Vision Operations",
            "InventoryItemId": 300100092864005,
            "ItemNumber": "SCC-CNTRML-05",
            "ItemDescription": "ML Controller",
            "ItemCategory": "Miscellaneous_1",
            "Scope": "Subinventory",
            "ScopeCode": "ORA_VCS_SCOPE_SHIP_TO_SUB",
            "Status": "Active",
            "StatusCode": "ORA_VCS_STATUS_VMI_RL_ACTIVE",
            "InventoryPlanningOwner": null,
            "InventoryPlanningOwnerCode": null,
            "MinMaxQuantitySource": "Enterprise",
            "MinMaxQuantitySourceCode": "ORA_VCS_MIN_MAX_ORIGIN_ENT",
            "RequisitionRequesterPersonId": null,
            "RequisitionRequesterUserName": null,
            "CreatedBy": "COLLABPLANNER08",
            "CreationDate": "2018-10-19T03:21:39+00:00",
            "LastUpdatedBy": "COLLABPLANNER08",
            "LastUpdateDate": "2018-10-19T03:23:01.517+00:00",
            "links": [
                {
                    ...
                    }
                },
                {
                    ...
                },
                {
     ...
                }
            ]
        }
    ],
    "count": 3,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            ...
        }
    ]
}
Back to Top