Create a relationship
post
/crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/relationships
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=
-
ObjectCode2(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=
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.
-
Upsert-Mode: string
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-
IntersectionObjectCode: string
Title:
Intersection Object CodeMaximum Length:128The language independent code of the intersection object, which uniquely identifies the object. -
IntersectionSourceAttribute: string
Title:
Intersection Source AttributeMaximum Length:128The 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 NameMaximum Length:300The name of the View Link Accessor, which is between source object and intersection object. -
IntersectionTargetAttribute: string
Title:
Intersection Target AttributeMaximum Length:100The 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 NameMaximum Length:300The name of the View Link Accessor, which is between intersection object and target object. -
IsCustomRelationFlag: boolean
Title:
Custom RelationMaximum Length:1Default Value:falseIndicates whether the relationship is custom. -
ObjectCode(required): string
Title:
Source Object CodeMaximum Length:128The language independent code of the source object of the relation. -
RelationCode(required): string
Title:
Relation NameMaximum Length:500The language independent code of the relation which uniquely identifies the relation. -
RelationshipCardinality(required): string
Title:
Relationship CardinalityMaximum Length:30The cardinality of the relationship, such as OneToOne or ManyToMany. -
RelationshipDisplayName: string
Title:
Relationship Display NameMaximum Length:100The display name of the relationship. -
relationshipProperties: array
Attribute Properties
Title:
Attribute PropertiesThe attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties. -
RelationshipType(required): string
Title:
Relationship TypeMaximum Length:100The type of the relationship. -
SourceObjectVlaName: string
Title:
Source Object View Link Accessor NameMaximum Length:300The View Link Accessor name of the source object. -
TargetObjectCode(required): string
Title:
Target Object CodeMaximum Length:128The language independent code of the target object, which uniquely identifies the object. -
TargetObjectVlaName: string
Title:
Target Object View Link Accessor NameMaximum Length:300The View Link Accessor name of the child object metadata source object. -
ViewLinkDef: string
Title:
View Link DefinitionMaximum Length:600The fully qualified name of the view link related to relationship.
Nested Schema : Attribute Properties
Type:
arrayTitle:
Attribute PropertiesThe attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties.
Show Source
Nested Schema : objectMetadata-childObjectMetadata-relationships-relationshipProperties-item-post-request
Type:
Show Source
object-
PropertyCode: string
Title:
Property NameMaximum Length:200The name of the property. -
PropertyGroup: string
Title:
Property GroupMaximum Length:30The name of the group to which the property belongs to. -
PropertyValue: string
Title:
Property ValueMaximum Length:4000The value of the property.
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 : objectMetadata-childObjectMetadata-relationships-item-response
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the relationship of the child object metadata record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the relationship of the child object metadata record was created. -
IntersectionObjectCode: string
Title:
Intersection Object CodeMaximum Length:128The language independent code of the intersection object, which uniquely identifies the object. -
IntersectionObjectDisplayName: string
Title:
Intersection ObjectRead Only:trueMaximum Length:255The display name of the intersection object. -
IntersectionSourceAttribute: string
Title:
Intersection Source AttributeMaximum Length:128The 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 NameMaximum Length:300The name of the View Link Accessor, which is between source object and intersection object. -
IntersectionTargetAttribute: string
Title:
Intersection Target AttributeMaximum Length:100The 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 NameMaximum Length:300The name of the View Link Accessor, which is between intersection object and target object. -
IsCustomRelationFlag: boolean
Title:
Custom RelationMaximum Length:1Default Value:falseIndicates whether the relationship is custom. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the child object metadata relationships record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the child object metadata relationships record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectCode: string
Title:
Source Object CodeMaximum Length:128The language independent code of the source object of the relation. -
RelationCode: string
Title:
Relation NameMaximum Length:500The language independent code of the relation which uniquely identifies the relation. -
RelationshipCardinality: string
Title:
Relationship CardinalityMaximum Length:30The cardinality of the relationship, such as OneToOne or ManyToMany. -
RelationshipDisplayName: string
Title:
Relationship Display NameMaximum Length:100The display name of the relationship. -
relationshipProperties: array
Attribute Properties
Title:
Attribute PropertiesThe attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties. -
RelationshipType: string
Title:
Relationship TypeMaximum Length:100The type of the relationship. -
SourceObjectAttributes: string
Title:
Source Object AttributesRead Only:trueThe attributes of the source object which is associated with the relationship. -
SourceObjectDisplayName: string
Title:
Source ObjectRead Only:trueMaximum Length:255The display name of the source object. -
SourceObjectVlaName: string
Title:
Source Object View Link Accessor NameMaximum Length:300The View Link Accessor name of the source object. -
TargetObjectAttributes: string
Title:
Target Object AttributesRead Only:trueThe attributes of the target object which is associated with the relationship. -
TargetObjectCode: string
Title:
Target Object CodeMaximum Length:128The language independent code of the target object, which uniquely identifies the object. -
TargetObjectDisplayName: string
Title:
Target ObjectRead Only:trueMaximum Length:255The display name of the target object. -
TargetObjectVlaName: string
Title:
Target Object View Link Accessor NameMaximum Length:300The View Link Accessor name of the child object metadata source object. -
ViewLinkDef: string
Title:
View Link DefinitionMaximum Length:600The fully qualified name of the view link related to relationship.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Attribute Properties
Type:
arrayTitle:
Attribute PropertiesThe 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 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 : objectMetadata-childObjectMetadata-relationships-relationshipProperties-item-response
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the attribute properties record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the attribute properties record was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the attribute properties record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the attribute properties record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PropertyCode: string
Title:
Property NameMaximum Length:200The name of the property. -
PropertyGroup: string
Title:
Property GroupMaximum Length:30The name of the group to which the property belongs to. -
PropertyValue: string
Title:
Property ValueMaximum Length:4000The value of the property.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- relationshipProperties
-
Parameters:
- ObjectCode:
$request.path.ObjectCode - ObjectCode2:
$request.path.ObjectCode2 - RelationCode2:
$request.path.RelationCode2
The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties. - ObjectCode: