GET api/ArticleCustomFields/Templates

Gets all custom field templates for the article module.

Request Information

URI Parameters

None.

Body Parameters

None.

Remarks

None.

Example

None.

Response Information

Resource Description

Collection of ArticleCustomFieldTemplateResponse
NameDescriptionTypeAdditional information
Id

Identifier of the template.

integer

None.

Name

Name of the template field.

string

None.

IsNumeric

Flag deciding if to only allow numbers.

boolean

None.

AllowedNumberOfCharacters

How many characters the value are allowed to be.

integer

None.

IsRequired

Flag deciding if a value is required.

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "Name": "sample string 2",
    "IsNumeric": true,
    "AllowedNumberOfCharacters": 4,
    "IsRequired": true
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "IsNumeric": true,
    "AllowedNumberOfCharacters": 4,
    "IsRequired": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfArticleCustomFieldTemplateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Article">
  <ArticleCustomFieldTemplateResponse>
    <AllowedNumberOfCharacters>4</AllowedNumberOfCharacters>
    <Id>1</Id>
    <IsNumeric>true</IsNumeric>
    <IsRequired>true</IsRequired>
    <Name>sample string 2</Name>
  </ArticleCustomFieldTemplateResponse>
  <ArticleCustomFieldTemplateResponse>
    <AllowedNumberOfCharacters>4</AllowedNumberOfCharacters>
    <Id>1</Id>
    <IsNumeric>true</IsNumeric>
    <IsRequired>true</IsRequired>
    <Name>sample string 2</Name>
  </ArticleCustomFieldTemplateResponse>
</ArrayOfArticleCustomFieldTemplateResponse>