Skip to main content
Skip table of contents

What API do I use to create/update a Field?

URL: /api/fields
Method: POST

Request Body Example:

Field API

JSON
[
{
  "name": "Field 1",
  "isactive": true,
  "datumtype": {
    "id": 1234
  }
}
]

Field

Type

Required

Description

name

string

Yes

Name of the field

isactive

bool

Yes

Indicates if the field is active

datumtype.id

number

Yes

ID referencing the associated datum type

Response:

JSON
{
  "success": true,
  "message": "Processed 5 items, Failed to process 0 items",
  "output": {
    "processedItems": [
      {
        "message": "record successfully created",
        "record": {
          "id": 123,
          "name": "Field 1",
          "effectivefrom": "2023-02-02 00:00:00",
          "effectiveto": "2050-02-02 00:00:00",
          "isactive": true,
          "createdby": 1234,
          "createdon": "2023-02-02 00:00:00",
          "modifiedby": 1234,
          "modifiedon": "2023-02-02 00:00:00",
          "code": null,
          "datumtypeid": 1234,
          "userstring1": null,
          "userstring2": null,
          "userstring3": null,
          "userstring4": null,
          "userstring5": null,
          "userinteger1": null,
          "userinteger2": null,
          "userinteger3": null,
          "userinteger4": null,
          "userinteger5": null,
          "userdecimal1": null,
          "userdecimal2": null,
          "userdecimal3": null,
          "userdecimal4": null,
          "userdecimal5": null,
          "userdatetime1": null,
          "userdatetime2": null,
          "userdatetime3": null,
          "userdatetime4": null,
          "userdatetime5": null
        }
      }
    ],
    "unProcessedItems": [
      {
        "message": "Batch execute error while creating and the error is - ...",
        "record": {}
      }
    ]
  }
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.