Create a field definition for an object

post

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

Path Params

objectName

string

required

Body Params

Actual field metadata input which needs to be created

FieldName

string | null

DisplayName

string | null

Description

string | null

DataType

string

enum

DefaultValue

string | null

IsRequired

boolean

IsSortable

boolean

IsUnique

boolean

IsIndexField

boolean

LookupObjectName

string | null

LookupFilterCriteria

string | null

PicklistName

string | null

DependentPicklistMetadataName

string | null

ComplexMetadataName

string | null

AutoNumberInitialSeed

int32

AutoNumberPrefix

string | null

Precision

int32

Scale

int32

IsCalculated

boolean

Expression

string | null

IsPreComputed

boolean | null

Length

int32 | null

ReferenceObject

string | null

TargetObject

string | null

TargetField

string | null

RollupFunction

string | null

RollupFilterCriteria

string | null

IsRichTextField

boolean

IdentifierType

string

enum

Allowed:

AliasFieldDefinition

string | null

Responses

400

Bad Request

404

Not Found

500

Internal Server Error

Language

Credentials

Bearer

JWT

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created