POST api/app/metadata/upsert

This allows app developers to store custom metadata 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

{ "AppliesToSystemName" :"PropertySalesRole", "EntityId" :14790, "Values":[ {"Name":"meta1","Value":"value of meta 1"}, {"Name":"meta2","Value":"value of meta 2"} ]}

UpsertMetaDataCommandDataContract

Name	Description	Type	Additional information
AppliesToSystemName	The applies to system name value.	string	None.
EntityId	The unique identifier of the related entity resource.	integer	None.
Values	The collection of values.	Collection of UpsertMetaDataValue	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "AppliesToSystemName": "sample string 1",
  "EntityId": 2,
  "Values": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ]
}

Response Information

Resource Description

the values as dictionary of names and values

Collection of Pair of string [key] and string [value]

Response Formats

application/json, text/json

Sample:

[
  {
    "Key": "sample string 1",
    "Value": "sample string 2"
  },
  {
    "Key": "sample string 1",
    "Value": "sample string 2"
  }
]