Create a field definition for an object

post

https://rls.congacloud.com/api/schema/v1/objects/{objectName}/fields

Validates and creates a field inside the specified object.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

objectName

string

required

Name of the object in which the field is to be created

Body Params

Actual field metadata input which needs to be created

FieldName

string | null

Name of the field. You can enter up to 58 characters.

DisplayName

string | null

Display name of the field

Description

string | null

Description of the field

DataType

string

enum

DefaultValue

string | null

Default value of the field

IsRequired

boolean

Indicates if the field is required.

IsSortable

boolean

Indicates if the field is sortable.

IsUnique

boolean

Indicates if the field is unique.

IsIndexField

boolean

Indicates if the field is indexed.

LookupObjectName

string | null

Lookup object name of the field

LookupFilterCriteria

string | null

Lookup filter criteria for UI

PicklistName

string | null

Picklist name of the field

DependentPicklistMetadataName

string | null

Dependent picklist metadata name of the field

ComplexMetadataName

string | null

Complex metadata name of the field

AutoNumberInitialSeed

int32

AutoNumber initial seed value of the field

AutoNumberPrefix

string | null

AutoNumber initial seed prefix of the field

Precision

int32

Precision of the field when the data type is Currency, Decimal, or Double.

Scale

int32

Scale of the field when the data type is Currency, Decimal, or Double.

IsCalculated

boolean

Indicates if the field is calculated.

Expression

string | null

Describes the expression of the formula field

IsPreComputed

boolean | null

Indicates if Formula expression is pre-computed or not

Length

int32 | null

Length of the field when the data type is String or LongString.

ReferenceObject

string | null

Reference object of the field

TargetObject

string | null

Target object of the field

TargetField

string | null

Target field of the field

RollupFunction

string | null

Rollup function of the field

RollupFilterCriteria

string | null

Rollup filter criteria of the field

IsRichTextField

boolean

Indicates if the field is RichText.

IdentifierType

string

enum

Allowed:

AliasFieldDefinition

string | null

Definition of the alias field

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

400

Bad Request

404

Not Found

500

Internal Server Error

201Created