POST api/ArticleCustomFields

Creates a new article custom field.

Request Information

URI Parameters

None.

Body Parameters

ArticleCustomFieldPostRequest
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": "8f03671a-3180-4e1d-a7a4-30abec8f2bc9",
  "CustomFieldTemplateId": 2,
  "Value": "sample string 3"
}

application/xml, text/xml

Sample: 
<ArticleCustomFieldPostRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Article">
  <ArticleId>8f03671a-3180-4e1d-a7a4-30abec8f2bc9</ArticleId>
  <CustomFieldTemplateId>2</CustomFieldTemplateId>
  <Value>sample string 3</Value>
</ArticleCustomFieldPostRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ArticleCustomFieldPostResponse
NameDescriptionTypeAdditional information
Errors

Collection of ArticleCustomFieldPostError

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: 
<ArticleCustomFieldPostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Article">
  <Errors>
    <ArticleCustomFieldPostError>
      <ErrorCode>InternalServerError</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </ArticleCustomFieldPostError>
    <ArticleCustomFieldPostError>
      <ErrorCode>InternalServerError</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </ArticleCustomFieldPostError>
  </Errors>
  <Success>true</Success>
</ArticleCustomFieldPostResponse>