Update Record Custom Tables

Updates the custom table for the specified record.

Resource Information

Scoperecords

Deprecated scope name:   update_record_customtables

App TypeAll
Authorization TypeAccess token
URI /v4/records/{recordId}/customTables?lang={lang}
HTTP MethodPUT
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
fieldsstringNo Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored.7.3.2
langStringNo Indicates the language applied.7.3.2
recordIdstringYes Get All Records Search Records Get My Records The unique ID associated with a record.7.3.2
[]arrayYes Array containing the custom table(s).7.3.2
idstringYes The unique identifier for the custom table to be modified or added.7.3.2
rows[]rows{}Yes Contains the table rows.7.3.2
rows.actionstringYesadd | update | delete Specifies whether to add, update, or delete the custom table row.7.3.2
rows.fieldsrows.fields{}Yes Contains fields and their attributes. Required only if adding or modifying a row.7.3.2
rows.fields.<customType>stringYes A custom field name and value pair. For example in JSON, "My Custom Field": "My Custom Value". The custom field name and its data type are defined in Automation custom forms or custom tables.
  • For a Text field, the maximum length is 256.
  • For a Number field, any numeric form is allowed, including negative numbers.
  • For a Date field, the format is MM/dd/yyyy.
  • For a Time field, the format is hh:mm.
  • For a TextArea field, the maximum length is 4000 characters, and allows line return characters.
  • For a DropdownList field, the dropdown list values are in the options[] array.
  • For a CheckBox field, the (case-sensitive) valid values are "UNCHECKED" and "CHECKED".
  • For a Radio(Y/N) field, the(case-sensitive) valid values are "Yes" and "No".
7.3.2
rows.idstringYes The unique identifier for the custom field. Required only if modifying or deleting a row.7.3.2

Example

Sample Request Head

PUT https://apis.accela.com/v4/records/15CAP-00000-00014/customTables

Sample Request Body

[
  {
    "id": "LIC_CON_LIC-HOURS.cOF.cOPERATION"
  },
  {
    "id": "LIC_CON_LIC-BOND.cINFORMATION",
    "rows": [
      {
        "id": "2",
        "fields": {
          "Bond Expiration Date": "2015-02-11",
          "Bond Effective Date": "2015-02-09",
          "Bond Number": "234",
          "Bond Status": "Inactive",
          "Bond Type": "Secondary",
          "Bonding Company Name": "456",
          "Bond Amount": "12",
          "Bond Comments": "Speeling"
        },
        "action": "update"
      },
      {
        "id": "1",
        "fields": {
          "Bond Expiration Date": "2015-02-10",
          "Bond Effective Date": "2015-02-02",
          "Bond Number": "123",
          "Bond Status": "Active",
          "Bond Type": "Surety",
          "Bonding Company Name": "123",
          "Bond Amount": "321",
          "Bond Comments": "Comments"
        },
        "action": "update"
      }
    ]
  }
]

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.2
result.codestringA code identifying an associated item7.3.2
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.isSuccessbooleanIndicates whether or not the operation on the item is successful. 7.3.2
result.messagestringA text message related to the operation.7.3.2
statusintegerThe record status.7.3.2

Example

Sample Response Body

{
  "status": 200,
  "result": [
    {
      "id": "LIC_CON_LIC-HOURS.cOF.cOPERATION",
      "isSuccess": true
    },
    {
      "id": "LIC_CON_LIC-BOND.cINFORMATION",
      "isSuccess": true
    }
  ]
}