Update a child object metadata
patch
/crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}
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:
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
attributes: array
Attributes
Title:
Attributes
The attributes resource is used to view, create, update, and delete attributes. It represents attribute specific properties defined in the object definition. -
childObjectMetadata: array
Child Object Metadata
Title:
Child Object Metadata
The child object metadata resource is used to view, create, update, and delete child object metadata. It represents object hierarchy and can be used to navigate to child object specific relations and attributes. -
ObjectCode(required): string
Title:
Object Name
Maximum Length:128
The language independent code of an child object metadata object, which uniquely identifies the object. -
objectProperties: 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. -
ParentObjectCode(required): string
Title:
Parent Object
Maximum Length:128
The language independent code of the parent object which uniquely identifies the parent object. -
relationships: array
Relationships
Title:
Relationships
The relationships resource is used to view, create, update, and delete a relationship. It represents relationships defined on all objects.
Nested Schema : Attributes
Type:
array
Title:
Attributes
The attributes resource is used to view, create, update, and delete attributes. It represents attribute specific properties defined in the object definition.
Show Source
Nested Schema : Child Object Metadata
Type:
array
Title:
Child Object Metadata
The child object metadata resource is used to view, create, update, and delete child object metadata. It represents object hierarchy and can be used to navigate to child object specific relations and attributes.
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 : Relationships
Type:
array
Title:
Relationships
The relationships resource is used to view, create, update, and delete a relationship. It represents relationships defined on all objects.
Show Source
Nested Schema : objectMetadata-childObjectMetadata-attributes-item-patch-request
Type:
Show Source
object
-
AliasName: string
Title:
Alias Name
Maximum Length:300
The alias name of the corresponding attribute under ObjectMetadata. -
AttrColumn: string
Title:
Column Name
Maximum Length:30
The column of the attribute. -
AttributeCode: string
Title:
Attribute Name
Maximum Length:100
The name of the attribute. -
AttributeDefType: string
Title:
Control Type
Maximum Length:50
The control type of an attribute. -
attributeProperties: 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. -
AttributeTable: string
Title:
Attribute Table Name
Maximum Length:30
The table associated with the attribute. -
AttributeType: string
Title:
Type
Maximum Length:30
The type of the attribute. -
AttrLength: number
Title:
Length
The length of the attribute. -
AttrPrecision: number
Title:
Attribute Precision
The precision of the attribute. -
AttrScale: number
Title:
Attribute Scale
The scale of the attribute. -
ColumnType: string
Title:
Column Type
Maximum Length:30
The column type of the attribute. -
DefaultValue: string
Title:
Default Value
Maximum Length:4000
The default value of the attribute. -
DependsOn: string
Title:
Depends On
Maximum Length:800
The attribute which is used to save the attribute dependencies for the object. -
EntityUsage: string
Title:
Entity Usage
Maximum Length:600
The entity usage of the corresponding attribute under ObjectMetadata. -
IsCustomFlag: boolean
Title:
Custom Attribute
Maximum Length:1
Default Value:false
Indicates whether the attribute is custom. -
IsUpdatableFlag: boolean
Title:
Updatable
Maximum Length:1
Default Value:true
Indicates whether the attribute is updatable. -
LabelResourceId: string
Title:
Label Resource ID
Maximum Length:700
The resource identifier of the label of the attribute. -
MandatoryFlag: boolean
Title:
Required
Maximum Length:1
Default Value:false
Indicates whether the attribute is mandatory. -
TransientFlag: boolean
Title:
Transient Flag
Maximum Length:1
Default Value:false
Indicates whether the attribute is transient attribute or not.
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 : objectMetadata-childObjectMetadata-attributes-attributeProperties-item-patch-request
Type:
Show Source
object
-
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 : schema
Type:
Show Source
object
-
ObjectCode: string
Title:
Object Name
Maximum Length:128
The language independent code of an child object metadata object, which uniquely identifies the object. -
ParentObjectCode: string
Title:
Parent Object
Maximum Length:128
The language independent code of the parent object which uniquely identifies the parent object.
Nested Schema : objectMetadata-childObjectMetadata-objectProperties-item-patch-request
Type:
Show Source
object
-
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 : objectMetadata-childObjectMetadata-relationships-item-patch-request
Type:
Show Source
object
-
IntersectionObjectCode: string
Title:
Intersection Object Code
Maximum Length:128
The language independent code of the intersection object, which uniquely identifies the 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. -
ObjectCode(required): string
Title:
Source Object Code
Maximum Length:128
The language independent code of the source object of the relation. -
RelationCode(required): string
Title:
Relation Name
Maximum Length:500
The language independent code of the relation which uniquely identifies the relation. -
RelationshipCardinality(required): 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(required): string
Title:
Relationship Type
Maximum Length:100
The type of the relationship. -
SourceObjectVlaName: string
Title:
Source Object View Link Accessor Name
Maximum Length:300
The View Link Accessor name of the source object. -
TargetObjectCode(required): string
Title:
Target Object Code
Maximum Length:128
The language independent code of the target object, which uniquely identifies the 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 : 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 : objectMetadata-childObjectMetadata-relationships-relationshipProperties-item-patch-request
Type:
Show Source
object
-
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.
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-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. -
attributes: array
Attributes
Title:
Attributes
The attributes resource is used to view, create, update, and delete attributes. It represents attribute specific properties defined in the object definition. -
childObjectMetadata: array
Child Object Metadata
Title:
Child Object Metadata
The child object metadata resource is used to view, create, update, and delete child object metadata. It represents object hierarchy and can be used to navigate to child object specific relations and attributes. -
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. -
objectProperties: 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. -
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. -
relationships: array
Relationships
Title:
Relationships
The relationships resource is used to view, create, update, and delete a relationship. It represents relationships defined on all objects. -
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 : Attributes
Type:
array
Title:
Attributes
The attributes resource is used to view, create, update, and delete attributes. It represents attribute specific properties defined in the object definition.
Show Source
Nested Schema : Child Object Metadata
Type:
array
Title:
Child Object Metadata
The child object metadata resource is used to view, create, update, and delete child object metadata. It represents object hierarchy and can be used to navigate to child object specific relations and attributes.
Show Source
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 : Relationships
Type:
array
Title:
Relationships
The relationships resource is used to view, create, update, and delete a relationship. It represents relationships defined on all objects.
Show Source
Nested Schema : objectMetadata-childObjectMetadata-attributes-item-response
Type:
Show Source
object
-
AliasName: string
Title:
Alias Name
Maximum Length:300
The alias name of the corresponding attribute under ObjectMetadata. -
AttrColumn: string
Title:
Column Name
Maximum Length:30
The column of the attribute. -
AttributeCode: string
Title:
Attribute Name
Maximum Length:100
The name of the attribute. -
AttributeDefType: string
Title:
Control Type
Maximum Length:50
The control type of an attribute. -
attributeProperties: 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. -
AttributeTable: string
Title:
Attribute Table Name
Maximum Length:30
The table associated with the attribute. -
AttributeType: string
Title:
Type
Maximum Length:30
The type of the attribute. -
AttrLength: number
Title:
Length
The length of the attribute. -
AttrPrecision: number
Title:
Attribute Precision
The precision of the attribute. -
AttrScale: number
Title:
Attribute Scale
The scale of the attribute. -
ColumnType: string
Title:
Column Type
Maximum Length:30
The column type of the attribute. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the attributes record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the attributes record was created. -
DefaultValue: string
Title:
Default Value
Maximum Length:4000
The default value of the attribute. -
DependsOn: string
Title:
Depends On
Maximum Length:800
The attribute which is used to save the attribute dependencies for the object. -
Description: string
Title:
Description
Read Only:true
The description of the attribute. -
DescriptionResourceId: string
Title:
Description Resource ID
Read Only:true
The resource identifier of the description of the attribute. -
DisplayName: string
Title:
Display Name
Read Only:true
The display name of the attribute. -
EntityUsage: string
Title:
Entity Usage
Maximum Length:600
The entity usage of the corresponding attribute under ObjectMetadata. -
IsCustomFlag: boolean
Title:
Custom Attribute
Maximum Length:1
Default Value:false
Indicates whether the attribute is custom. -
IsQueryableFlag: boolean
Title:
Searchable
Read Only:true
Indicates whether the attribute can be queried. -
IsSQLDerivedExprFlag: boolean
Title:
SQL Derived Expression Flag
Read Only:true
Maximum Length:255
Indicates whether the attribute is derived from SQL expression. -
IsUpdatableFlag: boolean
Title:
Updatable
Maximum Length:1
Default Value:true
Indicates whether the attribute is updatable. -
LabelResourceId: string
Title:
Label Resource ID
Maximum Length:700
The resource identifier of the label of the attribute. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the attributes record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the attributes record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
Required
Maximum Length:1
Default Value:false
Indicates whether the attribute is mandatory. -
TableName: string
Title:
Object Table Name
Read Only:true
The table name of the attribute. -
TransientFlag: boolean
Title:
Transient Flag
Maximum Length:1
Default Value:false
Indicates whether the attribute is transient attribute or not.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : objectMetadata-childObjectMetadata-attributes-attributeProperties-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
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-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 : objectMetadata-childObjectMetadata-objectProperties-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
Nested Schema : objectMetadata-childObjectMetadata-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 : objectMetadata-childObjectMetadata-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
- attributes
-
Parameters:
- ObjectCode:
$request.path.ObjectCode
- ObjectCode2:
$request.path.ObjectCode2
The attributes resource is used to view, create, update, and delete attributes. It represents attribute specific properties defined in the object definition. - ObjectCode:
- childObjectMetadata
-
Parameters:
- ObjectCode:
$request.path.ObjectCode
- ObjectCode2:
$request.path.ObjectCode2
The child object metadata resource is used to view, create, update, and delete child object metadata. It represents object hierarchy and can be used to navigate to child object specific relations and attributes. - ObjectCode:
- objectProperties
-
Parameters:
- ObjectCode:
$request.path.ObjectCode
- ObjectCode2:
$request.path.ObjectCode2
The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties. - ObjectCode:
- relationships
-
Parameters:
- ObjectCode:
$request.path.ObjectCode
- ObjectCode2:
$request.path.ObjectCode2
The relationships resource is used to view, create, update, and delete a relationship. It represents relationships defined on all objects. - ObjectCode: