PUT api/ArticleCustomFields

Updates an existing article custom field.

Request Information

URI Parameters

None.

Body Parameters

ArticleCustomFieldPutRequest
NameDescriptionTypeAdditional information
ArticleId

globally unique identifier

Required
CustomFieldTemplateId

integer

Required
Value

string

None.

Remarks

None.

Example

None.

Request Formats

application/json, text/json

Sample: 
{
  "ArticleId": "de882e64-0174-4402-80e8-687b02978a30",
  "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>de882e64-0174-4402-80e8-687b02978a30</ArticleId>
  <CustomFieldTemplateId>2</CustomFieldTemplateId>
  <Value>sample string 3</Value>
</ArticleCustomFieldPutRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ArticleCustomFieldPutResponse
NameDescriptionTypeAdditional information
Errors

Collection of ArticleCustomFieldPutError

None.
Success

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>