Create relationships
post
/fscmRestApi/resources/11.13.18.05/collaborationRelationships
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AdjustCommits: string
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. -
AdjustOrderForecasts: string
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. -
AttributeId: integer
(int64)
Value that uniquely identifies an attribute of the relationship.
-
collaborationPlanners: array
Planners
Title:
Planners
The Planners resource manages the collaboration planners configured for collaboration in a relationship. -
CollaborationUnitOfMeasure: string
Name of the unit of measure used for supply chain collaboration.
-
CollaborationUOMCode: string
Abbreviation that identifies the unit of measure used for supply chain collaboration.
-
CollaborationUOMSourceCode: string
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. -
CollaborationUOMSourceName: string
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. -
CommitHorizonInDays: integer
Title:
Commit Horizon in Days
Number of days in the future that the order forecast will contain commit quantities. -
CommitPeriod: string
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. -
CommitPeriodDays: integer
(int32)
Number of days in the future to provide commit quantities to the enterprise. This attribute is used when the commit period is days.
-
CommitQuantity: string
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. -
CommitQuantityPercentage: number
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.
-
CommitSlaInDays: integer
Title:
Commit SLA in Days
Number of days from the publish date that the supplier must commit for an order forecast. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
Date the relationship becomes inactive. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Date the relationship becomes active. -
ForecastHorizonInDays: integer
Title:
Forecast Horizon in Days
Number of days in the future that the order forecast will contain forecast quantities. -
InventoryItemId: integer
Title:
Item
Value that uniquely identifies the inventory item in the relationship. -
ItemCategory: string
Title:
Item Category
Maximum Length:255
Category that the application assigns to the item from the default planning catalog. -
ItemNumber: string
Title:
Item
Number that identifies the item in the relationship. -
ManufacturerName: string
Maximum Length:
100
Name of the manufacturer. -
ManufacturerPartNumber: string
Maximum Length:
100
Number that identifies the item at the manufacturer. -
ObjectVersionNumber: integer
(int32)
Value that identifies the version of the record in the database.
-
ProcurementBU: string
Title:
Procurement BU
Name of the business unit. The application assigns the supplier to this business unit for the relationship. -
ShipFromSupplierName: string
Title:
Ship-from Supplier
Name of the supplier that ships the item. -
ShipFromSupplierSiteId: integer
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. -
ShipFromSupplierSiteName: string
Title:
Ship-from Supplier Site
Name of the supplier site that ships the item. -
ShipToOrganizationCode: string
Title:
Ship-to Organization
Abbreviation that identifies the organization that receives the item. -
ShipToOrganizationId: 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.
-
SlaAction: string
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. -
ViewOrderForecasts: string
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-post-request
Type:
Show Source
object
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.
Root Schema : collaborationRelationships-item-response
Type:
Show Source
object
-
AdjustCommits: string
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. -
AdjustOrderForecasts: string
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. -
AttributeId: integer
(int64)
Value that uniquely identifies an attribute of the relationship.
-
B2BMessagingConfigured: string
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. -
collaborationPlanners: array
Planners
Title:
Planners
The Planners resource manages the collaboration planners configured for collaboration in a relationship. -
CollaborationUnitOfMeasure: string
Name of the unit of measure used for supply chain collaboration.
-
CollaborationUOMCode: string
Abbreviation that identifies the unit of measure used for supply chain collaboration.
-
CollaborationUOMSourceCode: string
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. -
CollaborationUOMSourceName: string
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. -
CommitHorizonInDays: integer
Title:
Commit Horizon in Days
Number of days in the future that the order forecast will contain commit quantities. -
CommitPeriod: string
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. -
CommitPeriodDays: integer
(int32)
Number of days in the future to provide commit quantities to the enterprise. This attribute is used when the commit period is days.
-
CommitQuantity: string
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. -
CommitQuantityPercentage: number
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.
-
CommitSlaInDays: integer
Title:
Commit SLA in Days
Number of days from the publish date that the supplier must commit for an order forecast. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the collaboration relationship. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the user created the collaboration relationship. -
DropShipFlag: boolean
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. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
Date the relationship becomes inactive. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Date the relationship becomes active. -
ForecastHorizonInDays: integer
Title:
Forecast Horizon in Days
Number of days in the future that the order forecast will contain forecast quantities. -
InventoryItemId: integer
Title:
Item
Value that uniquely identifies the inventory item in the relationship. -
ItemCategory: string
Title:
Item Category
Maximum Length:255
Category that the application assigns to the item from the default planning catalog. -
ItemDescription: string
Read Only:
true
Maximum Length:255
Description of the item in the relationship. -
ItemNumber: string
Title:
Item
Number that identifies the item in the relationship. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the user most recently updated the collaboration relationship. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Login of the user who most recently updated the collaboration relationship. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManufacturerName: string
Maximum Length:
100
Name of the manufacturer. -
ManufacturerPartNumber: string
Maximum Length:
100
Number that identifies the item at the manufacturer. -
ObjectVersionNumber: integer
(int32)
Value that identifies the version of the record in the database.
-
ProcurementBU: string
Title:
Procurement BU
Name of the business unit. The application assigns the supplier to this business unit for the relationship. -
ProcurementBUId: integer
(int64)
Title:
Business Unit ID
Read Only:true
Value that uniquely identifies the procurement business unit in the relationship. -
RelationshipId: integer
(int64)
Read Only:
true
Value that uniquely identifies the relationship. -
RelationshipNumber: integer
(int32)
Title:
Relationship ID
Read Only:true
Default Value:-1
Number that identifies the relationship. -
ShipFromSupplierAlternateName: string
Read Only:
true
Alternate name of the supplier that ships the item. -
ShipFromSupplierDUNS: string
Read Only:
true
Maximum Length:30
Data universal numbering system of the supplier who ships the item. -
ShipFromSupplierId: integer
(int64)
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. -
ShipFromSupplierName: string
Title:
Ship-from Supplier
Name of the supplier that ships the item. -
ShipFromSupplierNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the supplier that ships the item. -
ShipFromSupplierSiteId: integer
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. -
ShipFromSupplierSiteName: string
Title:
Ship-from Supplier Site
Name of the supplier site that ships the item. -
ShipToOrganizationCode: string
Title:
Ship-to Organization
Abbreviation that identifies the organization that receives the item. -
ShipToOrganizationId: 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.
-
ShipToOrganizationName: string
Read Only:
true
Maximum Length:255
Name of the organization that receives the item. -
ShipToSupplierAlternateName: string
Read Only:
true
Alternate name of the supplier that receives the item. -
ShipToSupplierDUNS: string
Read Only:
true
Maximum Length:30
Data universal numbering system of the supplier that receives the item. -
ShipToSupplierId: integer
(int64)
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. -
ShipToSupplierName: string
Title:
Ship-to Supplier
Read Only:true
Maximum Length:360
Name of the supplier that receives the item. -
ShipToSupplierNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the supplier that receives the item. -
ShipToSupplierSiteId: integer
(int64)
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. -
ShipToSupplierSiteName: string
Title:
Ship-to Supplier Site
Read Only:true
Maximum Length:15
Name of the supplier site in the relationship that receives the item. -
SlaAction: string
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. -
SourceSystem: string
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. -
SourceSystemCode: string
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. -
ViewOrderForecasts: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : collaborationRelationships-collaborationPlanners-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonId: integer
(int64)
Read Only:
true
Value that uniquely identifies the user who manages order forecast data in collaboration with suppliers. -
Planner: string
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- collaborationPlanners
-
Parameters:
- RelationshipNumber:
$request.path.RelationshipNumber
The Planners resource manages the collaboration planners configured for collaboration in a relationship. - RelationshipNumber:
Examples
This example describes how to create collaboration relationships.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/collaborationRelationships"
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.
{ "parts": [ { "id": "part1", "path": "/collaborationRelationships", "operation": "create", "payload": { "ShipFromSupplierSiteId": 1, "ShipToOrganizationId": 204, "InventoryItemId": 149, "EffectiveStartDate": "2015-09-05", "EffectiveEndDate": "2015-09-05" } }, { "id": "part2", "path": "/collaborationRelationships", "operation": "create", "payload": { "ShipFromSupplierSiteId": 1, "ShipToOrganizationId": 204, "InventoryItemId": 149, "EffectiveStartDate": "2015-09-06", "EffectiveEndDate": "2015-09-06" } } ] }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "Items": [ { "RelationshipId": 300100112018163, "RelationshipNumber": 6003, "AttributeId": 300100112018164, "ShipFromSupplierId": 21, "ShipFromSupplierName": "First Network Devices", "ShipFromSupplierNumber": "1013", "ShipFromSupplierDUNS": null, "ShipFromSupplierAlternateName": "AND", "ShipFromSupplierSiteId": 300100027834859, "ShipFromSupplierSiteName": "ATLANTA", "ProcurementBU": "Vision Operations", "ShipToOrganizationId": 207, "ShipToOrganizationCode": "M1", "ShipToOrganizationName": "Tall Manufacturing", "ShipToSupplierId": null, "ShipToSupplierName": null, "ShipToSupplierNumber": null, "ShipToSupplierDUNS": null, "ShipToSupplierAlternateName": null, "ShipToSupplierSiteId": null, "ShipToSupplierSiteName": null, "InventoryItemId": 300100075559207, "ItemNumber": "AI-Bolt", "ItemDescription": "Bolts\n", "ItemCategory": "Uncategorized", "EffectiveStartDate": null, "EffectiveEndDate": null, "B2BMessagingConfigured": "N", "ForecastHorizonInDays": 999, "CommitHorizonInDays": 888, "SlaAction": null, "CommitPeriod": null, "CommitPeriodDays": null, "CommitQuantity": null, "CommitQuantityPercentage": null, "CommitSlaInDays": 10, "ViewOrderForecasts": "N", "AdjustOrderForecasts": "N", "AdjustCommits": "N", "CreatedBy": "SCMOPERATIONS", "CreationDate": "2017-08-18T03:50:10.803+00:00", "LastUpdatedBy": "SCMOPERATIONS", "LastUpdateDate": "2017-08-29T06:10:47+00:00", "ObjectVersionNumber": 2, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/collaborationRelationships/00020000000EACED00057708000110F08092EAF30000000EACED00057708000110F08092EAF4", "name": "collaborationRelationships", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000027371007E00020000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/collaborationRelationships/00020000000EACED00057708000110F08092EAF30000000EACED00057708000110F08092EAF4", "name": "collaborationRelationships", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/collaborationRelationships/00020000000EACED00057708000110F08092EAF30000000EACED00057708000110F08092EAF4/child/collaborationPlanners", "name": "collaborationPlanners", "kind": "collection" } ] }, { "RelationshipId": 300100112018163, "RelationshipNumber": 6003, "AttributeId": 300100112018164, "ShipFromSupplierId": 21, "ShipFromSupplierName": "First Network Devices", "ShipFromSupplierNumber": "1013", "ShipFromSupplierDUNS": null, "ShipFromSupplierAlternateName": "AND", "ShipFromSupplierSiteId": 300100027834859, "ShipFromSupplierSiteName": "ATLANTA", "ProcurementBU": "Vision Operations", "ShipToOrganizationId": 207, "ShipToOrganizationCode": "M1", "ShipToOrganizationName": "Tall Manufacturing", "ShipToSupplierId": null, "ShipToSupplierName": null, "ShipToSupplierNumber": null, "ShipToSupplierDUNS": null, "ShipToSupplierAlternateName": null, "ShipToSupplierSiteId": null, "ShipToSupplierSiteName": null, "InventoryItemId": 300100075559207, "ItemNumber": "AI-Bolt", "ItemDescription": "Bolts\n", "ItemCategory": "Uncategorized", "EffectiveStartDate": null, "EffectiveEndDate": null, "B2BMessagingConfigured": "N", "ForecastHorizonInDays": 999, "CommitHorizonInDays": 888, "SlaAction": null, "CommitPeriod": null, "CommitPeriodDays": null, "CommitQuantity": null, "CommitQuantityPercentage": null, "CommitSlaInDays": 10, "ViewOrderForecasts": "N", "AdjustOrderForecasts": "N", "AdjustCommits": "N", "CreatedBy": "SCMOPERATIONS", "CreationDate": "2017-08-18T03:50:10.803+00:00", "LastUpdatedBy": "SCMOPERATIONS", "LastUpdateDate": "2017-08-29T06:10:47+00:00", "ObjectVersionNumber": 2, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/collaborationRelationships/00020000000EACED00057708000110F08092EAF30000000EACED00057708000110F08092EAF4", "name": "collaborationRelationships", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000027371007E00020000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/collaborationRelationships/00020000000EACED00057708000110F08092EAF30000000EACED00057708000110F08092EAF4", "name": "collaborationRelationships", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/collaborationRelationships/00020000000EACED00057708000110F08092EAF30000000EACED00057708000110F08092EAF4/child/collaborationPlanners", "name": "collaborationPlanners", "kind": "collection" } ] } ] }