1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Supply Chain Planning
  4. Collaboration Relationships

Update one relationship

patch

/fscmRestApi/resources/11.13.18.05/collaborationRelationships/{RelationshipNumber}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
    Default Value: -1
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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Adjust Commits
    Maximum Length: 1
    Default Value: N
    Contains Y or N. If Y, then the ship-to supplier can adjust commits for their suppliers. If N, then this supplier can't make this adjustment. The default value is N. This attribute is applicable only to each relationship where the ship-to organization is a contract manufacturer and View Order Forecasts is Y.
  • Title: Adjust Order Forecasts
    Maximum Length: 1
    Default Value: N
    Contains Y or N. If Y, then the ship-to supplier can view order forecasts for their suppliers. If N, then this supplier can't view these forecasts. The default value is N. This attribute is applicable to each relationship when the ship-to organization is a contract manufacturer and View Order Forecasts is Y.
  • Planners
    Title: Planners
    The Planners resource manages the collaboration planners configured for collaboration in a relationship.
  • Name of the unit of measure used for supply chain collaboration.
  • Abbreviation that identifies the unit of measure used for supply chain collaboration.
  • Maximum Length: 32
    Default Value: ORA_VCS_UOMSOURCE_PUB
    Abbreviation that identifies the source for the unit of measure that's available for supply chain collaboration. Values include ORA_VCS_UOMSOURCE_PUB, ORA_VCS_UOMSOURCE_ASL, ORA_VCS_UOMSOURCE_PRI, or ORA_VCS_UOMSOURCE_OTH.
  • Maximum Length: 255
    Name of the source for the unit of measure that's available for supply chain collaboration. Values include Published order forecast, Approved supplier list, or Primary.
  • Title: Commit Horizon in Days
    Number of days in the future that the order forecast will contain commit quantities.
  • Title: Commit Period
    Maximum Length: 32
    Time period when the process must provide commit quantities to the enterprise. This attribute can contain one of the following values: Commit Horizon or Days. This attribute is used when SLA Action is Commit Automatically.
  • Number of days in the future to provide commit quantities to the enterprise. This attribute is used when the commit period is days.
  • Title: Commit Quantity
    Maximum Length: 32
    Quantity provided to the enterprise when the process reaches the action that the service level agreement specifies. Valid values include Previous Forecast Commits or Percentage of Current Forecast. This attribute is used when the Commit Period is set.
  • Percent of the current forecast to commit. This attribute is used when the commit quantity contains percent of current forecast. The default value is 100.
  • Title: Commit SLA in Days
    Number of days from the publish date that the supplier must commit for an order forecast.
  • Title: Effective End Date
    Date the relationship becomes inactive.
  • Title: Effective Start Date
    Date the relationship becomes active.
  • Title: Forecast Horizon in Days
    Number of days in the future that the order forecast will contain forecast quantities.
  • Title: Item
    Value that uniquely identifies the inventory item in the relationship.
  • Title: Item Category
    Maximum Length: 255
    Category that the application assigns to the item from the default planning catalog.
  • Title: Item
    Number that identifies the item in the relationship.
  • Maximum Length: 100
    Name of the manufacturer.
  • Maximum Length: 100
    Number that identifies the item at the manufacturer.
  • Value that identifies the version of the record in the database.
  • Title: Procurement BU
    Name of the business unit. The application assigns the supplier to this business unit for the relationship.
  • Title: Ship-from Supplier
    Name of the supplier that ships the item.
  • Title: Supplier Site ID
    Value that uniquely identifies the supplier site in the relationship. This supplier site sends the shipment. It's a primary key that the application generates when it creates the supplier site.
  • Title: Ship-from Supplier Site
    Name of the supplier site that ships the item.
  • Title: Ship-to Organization
    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.
  • Title: SLA Action
    Maximum Length: 32
    Action that the application takes when it reaches the service level agreement. This attribute is empty or can contain a value of Commit Automatically. The default value is empty. This attribute is used when the Commit SLA in Days is a positive whole number.
  • Title: View Order Forecasts
    Maximum Length: 1
    Default Value: N
    Contains Y or N. If Y, then the ship-to supplier can view order forecasts for their suppliers. If N, then this supplier can't view these forecasts. The default value is N. This attribute is applicable to each relationship when the ship-to organization is a contract manufacturer.
Nested Schema : Planners
Type: array
Title: Planners
The Planners resource manages the collaboration planners configured for collaboration in a relationship.
Show Source
Nested Schema : collaborationRelationships-collaborationPlanners-item-patch-request
Type: object
Show Source
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 : collaborationRelationships-item-response
Type: object
Show Source
  • Title: Adjust Commits
    Maximum Length: 1
    Default Value: N
    Contains Y or N. If Y, then the ship-to supplier can adjust commits for their suppliers. If N, then this supplier can't make this adjustment. The default value is N. This attribute is applicable only to each relationship where the ship-to organization is a contract manufacturer and View Order Forecasts is Y.
  • Title: Adjust Order Forecasts
    Maximum Length: 1
    Default Value: N
    Contains Y or N. If Y, then the ship-to supplier can view order forecasts for their suppliers. If N, then this supplier can't view these forecasts. The default value is N. This attribute is applicable to each relationship when the ship-to organization is a contract manufacturer and View Order Forecasts is Y.
  • Value that uniquely identifies an attribute of the relationship.
  • Title: B2B Messaging Configured
    Read Only: true
    Maximum Length: 255
    Contains Y or N. If Y, then business-to-business messaging is configured for the ship-from supplier site. If N, then this messaging isn't configured. The default value is N.
  • Planners
    Title: Planners
    The Planners resource manages the collaboration planners configured for collaboration in a relationship.
  • Name of the unit of measure used for supply chain collaboration.
  • Abbreviation that identifies the unit of measure used for supply chain collaboration.
  • Maximum Length: 32
    Default Value: ORA_VCS_UOMSOURCE_PUB
    Abbreviation that identifies the source for the unit of measure that's available for supply chain collaboration. Values include ORA_VCS_UOMSOURCE_PUB, ORA_VCS_UOMSOURCE_ASL, ORA_VCS_UOMSOURCE_PRI, or ORA_VCS_UOMSOURCE_OTH.
  • Maximum Length: 255
    Name of the source for the unit of measure that's available for supply chain collaboration. Values include Published order forecast, Approved supplier list, or Primary.
  • Title: Commit Horizon in Days
    Number of days in the future that the order forecast will contain commit quantities.
  • Title: Commit Period
    Maximum Length: 32
    Time period when the process must provide commit quantities to the enterprise. This attribute can contain one of the following values: Commit Horizon or Days. This attribute is used when SLA Action is Commit Automatically.
  • Number of days in the future to provide commit quantities to the enterprise. This attribute is used when the commit period is days.
  • Title: Commit Quantity
    Maximum Length: 32
    Quantity provided to the enterprise when the process reaches the action that the service level agreement specifies. Valid values include Previous Forecast Commits or Percentage of Current Forecast. This attribute is used when the Commit Period is set.
  • Percent of the current forecast to commit. This attribute is used when the commit quantity contains percent of current forecast. The default value is 100.
  • Title: Commit SLA in Days
    Number of days from the publish date that the supplier must commit for an order forecast.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the collaboration relationship.
  • Title: Creation Date
    Read Only: true
    Date and time when the user created the collaboration relationship.
  • Read Only: true
    Contains one of the following values: true or false. If true, then the relationship is a drop ship relationship. If false, then the relationship isn't a drop ship relationship. This attribute doesn't have a default value.
  • Title: Effective End Date
    Date the relationship becomes inactive.
  • Title: Effective Start Date
    Date the relationship becomes active.
  • Title: Forecast Horizon in Days
    Number of days in the future that the order forecast will contain forecast quantities.
  • Title: Item
    Value that uniquely identifies the inventory item in the relationship.
  • Title: Item Category
    Maximum Length: 255
    Category that the application assigns to the item from the default planning catalog.
  • Read Only: true
    Maximum Length: 255
    Description of the item in the relationship.
  • Title: Item
    Number that identifies the item in the relationship.
  • Title: Last Updated Date
    Read Only: true
    Date and time when the user most recently updated the collaboration relationship.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    Login of the user who most recently updated the collaboration relationship.
  • Links
  • Maximum Length: 100
    Name of the manufacturer.
  • Maximum Length: 100
    Number that identifies the item at the manufacturer.
  • Value that identifies the version of the record in the database.
  • Title: Procurement BU
    Name of the business unit. The application assigns the supplier to this business unit for the relationship.
  • Title: Business Unit ID
    Read Only: true
    Value that uniquely identifies the procurement business unit in the relationship.
  • Read Only: true
    Value that uniquely identifies the relationship.
  • Title: Relationship ID
    Read Only: true
    Default Value: -1
    Number that identifies the relationship.
  • 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.
  • Title: Supplier ID
    Read Only: true
    Value that uniquely identifies the supplier who ships the item. It's a primary key that the application generates when it creates the supplier.
  • Title: Ship-from Supplier
    Name of the supplier that ships the item.
  • Read Only: true
    Maximum Length: 30
    Number that identifies the supplier that ships the item.
  • Title: Supplier Site ID
    Value that uniquely identifies the supplier site in the relationship. This supplier site sends the shipment. It's a primary key that the application generates when it creates the supplier site.
  • Title: Ship-from Supplier Site
    Name of the supplier site that ships the item.
  • Title: Ship-to Organization
    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: 255
    Name of the organization that receives the item.
  • Read Only: true
    Alternate name of the supplier that receives the item.
  • Read Only: true
    Maximum Length: 30
    Data universal numbering system of the supplier that receives the item.
  • Read Only: true
    Value that uniquely identifies the supplier who receives the item. It's a primary key that the application generates when it creates the supplier.
  • Title: Ship-to Supplier
    Read Only: true
    Maximum Length: 360
    Name of the supplier that receives the item.
  • Read Only: true
    Maximum Length: 30
    Number that identifies the supplier that receives the item.
  • Read Only: true
    Value that uniquely identifies the supplier site in the relationship. This supplier site sends the shipment. It's a primary key that the application generates when it creates the supplier site.
  • Title: Ship-to Supplier Site
    Read Only: true
    Maximum Length: 15
    Name of the supplier site in the relationship that receives the item.
  • Title: SLA Action
    Maximum Length: 32
    Action that the application takes when it reaches the service level agreement. This attribute is empty or can contain a value of Commit Automatically. The default value is empty. This attribute is used when the Commit SLA in Days is a positive whole number.
  • Read Only: true
    Maximum Length: 255
    Value that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include External or Oracle.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include ORA_VCS_SRCSYSTEM_EXTERNAL or ORA_VCS_SRCSYSTEM_ORACLE.
  • Title: View Order Forecasts
    Maximum Length: 1
    Default Value: N
    Contains Y or N. If Y, then the ship-to supplier can view order forecasts for their suppliers. If N, then this supplier can't view these forecasts. The default value is N. This attribute is applicable to each relationship when the ship-to organization is a contract manufacturer.
Nested Schema : Planners
Type: array
Title: Planners
The Planners resource manages the collaboration planners configured for collaboration in a relationship.
Show Source
Nested Schema : collaborationRelationships-collaborationPlanners-item-response
Type: object
Show Source
  • Links
  • Read Only: true
    Value that uniquely identifies the user who manages order forecast data in collaboration with suppliers.
  • Read Only: true
    Maximum Length: 240
    Display name of the collaboration planner who manages order forecast data in collaboration with suppliers. The format is Last name, First name.
Links
collaborationPlanners
Parameters:
  • RelationshipNumber: $request.path.RelationshipNumber
The Planners resource manages the collaboration planners configured for collaboration in a relationship.
Back to Top

Examples

This example describes how to update one collaboration 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/collaborationRelationships/collaborationRelationshipsUniqID"

For example, the following command updates the forecast horizon and commit horizon in collaboration relationship 62022:

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

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. 

{
"ForecastHorizonInDays":10,
"CommitHorizonInDays":12
}'

Example Response Body

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

{
  "RelationshipId" : 300100136534607,
  "RelationshipNumber" : 62022,
  "AttributeId" : 300100136534608,
  "ShipFromSupplierId" : 1225,
  "ShipFromSupplierName" : "CV_SuppA07",
  "ShipFromSupplierNumber" : "5111",
  "ShipFromSupplierDUNS" : null,
  "ShipFromSupplierAlternateName" : null,
  "ShipFromSupplierSiteId" : 6139,
  "ShipFromSupplierSiteName" : "42",
  "ProcurementBU" : "Vision Operations",
  "ShipToOrganizationId" : 300100025604147,
  "ShipToOrganizationCode" : "VISIONTAX",
  "ShipToOrganizationName" : "Vision Tax Inventory Org",
  "ShipToSupplierId" : null,
  "ShipToSupplierName" : null,
  "ShipToSupplierNumber" : null,
  "ShipToSupplierDUNS" : null,
  "ShipToSupplierAlternateName" : null,
  "ShipToSupplierSiteId" : null,
  "ShipToSupplierSiteName" : null,
  "InventoryItemId" : 300100025802579,
  "ItemNumber" : "Tax Setup Item02",
  "ItemDescription" : "Tax Setup Item02 Desc",
  "ItemCategory" : "Uncategorized",
  "EffectiveStartDate" : null,
  "EffectiveEndDate" : null,
  "B2BMessagingConfigured" : "N",
  "ForecastHorizonInDays" : 10,
  "CommitHorizonInDays" : 12,
  "SlaAction" : null,
  "CommitPeriod" : null,
  "CommitPeriodDays" : null,
  "CommitQuantity" : null,
  "CommitQuantityPercentage" : null,
  "CommitSlaInDays" : null,
  "ViewOrderForecasts" : "N",
  "AdjustOrderForecasts" : "N",
  "AdjustCommits" : "N",
  "CreatedBy" : "SCMOPERATIONS",
  "CreationDate" : "2017-11-29T16:41:49.174+00:00",
  "LastUpdatedBy" : "SCMOPERATIONS",
  "LastUpdateDate" : "2017-12-11T02:50:28+00:00",
  "ObjectVersionNumber" : 2,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/collaborationRelationships/62022",
    "name" : "collaborationRelationships",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000027371007E00020000000178"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername/fscmRestApi/resources/version/collaborationRelationships/62022",
    "name" : "collaborationRelationships",
    "kind" : "item"
  }, {
    "rel" : "child",
    "href" : "https://servername/fscmRestApi/resources/version/collaborationRelationships/62022/child/collaborationPlanners",
    "name" : "collaborationPlanners",
    "kind" : "collection"
  } ]
}
Back to Top