Create an attribute
post
/crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/attributes
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-
AliasName: string
Title:
Alias NameMaximum Length:300The alias name of the corresponding attribute under ObjectMetadata. -
AttrColumn: string
Title:
Column NameMaximum Length:30The column of the attribute. -
AttributeCode(required): string
Title:
Attribute NameMaximum Length:100The name of the attribute. -
AttributeDefType: string
Title:
Control TypeMaximum Length:50The control type of an attribute. -
attributeProperties: array
Attribute Properties
Title:
Attribute PropertiesThe attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties. -
AttributeTable: string
Title:
Attribute Table NameMaximum Length:30The table associated with the attribute. -
AttributeType(required): string
Title:
TypeMaximum Length:30The type of the attribute. -
AttrLength(required): number
Title:
LengthThe length of the attribute. -
AttrPrecision: number
Title:
Attribute PrecisionThe precision of the attribute. -
AttrScale: number
Title:
Attribute ScaleThe scale of the attribute. -
ColumnType: string
Title:
Column TypeMaximum Length:30The column type of the attribute. -
DefaultValue: string
Title:
Default ValueMaximum Length:4000The default value of the attribute. -
DependsOn: string
Title:
Depends OnMaximum Length:800The attribute which is used to save the attribute dependencies for the object. -
EntityUsage: string
Title:
Entity UsageMaximum Length:600The entity usage of the corresponding attribute under ObjectMetadata. -
IsCustomFlag: boolean
Title:
Custom AttributeMaximum Length:1Default Value:falseIndicates whether the attribute is custom. -
IsUpdatableFlag: boolean
Title:
UpdatableMaximum Length:1Default Value:trueIndicates whether the attribute is updatable. -
LabelResourceId: string
Title:
Label Resource IDMaximum Length:700The resource identifier of the label of the attribute. -
MandatoryFlag: boolean
Title:
RequiredMaximum Length:1Default Value:falseIndicates whether the attribute is mandatory. -
TransientFlag: boolean
Title:
Transient FlagMaximum Length:1Default Value:falseIndicates whether the attribute is transient attribute or not.
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-attributes-attributeProperties-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-attributes-item-response
Type:
Show Source
object-
AliasName: string
Title:
Alias NameMaximum Length:300The alias name of the corresponding attribute under ObjectMetadata. -
AttrColumn: string
Title:
Column NameMaximum Length:30The column of the attribute. -
AttributeCode: string
Title:
Attribute NameMaximum Length:100The name of the attribute. -
AttributeDefType: string
Title:
Control TypeMaximum Length:50The control type of an attribute. -
attributeProperties: array
Attribute Properties
Title:
Attribute PropertiesThe attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties. -
AttributeTable: string
Title:
Attribute Table NameMaximum Length:30The table associated with the attribute. -
AttributeType: string
Title:
TypeMaximum Length:30The type of the attribute. -
AttrLength: number
Title:
LengthThe length of the attribute. -
AttrPrecision: number
Title:
Attribute PrecisionThe precision of the attribute. -
AttrScale: number
Title:
Attribute ScaleThe scale of the attribute. -
ColumnType: string
Title:
Column TypeMaximum Length:30The column type of the attribute. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the attributes record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the attributes record was created. -
DefaultValue: string
Title:
Default ValueMaximum Length:4000The default value of the attribute. -
DependsOn: string
Title:
Depends OnMaximum Length:800The attribute which is used to save the attribute dependencies for the object. -
Description: string
Title:
DescriptionRead Only:trueThe description of the attribute. -
DescriptionResourceId: string
Title:
Description Resource IDRead Only:trueThe resource identifier of the description of the attribute. -
DisplayName: string
Title:
Display NameRead Only:trueThe display name of the attribute. -
EntityUsage: string
Title:
Entity UsageMaximum Length:600The entity usage of the corresponding attribute under ObjectMetadata. -
IsCustomFlag: boolean
Title:
Custom AttributeMaximum Length:1Default Value:falseIndicates whether the attribute is custom. -
IsQueryableFlag: boolean
Title:
SearchableRead Only:trueIndicates whether the attribute can be queried. -
IsSQLDerivedExprFlag: boolean
Title:
SQL Derived Expression FlagRead Only:trueMaximum Length:255Indicates whether the attribute is derived from SQL expression. -
IsUpdatableFlag: boolean
Title:
UpdatableMaximum Length:1Default Value:trueIndicates whether the attribute is updatable. -
LabelResourceId: string
Title:
Label Resource IDMaximum Length:700The resource identifier of the label of the attribute. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the attributes record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the attributes record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
RequiredMaximum Length:1Default Value:falseIndicates whether the attribute is mandatory. -
TableName: string
Title:
Object Table NameRead Only:trueThe table name of the attribute. -
TransientFlag: boolean
Title:
Transient FlagMaximum Length:1Default Value:falseIndicates whether the attribute is transient attribute or not.
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 : Links
Type:
arrayTitle:
LinksThe 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 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
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.
Links
- attributeProperties
-
Parameters:
- AttributeCode2:
$request.path.AttributeCode2 - 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. - AttributeCode2: