GET {clientId}/Config/CustomProperties

Retrieve all Custom Properties.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

Your required clientId used to access the WebAPI. A 404 is returned if this value is invalid.

 string

Required

Body Parameters

None.

Response Information

Response Codes

  • Unauthorized (401)
  • InternalServerError (500)

Resource Description

Collection of ConfigCustomProperty
NameDescriptionTypeAdditional information
Link

integer

None.
OverwriteExisting

boolean

None.
Key

string

Required

Min length: 1
Value

string

Required

Min length: 1

Response Formats

application/json, text/json

Sample: 
[
  {
    "Link": 1,
    "OverwriteExisting": true,
    "Key": "sample string 3",
    "Value": "sample string 4"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfConfigCustomProperty xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.ConfigModels">
  <ConfigCustomProperty>
    <Key>sample string 3</Key>
    <Value>sample string 4</Value>
    <Link>1</Link>
    <OverwriteExisting>true</OverwriteExisting>
  </ConfigCustomProperty>
</ArrayOfConfigCustomProperty>