Get one relationship of a product development object
get
/fscmRestApi/resources/11.13.18.05/productDevelopmentRelationships/{Id}
Request
Path Parameters
-
Id(required): integer(int64)
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=
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: string
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: string
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:
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 : productDevelopmentRelationships-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the relationship. -
CreationDate: string
(date-time)
Read Only:
trueDate when the relationship was created. -
DiscoverOnlyAccessFlag: boolean
Read Only:
trueIndicates whether the user has only the discover privilege on the related object. -
ForwardRelationshipFlag: boolean
Read Only:
trueIndicates whether the relationship is from the context object to the related object. -
Id: integer
(int64)
Value that uniquely identifies the relationship.
-
ItemObjectType: string
Read Only:
trueMaximum Length:255Value that identifies the type of item object of the related object. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the relationship was updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the relationship. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Login that the user used when updating the relationship. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectId: integer
(int64)
Read Only:
trueSource object ID in the relationship. -
ObjectTypeCode: string
Read Only:
trueMaximum Length:255Object type code that identifies the source object type in the relationship. -
ObjectTypeValue: string
Read Only:
trueMaximum Length:255Type of source object in the relationship. -
ObjectVersionNumber: integer
(int32)
Read Only:
trueAttribute value that represents the version number of the source object in the relationship. -
RelatedObjectDescription: string
Read Only:
trueMaximum Length:255Description value of the related object in the relationship. -
RelatedObjectId: integer
(int64)
Read Only:
trueRelated object ID in the relationship. -
RelatedObjectLatestFlag: boolean
Read Only:
trueLatest Revision indicator of the related object in the relationship. -
RelatedObjectName: string
Read Only:
trueMaximum Length:255Name value of the related object in the relationship. -
RelatedObjectOrganizationCode: string
Read Only:
trueMaximum Length:255Organization code that identifies the related object organization in the relationship. -
RelatedObjectPk1Value: integer
(int64)
Read Only:
trueFirst primary key identifier of the related object in the relationship. -
RelatedObjectPk2Value: integer
(int64)
Read Only:
trueSecond primary key identifier of the related object in the relationship. -
RelatedObjectRevision: string
Read Only:
trueMaximum Length:255Revision of an item when the related object is ITEM. -
RelatedObjectStatus: string
Read Only:
trueMaximum Length:255Status of the related object in the relationship. -
RelatedObjectSubTypeValue: string
Read Only:
trueMaximum Length:255Subtype of the related object in the relationship. -
RelatedObjectTypeCode: string
Read Only:
trueMaximum Length:255Object type code that identifies the related object type in the relationship. -
RelatedObjectTypeValue: string
Read Only:
trueMaximum Length:255Object type value that identifies the related object type in the relationship. -
relationshipRules: array
Product Development Relationship Rules
Title:
Product Development Relationship RulesThe rules related to relationships on product development objects. -
TypeCode: string
Read Only:
trueMaximum Length:255Relationship type code of the relationship. -
TypeValue: string
Read Only:
trueMaximum Length:255Relationship type value of the relationship.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Product Development Relationship Rules
Type:
arrayTitle:
Product Development Relationship RulesThe rules related to relationships on product development objects.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Nested Schema : productDevelopmentRelationships-relationshipRules-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the relationship rule. -
CreationDate: string
(date-time)
Read Only:
trueDate when the relationship rule was created. -
DestinationObjectId: integer
(int64)
Read Only:
trueDestination object ID of the relationship rule. -
DestinationObjectNumber: string
Read Only:
trueMaximum Length:500Number that identifies the destination object in the relationship rule. -
DestinationObjectStatusCode: integer
Destination object workflow status code defined in the relationship rule.
-
DestinationObjectType: string
Maximum Length:
30Object type code that identifies the destination object type in the relationship rule. -
DestinationRuleStatus: string
Read Only:
trueMaximum Length:255Destination object workflow status defined in the relationship rule. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the relationship rule was updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the relationship rule. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Login that the user used when updating the relationship rule. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
RelationshipId: integer
(int64)
Relationship ID of the relationship.
-
RelationshipRuleId: integer
(int64)
Relationship rule ID of the relationship rule.
-
SourceObjectId: integer
(int64)
Read Only:
trueSource object ID in the relationship rule. -
SourceObjectNumber: string
Read Only:
trueMaximum Length:500Number that identifies the source object in the relationship rule. -
SourceObjectStatusCode: integer
Source object workflow status code defined in the relationship rule.
-
SourceObjectType: string
Maximum Length:
30Object type code that identifies the source object type in the relationship rule. -
SourceRuleStatus: string
Read Only:
trueMaximum Length:255Source object workflow status defined in the relationship rule.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- relationshipRules
-
Operation: /fscmRestApi/resources/11.13.18.05/productDevelopmentRelationships/{Id}/child/relationshipRulesParameters:
- Id:
$request.path.Id
The rules related to relationships on product development objects. - Id: