Get a relationship
get
/crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/relationships/{RelationCode}
Request
Path Parameters
-
ObjectCode(required): string
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=
-
RelationCode(required): string
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:
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:
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 : objectMetadata-relationships-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the relationship of the child object metadata record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the relationship of the child object metadata record was created. -
IntersectionObjectCode: string
Title:
Intersection Object Code
Maximum Length:128
The language independent code of the intersection object, which uniquely identifies the object. -
IntersectionObjectDisplayName: string
Title:
Intersection Object
Read Only:true
Maximum Length:255
The display name of the intersection object. -
IntersectionSourceAttribute: string
Title:
Intersection Source Attribute
Maximum Length:128
The attribute of the intersection object which is associated with the relationship between source object and intersection object. -
IntersectionSrcVlaName: string
Title:
Intersection Source View Link Accessor Name
Maximum Length:300
The name of the View Link Accessor, which is between source object and intersection object. -
IntersectionTargetAttribute: string
Title:
Intersection Target Attribute
Maximum Length:100
The attribute of the intersection object which is associated with the relationship between intersection object and target object. -
IntersectionTrgtVlaName: string
Title:
Intersection Target View Link Accessor Name
Maximum Length:300
The name of the View Link Accessor, which is between intersection object and target object. -
IsCustomRelationFlag: boolean
Title:
Custom Relation
Maximum Length:1
Default Value:false
Indicates whether the relationship is custom. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the child object metadata relationships record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the child object metadata relationships record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectCode: string
Title:
Source Object Code
Maximum Length:128
The language independent code of the source object of the relation. -
RelationCode: string
Title:
Relation Name
Maximum Length:500
The language independent code of the relation which uniquely identifies the relation. -
RelationshipCardinality: string
Title:
Relationship Cardinality
Maximum Length:30
The cardinality of the relationship, such as OneToOne or ManyToMany. -
RelationshipDisplayName: string
Title:
Relationship Display Name
Maximum Length:100
The display name of the relationship. -
relationshipProperties: array
Attribute Properties
Title:
Attribute Properties
The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties. -
RelationshipType: string
Title:
Relationship Type
Maximum Length:100
The type of the relationship. -
SourceObjectAttributes: string
Title:
Source Object Attributes
Read Only:true
The attributes of the source object which is associated with the relationship. -
SourceObjectDisplayName: string
Title:
Source Object
Read Only:true
Maximum Length:255
The display name of the source object. -
SourceObjectVlaName: string
Title:
Source Object View Link Accessor Name
Maximum Length:300
The View Link Accessor name of the source object. -
TargetObjectAttributes: string
Title:
Target Object Attributes
Read Only:true
The attributes of the target object which is associated with the relationship. -
TargetObjectCode: string
Title:
Target Object Code
Maximum Length:128
The language independent code of the target object, which uniquely identifies the object. -
TargetObjectDisplayName: string
Title:
Target Object
Read Only:true
Maximum Length:255
The display name of the target object. -
TargetObjectVlaName: string
Title:
Target Object View Link Accessor Name
Maximum Length:300
The View Link Accessor name of the child object metadata source object. -
ViewLinkDef: string
Title:
View Link Definition
Maximum Length:600
The fully qualified name of the view link related to relationship.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Attribute Properties
Type:
array
Title:
Attribute Properties
The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties.
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.
Nested Schema : objectMetadata-relationships-relationshipProperties-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the attribute properties record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the attribute properties record was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the attribute properties record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the attribute properties record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PropertyCode: string
Title:
Property Name
Maximum Length:200
The name of the property. -
PropertyGroup: string
Title:
Property Group
Maximum Length:30
The name of the group to which the property belongs to. -
PropertyValue: string
Title:
Property Value
Maximum Length:4000
The value of the property.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- relationshipProperties
-
Parameters:
- ObjectCode:
$request.path.ObjectCode
- RelationCode3:
$request.path.RelationCode3
The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties. - ObjectCode: