Skip to main content

Nested fields

Nested fields are fields that contain other fields. For example, some NOÉ objects have a customFields field, which stores all the object's custom field values :

{
  "id": "1234567890",
  "name": "My object",
  ...
  "customFields": {
    "field1": "customValue1",
    "field2": "customValue2"
  }
}

Partial modification​

Sometimes, you only want to modify one value of a nested field. For example, you may only want to modify the field1 value of customFields, and leave the rest of the fields unchanged. To do this, you can chain the nested fields together with a dot . :

Modification request​

{
  "id": "1234567890",
  "name": "My modified object",
  ...
  "customFields.field1": "customValue1Modified",
  "customFields.field3": "customValue3New"
}

Result​

{
  "id": "1234567890",
  "name": "My modified object",
  ...
  "customFields": {
    "field1": "customValue1Modified",
    "field2": "customValue2",
    "field3": "customValue3New"
  }
}
Delete a field

To delete a field, simply submit the value null :

{
  "id": "1234567890",
  "name": "My modified object",
  ...
  "customFields.field1": null
}

Total modification​

If, on the other hand, you want to completely replace the customFields field, you can do so by submitting an object directly:

Modification request​

{
  "id": "1234567890",
  "name": "My modified object",
  ...
  "customFields": {
    "field3": "customValue3"
  }
}

Result​

{
  "id": "1234567890",
  "name": "My modified object",
  ...
  "customFields": {
    "field3": "customValue3"
  }
}