Jump to

• Request
• Response

Get all relationships

get

/crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/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=

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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds a relationship with the specified primary key.
    Finder Variables
  • RelationCodeFinder The Language Independent Code of the relation which uniquely identifies the relation.
    Finder Variables
    • RelationCode; string; The language independent code of the relationship.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • CreatedBy; string; The user who created the relationship of the child object metadata record.
  • CreationDate; string; The date when the relationship of the child object metadata record was created.
  • IntersectionObjectCode; string; The language independent code of the intersection object, which uniquely identifies the object.
  • IntersectionObjectDisplayName; string; The display name of the intersection object.
  • IntersectionSourceAttribute; string; The attribute of the intersection object which is associated with the relationship between source object and intersection object.
  • IntersectionSrcVlaName; string; The name of the View Link Accessor, which is between source object and intersection object.
  • IntersectionTargetAttribute; string; The attribute of the intersection object which is associated with the relationship between intersection object and target object.
  • IntersectionTrgtVlaName; string; The name of the View Link Accessor, which is between intersection object and target object.
  • IsCustomRelationFlag; boolean; Indicates whether the relationship is custom.
  • LastUpdateDate; string; The date when the child object metadata relationships record was last updated.
  • LastUpdatedBy; string; The user who last updated the child object metadata relationships record.
  • ObjectCode; string; The language independent code of the source object of the relation.
  • RelationCode; string; The language independent code of the relation which uniquely identifies the relation.
  • RelationshipCardinality; string; The cardinality of the relationship, such as OneToOne or ManyToMany.
  • RelationshipDisplayName; string; The display name of the relationship.
  • RelationshipType; string; The type of the relationship.
  • SourceObjectAttributes; string; The attributes of the source object which is associated with the relationship.
  • SourceObjectDisplayName; string; The display name of the source object.
  • SourceObjectVlaName; string; The View Link Accessor name of the source object.
  • TargetObjectAttributes; string; The attributes of the target object which is associated with the relationship.
  • TargetObjectCode; string; The language independent code of the target object, which uniquely identifies the object.
  • TargetObjectDisplayName; string; The display name of the target object.
  • TargetObjectVlaName; string; The View Link Accessor name of the child object metadata source object.
  • ViewLinkDef; string; The fully qualified name of the view link related to relationship.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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 Top

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.

Body ()

Root Schema : objectMetadata-relationships

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/objectMetadata-relationships-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object objectMetadata-relationships-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/objectMetadata-relationships-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : objectMetadata-relationships-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "IsCustomRelationFlag":{
            "title":"Custom Relation",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the relationship is custom.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "SourceObjectAttributes":{
            "title":"Source Object Attributes",
            "type":"string",
            "description":"The attributes of the source object which is associated with the relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the relationship of the child object metadata record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IntersectionSrcVlaName":{
            "title":"Intersection Source View Link Accessor Name",
            "maxLength":"300",
            "type":"string",
            "description":"The name of the View Link Accessor, which is between source object and intersection object.",
            "nullable":true,
            "x-queryable":true
        },
        "ViewLinkDef":{
            "title":"View Link Definition",
            "maxLength":"600",
            "type":"string",
            "description":"The fully qualified name of the view link related to relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":"100",
            "type":"string",
            "description":"The type of the relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectCode":{
            "title":"Source Object Code",
            "maxLength":"128",
            "type":"string",
            "description":"The language independent code of the source object of the relation.",
            "nullable":false,
            "x-queryable":true
        },
        "TargetObjectCode":{
            "title":"Target Object Code",
            "maxLength":"128",
            "type":"string",
            "description":"The language independent code of the target object, which uniquely identifies the object.",
            "nullable":false,
            "x-queryable":true
        },
        "IntersectionTrgtVlaName":{
            "title":"Intersection Target View Link Accessor Name",
            "maxLength":"300",
            "type":"string",
            "description":"The name of the View Link Accessor, which is between intersection object and target object.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TargetObjectAttributes":{
            "title":"Target Object Attributes",
            "type":"string",
            "description":"The attributes of the target object which is associated with the relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipCardinality":{
            "title":"Relationship Cardinality",
            "maxLength":"30",
            "type":"string",
            "description":"The cardinality of the relationship, such as OneToOne or ManyToMany.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the child object metadata relationships record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetObjectDisplayName":{
            "title":"Target Object",
            "maxLength":"255",
            "type":"string",
            "description":"The display name of the target object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipDisplayName":{
            "title":"Relationship Display Name",
            "maxLength":"100",
            "type":"string",
            "description":"The display name of the relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the relationship of the child object metadata record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "relationshipProperties":{
            "title":"Attribute Properties",
            "type":"array",
            "description":"The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties.",
            "items":{
                "$ref":"#/components/schemas/objectMetadata-relationships-relationshipProperties-item-response"
            }
        },
        "IntersectionObjectDisplayName":{
            "title":"Intersection Object",
            "maxLength":"255",
            "type":"string",
            "description":"The display name of the intersection object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetObjectVlaName":{
            "title":"Target Object View Link Accessor Name",
            "maxLength":"300",
            "type":"string",
            "description":"The View Link Accessor name of the child object metadata source object.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectDisplayName":{
            "title":"Source Object",
            "maxLength":"255",
            "type":"string",
            "description":"The display name of the source object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntersectionObjectCode":{
            "title":"Intersection Object Code",
            "maxLength":"128",
            "type":"string",
            "description":"The language independent code of the intersection object, which uniquely identifies the object.",
            "nullable":true,
            "x-queryable":true
        },
        "IntersectionTargetAttribute":{
            "title":"Intersection Target Attribute",
            "maxLength":"100",
            "type":"string",
            "description":"The attribute of the intersection object which is associated with the relationship between intersection object and target object.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationCode":{
            "title":"Relation Name",
            "maxLength":"500",
            "type":"string",
            "description":"The language independent code of the relation which uniquely identifies the relation.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceObjectVlaName":{
            "title":"Source Object View Link Accessor Name",
            "maxLength":"300",
            "type":"string",
            "description":"The View Link Accessor name of the source object.",
            "nullable":true,
            "x-queryable":true
        },
        "IntersectionSourceAttribute":{
            "title":"Intersection Source Attribute",
            "maxLength":"128",
            "type":"string",
            "description":"The attribute of the intersection object which is associated with the relationship between source object and intersection object.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the child object metadata relationships record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object objectMetadata-relationships-relationshipProperties-item-response

{
    "title":"Attribute Properties",
    "type":"array",
    "description":"The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties.",
    "items":{
        "$ref":"#/components/schemas/objectMetadata-relationships-relationshipProperties-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : objectMetadata-relationships-relationshipProperties-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the attribute properties record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the attribute properties record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the attribute properties record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyGroup":{
            "title":"Property Group",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the group to which the property belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyValue":{
            "title":"Property Value",
            "maxLength":"4000",
            "type":"string",
            "description":"The value of the property.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PropertyCode":{
            "title":"Property Name",
            "maxLength":"200",
            "type":"string",
            "description":"The name of the property.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the attribute properties record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top