Get one candidate
get
/fscmRestApi/resources/11.13.18.05/collaborationRelationshipCandidates/{collaborationRelationshipCandidatesUniqID}
Request
Path Parameters
-
collaborationRelationshipCandidatesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Collaboration Relationship Candidates resource and used to uniquely identify an instance of Collaboration Relationship Candidates. The client should not generate the hash key value. Instead, the client should query on the Collaboration Relationship Candidates collection resource in order to navigate to a specific instance of Collaboration Relationship Candidates to get the hash key.
Query Parameters
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : collaborationRelationshipCandidates-item-response
Type:
Show Source
object
-
CollaborationPlanName: string
Read Only:
true
Maximum Length:30
Name of the collaboration plan. -
InventoryItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory item in the relationship candidate. -
InventoryItemOrgId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory item organization. The application assigns the item to this organization in the relationship candidate. -
ItemCategory: string
Title:
Item Category
Read Only:true
Maximum Length:250
Category that the application assigns to the item from the default planning catalog. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the item in the relationship. -
ItemNumber: string
Title:
Item Number
Read Only:true
Maximum Length:300
Number of the item in the relationship. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProcurementBU: string
Title:
Procurement BU
Read Only:true
Maximum Length:240
Name of the business unit. The application assigns the supplier to this business unit. -
ProcurementBUId: integer
(int64)
Title:
Business Unit ID
Read Only:true
Value that uniquely identifies the procurement business unit. It's a primary key that the application creates when it creates the business unit. -
PublishedDate: string
(date-time)
Title:
Publish Date
Read Only:true
Date when the application most recently published the relationship candidate during planning. -
ShipFromSupplierId: integer
(int64)
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
Read Only:true
Maximum Length:360
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
(int64)
Read Only:
true
Value that uniquely identifies the supplier site from where the item is shipped. 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
Read Only:true
Maximum Length:15
Name of the supplier site from where the item is shipped. -
ShipToOrganizationCode: string
Title:
Ship-To Org Code
Read Only:true
Maximum Length:18
Abbreviation that identifies the organization that receives the item. -
ShipToOrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the organization in the relationship candidate. This organization receives the shipment. It's a primary key that the application creates when it creates an organization. -
ShipToOrganizationName: string
Title:
Ship-to Organization Name
Read Only:true
Maximum Length:240
Name of the organization 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 creates when it creates the supplier. -
ShipToSupplierName: string
Title:
Ship-to Supplier
Read Only:true
Maximum Length:360
Name of the supplier who receives the item. -
ShipToSupplierNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the supplier that receives the item. -
ShipToSupplierSiteCode: string
Title:
Ship-to Supplier Site
Read Only:true
Maximum Length:15
Abbreviation that identifies the supplier site that receives the item. -
ShipToSupplierSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier site. This supplier site receives the shipment. It's a primary key that the application creates when it creates the supplier site. -
SourceSystem: string
Read Only:
true
Maximum Length:80
Value that indicates the product data model source application 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 application for the supply plan that's available for supply chain collaboration. Values include ORA_VCS_SRCSYSTEM_EXTERNAL or ORA_VCS_SRCSYSTEM_ORACLE. -
Type: string
Read Only:
true
Maximum Length:15
Type of the relationship candidate. The type is only unprocessed or business-to-business.
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.