Create an attribute
post
/crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/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=
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.
-
Upsert-Mode:
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 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(required): 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(required): string
Title:
Type
Maximum Length:30
The type of the attribute. -
AttrLength(required): 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 : schema
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-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-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.
Links
- attributeProperties
-
Parameters:
- AttributeCode:
$request.path.AttributeCode
- ObjectCode:
$request.path.ObjectCode
The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties. - AttributeCode: