Get a child object metadata
get
/crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/childObjectMetadata/{ObjectCode3}
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=
-
ObjectCode3(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-childObjectMetadata-childObjectMetadata-item-response
Type:
Show Source
object
-
AlternateKeys: string
Title:
Alternate Keys
Read Only:true
The alternate key of the child object metadata. -
APPStripe: string
Title:
Application Stripe
Read Only:true
Maximum Length:80
It specifies the application name of the child object. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the child object metadata record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the child object metadata record was created. -
Description: string
Title:
Description
Read Only:true
The description of the child object metadata. -
DescriptionResourceId: string
Title:
Description Resource ID
Read Only:true
The resource identifier of the description of the object. -
DisplayName: string
Title:
Display Name
Read Only:true
The display name of the child object metadata. -
DisplayNamePlural: string
Title:
Plural Title
Read Only:true
The display name of child object in plural form of the child object metadata. -
ExtensibleViewDefinition: string
Title:
Extensible View Definition
Read Only:true
Maximum Length:600
The extensible view definition of the child object. -
IsCustomFlag: boolean
Title:
Custom Object
Read Only:true
Maximum Length:1
Default Value:false
Indicates whether the child object metadata is custom. -
IsExtensible: string
Title:
Is Extensible
Read Only:true
Indicates whether the child object is extensible. -
KeyAttributes: string
Title:
User Keys
Read Only:true
The key attributes of the child object metadata. -
LabelResourceId: string
Title:
Label Resource ID
Read Only:true
Maximum Length:700
The resource identifier of the label of the object. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the child object metadata 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 record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectCode: string
Title:
Object Name
Maximum Length:128
The language independent code of an child object metadata object, which uniquely identifies the object. -
ObjectDefinition: string
Title:
Object Definition
Read Only:true
Maximum Length:600
The fully qualified VO name for the child object metadata object. -
ParentObjectCode: string
Title:
Parent Object
Maximum Length:128
The language independent code of the parent object which uniquely identifies the parent object. -
PluralLabelResourceId: string
Title:
Plural Label Resource ID
Read Only:true
Maximum Length:700
The resource identifier of the name in plural form of the child object. -
PrimaryEntityDefinition: string
Title:
Primary Entity Definition
Read Only:true
Maximum Length:600
The primary entity definition of the object under ChildObjectMetadata. -
PuidAttribute: string
Title:
Primary Alternate Key
Read Only:true
Maximum Length:100
The PUID of the child object metadata object. -
RestResource: string
Title:
REST Resource Code
Read Only:true
Maximum Length:100
The rest resource name of the child object metadata object. -
RestResourceIdentifier: string
Title:
REST Resource Identifier
Read Only:true
Maximum Length:100
The unique identifier of the child object metadata rest resource. -
UcmAccount: string
Title:
Account
Read Only:true
Maximum Length:120
The UCM account of the child object metadata object.
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.