POST api/app/customfields/upsert

This allows app developers to store custom values against an entity

Request Information

URI Parameters

None.

Body Parameters

{ "GroupName" :"What3Words", "AppliesToSystemName" :"PropertySalesRole", "EntityId" :14790, "Fields":[{ "TypeSystemName" :"string", "ControlTypeSystemName" :"textbox", "Name" :"Back Gate", "Validator" :null, "Options" :[], "Value" :"///takes.flashing.dustbins" } }

UpsertCustomGroupFieldValuesCommandDataContract
NameDescriptionTypeAdditional information
GroupName

string

None.

AppliesToSystemName

string

None.

EntityId

integer

None.

Fields

Collection of UpsertCustomFieldValueDataContract

None.

Request Formats

application/json, text/json

Sample:
{
  "GroupName": "sample string 1",
  "AppliesToSystemName": "sample string 2",
  "EntityId": 3,
  "Fields": [
    {
      "TypeSystemName": "sample string 1",
      "ControlTypeSystemName": "sample string 2",
      "Name": "sample string 3",
      "Validator": "sample string 4",
      "Options": [
        "sample string 1",
        "sample string 2"
      ],
      "Value": {}
    },
    {
      "TypeSystemName": "sample string 1",
      "ControlTypeSystemName": "sample string 2",
      "Name": "sample string 3",
      "Validator": "sample string 4",
      "Options": [
        "sample string 1",
        "sample string 2"
      ],
      "Value": {}
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

a list of the custom fields and their values

Collection of CustomFieldValueDataContract
NameDescriptionTypeAdditional information
Type

EnumDataContract

None.

Name

string

None.

Value

Object

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Type": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Name": "sample string 1",
    "Value": {}
  },
  {
    "Type": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Name": "sample string 1",
    "Value": {}
  }
]