GET api/CustomFields

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of CustomFieldsItemsDTO
NameDescriptionTypeAdditional information
ExternalId

string

None.

IternalName

string

None.

ExternalName

string

None.

Filterable

boolean

None.

Obligatory

boolean

None.

Deleted

boolean

None.

Items

Collection of ItemsDTO

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ExternalId": "sample string 1",
    "IternalName": "sample string 2",
    "ExternalName": "sample string 3",
    "Filterable": true,
    "Obligatory": true,
    "Deleted": true,
    "Items": [
      {
        "ExternalId": "sample string 1",
        "Name": "sample string 2",
        "Code": "sample string 3",
        "Deleted": true
      },
      {
        "ExternalId": "sample string 1",
        "Name": "sample string 2",
        "Code": "sample string 3",
        "Deleted": true
      }
    ]
  },
  {
    "ExternalId": "sample string 1",
    "IternalName": "sample string 2",
    "ExternalName": "sample string 3",
    "Filterable": true,
    "Obligatory": true,
    "Deleted": true,
    "Items": [
      {
        "ExternalId": "sample string 1",
        "Name": "sample string 2",
        "Code": "sample string 3",
        "Deleted": true
      },
      {
        "ExternalId": "sample string 1",
        "Name": "sample string 2",
        "Code": "sample string 3",
        "Deleted": true
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfCustomFieldsItemsDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Captio.Api.Dto">
  <CustomFieldsItemsDTO>
    <Deleted>true</Deleted>
    <ExternalId>sample string 1</ExternalId>
    <ExternalName>sample string 3</ExternalName>
    <Filterable>true</Filterable>
    <Items>
      <ItemsDTO>
        <Code>sample string 3</Code>
        <Deleted>true</Deleted>
        <ExternalId>sample string 1</ExternalId>
        <Name>sample string 2</Name>
      </ItemsDTO>
      <ItemsDTO>
        <Code>sample string 3</Code>
        <Deleted>true</Deleted>
        <ExternalId>sample string 1</ExternalId>
        <Name>sample string 2</Name>
      </ItemsDTO>
    </Items>
    <IternalName>sample string 2</IternalName>
    <Obligatory>true</Obligatory>
  </CustomFieldsItemsDTO>
  <CustomFieldsItemsDTO>
    <Deleted>true</Deleted>
    <ExternalId>sample string 1</ExternalId>
    <ExternalName>sample string 3</ExternalName>
    <Filterable>true</Filterable>
    <Items>
      <ItemsDTO>
        <Code>sample string 3</Code>
        <Deleted>true</Deleted>
        <ExternalId>sample string 1</ExternalId>
        <Name>sample string 2</Name>
      </ItemsDTO>
      <ItemsDTO>
        <Code>sample string 3</Code>
        <Deleted>true</Deleted>
        <ExternalId>sample string 1</ExternalId>
        <Name>sample string 2</Name>
      </ItemsDTO>
    </Items>
    <IternalName>sample string 2</IternalName>
    <Obligatory>true</Obligatory>
  </CustomFieldsItemsDTO>
</ArrayOfCustomFieldsItemsDTO>