PUT api/CustomField/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

CustomField
NameDescriptionTypeAdditional information
CustomFieldId

The unique id for the

integer

None.

ListId

The unique id of the the custom field is applied to

integer

None.

ItemId

The unique id of the the custom field belongs to

integer

None.

Title

The user friendly title (heading) for the custom field

string

None.

Value

The value applied to the custom field for the

string

None.

Request Formats

application/json, text/json

Sample:
{
  "customFieldId": 1,
  "listId": 2,
  "itemId": 3,
  "title": "sample string 4",
  "value": "sample string 5"
}

application/xml, text/xml

Sample:
<CustomField xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TScunts.Models.API.List">
  <CustomFieldId>1</CustomFieldId>
  <ItemId>3</ItemId>
  <ListId>2</ListId>
  <Title>sample string 4</Title>
  <Value>sample string 5</Value>
</CustomField>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GenericResourceResponse
NameDescriptionTypeAdditional information
Id

The unique id of the resource that is worked with

integer

None.

Success

True if successful

boolean

None.

ErrorMessage

Error message if the request is unsuccessful

string

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "success": true,
  "errorMessage": "sample string 3"
}

application/xml, text/xml

Sample:
<GenericResourceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TScunts.Models.API.List">
  <ErrorMessage>sample string 3</ErrorMessage>
  <Id>1</Id>
  <Success>true</Success>
</GenericResourceResponse>