# Save Fields

Save Fields

Endpoint: POST /rest/2.0/ENTITY_FIELD
Version: 1.0
Security: JWT

## Header parameters:

  - `sessionId` (string, required)

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

  - `brmObjects` (object)

  - `brmObjects.AttributeColumnFlag` (string)
    AttributeColumnFlag

  - `brmObjects.DataLength` (string)
    Data Length

  - `brmObjects.DataType` (string)
    Data Type

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

  - `brmObjects.EntityId` (integer, required)
    EntityId

  - `brmObjects.ExternalKey` (string, required)
    ExternalKey

  - `brmObjects.FieldName` (string, required)
    Field Name

  - `brmObjects.FunctionBasedField` (string)
    FunctionBasedField

  - `brmObjects.FunctionBasedFunction` (string)
    FunctionBasedFunction

  - `brmObjects.HiddenFlag` (string)
    HiddenFlag

  - `brmObjects.Id` (string, required)
    Id: ENTITY_FIELD_ID

  - `brmObjects.IgnoreOnEdit` (string)
    IgnoreOnEdit

  - `brmObjects.ModifyFuncName` (string)
    ModifyFuncName

  - `brmObjects.PkSequenceName` (string)
    PkSequenceName

  - `brmObjects.PrimaryKeyFlag` (string)
    PrimaryKeyFlag

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

  - `brmObjects.ReferencedEntityId` (integer)
    ReferencedEntityId

  - `brmObjects.RequiredFlag` (integer)
    Required

  - `brmObjects.RestrictCreate` (string)
    RestrictCreate

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

  - `brmObjects.Status` (string)
    Status

  - `brmObjects.SystemFlag` (integer)
    System Field

  - `brmObjects.UniqueField` (integer)
    Unique Value

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

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

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

  - `brmObjects.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.

  - `brmObjects.HelpLanguageCode` (string)
    Help Language

  - `brmObjects.ExternalKeyFlag` (integer)
    External Key

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

  - `brmObjects.DisplayAfter` (string)
    Display Below

  - `brmObjects.FieldLabel` (string)
    Display Label

  - `brmObjects.LabelId` (string)
    LabelId

  - `brmObjects.DisplayType` (string)
    DisplayType

  - `brmObjects.FormulaValue` (string)
    Formula Value

  - `brmObjects.ShortHelpLabelId` (string)
    ShortHelpLabelId

  - `brmObjects.LongHelpLabelId` (string)
    LongHelpLabelId

  - `brmObjects.LookupFieldName` (string)
    LookupFieldName

  - `brmObjects.ApiAccessableFlag` (integer)
    ApiAccessableFlag

  - `brmObjects.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.

  - `brmObjects.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.

  - `brmObjects.OnDelete` (string)
    On Delete

  - `brmObjects.DisplayView` (string)
    DisplayView

  - `brmObjects.RelatedEntityId` (integer)
    RelatedEntityId

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

  - `brmObjects.DisplayNew` (string)
    DisplayNew

  - `brmObjects.DisplayUpdate` (string)
    DisplayUpdate

  - `brmObjects.LoopFlag` (integer)
    Loop Field

  - `brmObjects.Guid` (string)
    Guid

  - `brmObjects.WebFormItemId` (string)
    WebFormItemId

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

  - `brmObjects.RelatedWebFormId` (integer)
    RelatedWebFormId

  - `brmObjects.ConditionGroupId` (string)
    ConditionGroupId

  - `brmObjects.CurrencySource` (string, required)
    Currency Source: Specify a reference to any currency lookup field, the currency set on that attribute determines the currency of this field

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

  - `brmObjects.RelatedListFilterLogic` (string)
    Filter Logic

  - `brmObjects.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

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

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

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

  - `brmObjects.ViewRelationshipField` (string)
    ViewRelationshipField

  - `brmObjects.CurrencyDate` (string)
    Currency Date: Set the date to be used for currency conversions.

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

  - `brmObjects.DefaultValue` (string)
    DefaultValue

  - `brmObjects.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

  - `brmObjects.SequenceStartingNumber` (string, required)
    Starting Number: This is the starting number in the sequence. It will be assigned to the first record created after adding this field.

  - `brmObjects.SequenceIncrementBy` (string)
    Increment by: This number defines the increment step for the sequence. Leaving this field blank means applying the default step of 1.

  - `brmObjects.SequenceNumberOfDigits` (string)
    Number of Digits: Defines the total number of digits in the sequence. This is useful if the generated number should have a constant number of digits padded with leading zeros. For example, if Number of Digits is 6 the sequence values would be 000001, 000002, etc. Leaving this field blank means no leading zeros.

  - `brmObjects.SequencePrefix` (string)
    Prefix: Defines the value to be displayed in front of the number part of the sequence. Note: static values should be enclosed within single quotation marks, for example: 'Invoice'

  - `brmObjects.SequenceSuffix` (string)
    Suffix: Defines the value to be displayed after the number part of the sequence. Note: static values should be enclosed within single quotation marks, for example: 'Invoice'

  - `brmObjects.SequenceRuleCriteria` (string)
    Filter Criteria: Specifies the method to determine if the record should have the sequence generated. Choose whether to use the filter criteria or a formula. If the filter is specified, the new record should satisfy it to have the sequence value generated. Filtered out records will have sequence field left blank.

  - `brmObjects.SequenceFormula` (string)
    Formula: Enter the formula that when evaluated to true will cause the sequence value to be generated for the new record.

  - `brmObjects.SequenceFilterLogic` (string)
    Criteria Join Logic: Use this to define the logical grouping of your filter criteria. The ordered list of Filters defined above can be segregated to more narrowly define the filter as a whole. So let`s say you have three filters, use this field to define a meaning across the three references. For example: (1 AND 2 ) OR 3. Use parentheses as well as AND and OR operators to define the filter logic.

  - `brmObjects.SystemGeneratedFlag` (string)
    SystemGeneratedFlag

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

  - `brmObjects.BaseEntityId` (integer)
    Base Entity

## Response 200 fields (application/json):

  - `retrieveResponse` (object)

  - `retrieveResponse.AttributeColumnFlag` (string)
    AttributeColumnFlag

  - `retrieveResponse.DataLength` (string)
    Data Length

  - `retrieveResponse.DataType` (string)
    Data Type

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

  - `retrieveResponse.EntityId` (integer)
    EntityId

  - `retrieveResponse.ExternalKey` (string)
    ExternalKey

  - `retrieveResponse.FieldName` (string)
    Field Name

  - `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.ReferencedColumn` (string)
    Referenced Column Name

  - `retrieveResponse.ReferencedEntityId` (integer)
    ReferencedEntityId

  - `retrieveResponse.RequiredFlag` (integer)
    Required

  - `retrieveResponse.RestrictCreate` (string)
    RestrictCreate

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

  - `retrieveResponse.Status` (string)
    Status

  - `retrieveResponse.SystemFlag` (integer)
    System Field

  - `retrieveResponse.UniqueField` (integer)
    Unique Value

  - `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.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.HelpLanguageCode` (string)
    Help Language

  - `retrieveResponse.ExternalKeyFlag` (integer)
    External Key

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

  - `retrieveResponse.DisplayAfter` (string)
    Display Below

  - `retrieveResponse.FieldLabel` (string)
    Display Label

  - `retrieveResponse.LabelId` (string)
    LabelId

  - `retrieveResponse.DisplayType` (string)
    DisplayType

  - `retrieveResponse.FormulaValue` (string)
    Formula Value

  - `retrieveResponse.ShortHelpLabelId` (string)
    ShortHelpLabelId

  - `retrieveResponse.LongHelpLabelId` (string)
    LongHelpLabelId

  - `retrieveResponse.LookupFieldName` (string)
    LookupFieldName

  - `retrieveResponse.ApiAccessableFlag` (integer)
    ApiAccessableFlag

  - `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.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.OnDelete` (string)
    On Delete

  - `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.LoopFlag` (integer)
    Loop Field

  - `retrieveResponse.Guid` (string)
    Guid

  - `retrieveResponse.WebFormItemId` (string)
    WebFormItemId

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

  - `retrieveResponse.RelatedWebFormId` (integer)
    RelatedWebFormId

  - `retrieveResponse.ConditionGroupId` (string)
    ConditionGroupId

  - `retrieveResponse.CurrencySource` (string)
    Currency Source: Specify a reference to any currency lookup field, the currency set on that attribute determines the currency of this field

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

  - `retrieveResponse.RelatedListFilterLogic` (string)
    Filter Logic

  - `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.ApiHiddenFlag` (integer)
    ApiHiddenFlag: Hidden Flag

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

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

  - `retrieveResponse.ViewRelationshipField` (string)
    ViewRelationshipField

  - `retrieveResponse.CurrencyDate` (string)
    Currency Date: Set the date to be used for currency conversions.

  - `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.DefaultValue` (string)
    DefaultValue

  - `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.SequenceStartingNumber` (string)
    Starting Number: This is the starting number in the sequence. It will be assigned to the first record created after adding this field.

  - `retrieveResponse.SequenceIncrementBy` (string)
    Increment by: This number defines the increment step for the sequence. Leaving this field blank means applying the default step of 1.

  - `retrieveResponse.SequenceNumberOfDigits` (string)
    Number of Digits: Defines the total number of digits in the sequence. This is useful if the generated number should have a constant number of digits padded with leading zeros. For example, if Number of Digits is 6 the sequence values would be 000001, 000002, etc. Leaving this field blank means no leading zeros.

  - `retrieveResponse.SequencePrefix` (string)
    Prefix: Defines the value to be displayed in front of the number part of the sequence. Note: static values should be enclosed within single quotation marks, for example: 'Invoice'

  - `retrieveResponse.SequenceSuffix` (string)
    Suffix: Defines the value to be displayed after the number part of the sequence. Note: static values should be enclosed within single quotation marks, for example: 'Invoice'

  - `retrieveResponse.SequenceRuleCriteria` (string)
    Filter Criteria: Specifies the method to determine if the record should have the sequence generated. Choose whether to use the filter criteria or a formula. If the filter is specified, the new record should satisfy it to have the sequence value generated. Filtered out records will have sequence field left blank.

  - `retrieveResponse.SequenceFormula` (string)
    Formula: Enter the formula that when evaluated to true will cause the sequence value to be generated for the new record.

  - `retrieveResponse.SequenceFilterLogic` (string)
    Criteria Join Logic: Use this to define the logical grouping of your filter criteria. The ordered list of Filters defined above can be segregated to more narrowly define the filter as a whole. So let`s say you have three filters, use this field to define a meaning across the three references. For example: (1 AND 2 ) OR 3. Use parentheses as well as AND and OR operators to define the filter logic.

  - `retrieveResponse.SystemGeneratedFlag` (string)
    SystemGeneratedFlag

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

  - `retrieveResponse.BaseEntityId` (integer)
    Base Entity

## 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