PUT api/ArticleCustomFields

Updates an existing article custom field.

Request Information

URI Parameters

None.

Body Parameters

ArticleCustomFieldPutRequest
NameDescriptionTypeAdditional information
ArticleId

Id of the article.

 globally unique identifier

Required
CustomFieldTemplateId

Id of the custom field template.

 integer

Required
Value

The value to be updated.

 string

None.

Remarks

None.

Example

None.

Request Formats

application/json, text/json

Sample: 
{
  "ArticleId": "d96105f0-ee2c-4f82-8c93-0a5fb3eb35cc",
  "CustomFieldTemplateId": 2,
  "Value": "sample string 3"
}

application/xml, text/xml

Sample: 
<ArticleCustomFieldPutRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Article">
  <ArticleId>d96105f0-ee2c-4f82-8c93-0a5fb3eb35cc</ArticleId>
  <CustomFieldTemplateId>2</CustomFieldTemplateId>
  <Value>sample string 3</Value>
</ArticleCustomFieldPutRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ArticleCustomFieldPutRequest'.

Response Information

Resource Description

ArticleCustomFieldPutResponse
NameDescriptionTypeAdditional information
Errors

List of errors when updaring an article custom field

 Collection of ArticleCustomFieldPutError

None.
Success

Returns true if article custom field is added

 boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "Errors": [
    {
      "ErrorCode": 1,
      "ErrorMessage": "sample string 1"
    },
    {
      "ErrorCode": 1,
      "ErrorMessage": "sample string 1"
    }
  ],
  "Success": true
}

application/xml, text/xml

Sample: 
<ArticleCustomFieldPutResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Article">
  <Errors>
    <ArticleCustomFieldPutError>
      <ErrorCode>InternalServerError</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </ArticleCustomFieldPutError>
    <ArticleCustomFieldPutError>
      <ErrorCode>InternalServerError</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </ArticleCustomFieldPutError>
  </Errors>
  <Success>true</Success>
</ArticleCustomFieldPutResponse>