# Delete Fields

Delete Fields

Endpoint: DELETE /rest/2.0/delete/ENTITY_FIELD
Version: 1.0
Security: JWT

## Header parameters:

  - `sessionId` (string, required)

## Request fields (application/json; charset=utf-8):

  - `brmObjects` (object)

  - `brmObjects.Id` (string, required)

## Response 200 fields (application/json):

  - `retrieveResponse` (object)

  - `retrieveResponse.DataType` (string)
    Data Type

  - `retrieveResponse.FieldName` (string)
    Field Name

  - `retrieveResponse.InstantTypeAheadSearch` (integer)
    Instant Type Ahead Search

  - `retrieveResponse.EncryptedFlag` (integer)
    Encrypted: Data in this field will be encrypted by the customer managed encryption key.

  - `retrieveResponse.LoopFlag` (integer)
    Loop Field

  - `retrieveResponse.SystemFlag` (integer)
    System Field

  - `retrieveResponse.Status` (string)
    Status

  - `retrieveResponse.RelatedListRecrdsPerPage` (string)
    Records Per Page: This indicates the number of records that are displayed on the related list field per page before having to click the list page navigation buttons.

  - `retrieveResponse.OnDelete` (string)
    On Delete

  - `retrieveResponse.RestrictChangeInClosedAP` (integer)
    Restrict changes in closed accounting periods: Accounting Period

  - `retrieveResponse.ReactComponentFlag` (integer)
    Widget Support: Check this option to activate enhanced RelatedList and enable list widgets inside. Widgets can be added by layout configuration page.

  - `retrieveResponse.HelpContentLong` (string)
    Long Help Content: Add a more detailed description that displays for user when hovering over  next to this field. More advanced formatting is permitted here.

  - `retrieveResponse.RelatedListFilterLogic` (string)
    Filter Logic

  - `retrieveResponse.DisplayAfter` (string)
    Display Below

  - `retrieveResponse.Description` (string)
    Description: Description1

  - `retrieveResponse.RequiredFlag` (integer)
    Required

  - `retrieveResponse.DataLength` (string)
    Data Length

  - `retrieveResponse.ExternalKeyFlag` (integer)
    External Key

  - `retrieveResponse.SearchableFlag` (integer)
    Create Searchable Index

  - `retrieveResponse.CurrencyDate` (string)
    Currency Date

  - `retrieveResponse.FieldLabel` (string)
    Display Label

  - `retrieveResponse.HelpContentShort` (string)
    Short Help Content: First line of help that displays when user hovers over  next to field.

  - `retrieveResponse.BaseEntityId` (integer)
    Base Entity

  - `retrieveResponse.UniqueField` (integer)
    Unique Value

  - `retrieveResponse.RelationPath` (string)
    Relation Path: This indicates the field on the child entity that will be used to relate it to the parent entity record. When this is left blank, it will be automatically populated by the Id field of the child entity.

  - `retrieveResponse.ReferencedColumn` (string)
    Referenced Column Name

  - `retrieveResponse.FormulaValue` (string)
    Formula Value

  - `retrieveResponse.HelpLanguageCode` (string)
    Help Language

  - `retrieveResponse.CurrencySource` (string)
    Currency Source

  - `retrieveResponse.PIIFlag` (integer)
    Personally Identifiable Information: To enable compliance with subscriber`s right to be forgotten, set to 1 for fields with personally identifiable information. These fields will be obfuscated in the audit history log when owning record is deleted

  - `retrieveResponse.CrosslinkFlag` (integer)
    Display as Cross-link: When this flag is 'Active', then list layouts will use HYPERLINK mode to display this field. It can be used to navigate to related objects. This value can be overriden by layout-level flag

  - `retrieveResponse.ViewRelationshipField` (string)
    ViewRelationshipField

  - `retrieveResponse.ApiAccessableFlag` (integer)
    ApiAccessableFlag

  - `retrieveResponse.AttributeColumnFlag` (string)
    AttributeColumnFlag

  - `retrieveResponse.EntityId` (integer)
    EntityId

  - `retrieveResponse.ExternalKey` (string)
    ExternalKey

  - `retrieveResponse.FunctionBasedField` (string)
    FunctionBasedField

  - `retrieveResponse.FunctionBasedFunction` (string)
    FunctionBasedFunction

  - `retrieveResponse.HiddenFlag` (string)
    HiddenFlag

  - `retrieveResponse.Id` (string)
    Id: ENTITY_FIELD_ID

  - `retrieveResponse.IgnoreOnEdit` (string)
    IgnoreOnEdit

  - `retrieveResponse.ModifyFuncName` (string)
    ModifyFuncName

  - `retrieveResponse.PkSequenceName` (string)
    PkSequenceName

  - `retrieveResponse.PrimaryKeyFlag` (string)
    PrimaryKeyFlag

  - `retrieveResponse.ReferencedEntityId` (integer)
    ReferencedEntityId

  - `retrieveResponse.RestrictCreate` (string)
    RestrictCreate

  - `retrieveResponse.Created` (string)
    System controlled field: Date and time the record was created

  - `retrieveResponse.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `retrieveResponse.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `retrieveResponse.LabelId` (string)
    LabelId

  - `retrieveResponse.DisplayType` (string)
    DisplayType

  - `retrieveResponse.ShortHelpLabelId` (string)
    ShortHelpLabelId

  - `retrieveResponse.LongHelpLabelId` (string)
    LongHelpLabelId

  - `retrieveResponse.LookupFieldName` (string)
    LookupFieldName

  - `retrieveResponse.DisplayView` (string)
    DisplayView

  - `retrieveResponse.RelatedEntityId` (integer)
    RelatedEntityId

  - `retrieveResponse.PricingAttributeId` (integer)
    PricingAttributeId: PricingAttributeId Related Entity Field Id

  - `retrieveResponse.DisplayNew` (string)
    DisplayNew

  - `retrieveResponse.DisplayUpdate` (string)
    DisplayUpdate

  - `retrieveResponse.Guid` (string)
    Guid

  - `retrieveResponse.WebFormItemId` (string)
    WebFormItemId

  - `retrieveResponse.ItemPosition` (string)
    ItemPosition: Item Positiond

  - `retrieveResponse.RelatedWebFormId` (integer)
    RelatedWebFormId

  - `retrieveResponse.ConditionGroupId` (string)
    ConditionGroupId

  - `retrieveResponse.ApiHiddenFlag` (integer)
    ApiHiddenFlag: Hidden Flag

  - `retrieveResponse.DefaultValue` (string)
    DefaultValue

  - `retrieveResponse.SystemGeneratedFlag` (string)
    SystemGeneratedFlag

  - `retrieveResponse.Updated` (string)
    System controlled field: Date and time the record was last updated

## Response 400 fields (application/json):

  - `error` (string)
    Bad request

  - `message` (string)
    Bad request

## Response 401 fields (application/json):

  - `error` (string)
    Unauthorized

  - `message` (string)
    Unauthorized

## Response 404 fields (application/json):

  - `error` (string)
    Not found

  - `message` (string)
    Not found

## Response 429 fields (application/json):

  - `error` (string)
    Too many requests

  - `message` (string)
    Too many requests

## Response 500 fields (application/json):

  - `error` (string)
    Internal error

  - `message` (string)
    Internal error