POST api/app/customfields/upsert

This allows app developers to store custom values against an entity Processes this app API request. The parameter and response sections describe the data exchanged with the API.

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

Name	Description	Type	Additional information
GroupName	The group name value.	string	None.
AppliesToSystemName	The applies to system name value.	string	None.
EntityId	The unique identifier of the related entity resource.	integer	None.
Fields	The collection of fields.	Collection of UpsertCustomFieldValueDataContract	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

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": {}
    }
  ]
}

Response Information

Resource Description

a list of the custom fields and their values

Collection of CustomFieldValueDataContract

Name	Description	Type	Additional information
Type	The type value.	EnumDataContract	None.
Name	The name value.	string	None.
Value	The value represented by this field.	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": {}
  }
]