> For the complete documentation index, see [llms.txt](https://knowledgebase.fabricdata.com/xytech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.fabricdata.com/xytech/rest-api/custom-field-handling.md).

# Custom Field Handling

### Custom Fields

Any custom fields you have defined through document customization are automatically included in REST API definition. There is specific naming convention that is a combination of the Custom Code you created via document customisation plus the internal field name concatenated with an underscore. i.e. {customization code}\_{field name}

Document customization screen showing the user definable Customization Code&#x20;

<figure><img src="https://920260032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjO1LJ0JqjxT1HpQEykwt%2Fuploads%2FYxP78quTzBhk30kQkdN6%2Fimage.png?alt=media&amp;token=d530bbea-65f7-4a6b-9fdc-4619a8b832c0" alt=""><figcaption></figcaption></figure>

*Document customization screen showing the internal field names:*&#x20;

<figure><img src="https://920260032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjO1LJ0JqjxT1HpQEykwt%2Fuploads%2Ft3eoVXyH7TIEwSmLh4vw%2Fimage.png?alt=media&amp;token=5aca1c8f-eb55-492b-9c0b-647adc087b54" alt=""><figcaption></figcaption></figure>

Response from a GET call to fetch a Work Order that shows custom fields:&#x20;

<figure><img src="https://920260032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjO1LJ0JqjxT1HpQEykwt%2Fuploads%2FX5UqQs7CBgRzBKaQhoM0%2Fimage.png?alt=media&amp;token=26b1b414-20bb-401a-ab2b-bbb66854fca8" alt=""><figcaption></figcaption></figure>

### Custom drop-down fields with additional attributes

Users can enable **custom dropdown fields** (through enabling a document customisation flag 'Additional API details', so that when called by the REST API will return the additional attributes stored with the dropdown record such as external\_key.

Document Customisation fields showing additional checkbox:&#x20;

<figure><img src="https://920260032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjO1LJ0JqjxT1HpQEykwt%2Fuploads%2Fp8dIQZGR0P4HtNqi9Opm%2Fimage.png?alt=media&amp;token=beda8c49-e9b2-4ade-b6ac-d40dc327490d" alt=""><figcaption></figcaption></figure>

Example of a custom drop-down field when 'Additional API details' is not enabled:&#x20;

<figure><img src="https://920260032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjO1LJ0JqjxT1HpQEykwt%2Fuploads%2F4c7YLEZQlHQSPBHU1z9S%2Fimage.png?alt=media&amp;token=360e675a-685c-414d-a7ae-a2d4deef9fd8" alt=""><figcaption></figcaption></figure>

Example of a custom drop-down field when 'Additional API details' is enabled:&#x20;

<figure><img src="https://920260032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjO1LJ0JqjxT1HpQEykwt%2Fuploads%2F1yRNwLcWH6yBd3sz7q3w%2Fimage.png?alt=media&amp;token=a207dab0-2179-495c-8c3b-c5c6d834f039" alt=""><figcaption></figcaption></figure>
