Back to InsightlyGets A Custom Field By Name
This read only endpoint returns a custom field by name.
Input
type: object
properties:
parameters:
type: object
properties:
objectName:
type: string
description: The object name
fieldName:
type: string
description: The custom field name
required:
- objectName
- fieldName
title: Parameters
Output
type: object
title: CustomFieldMetadata
properties:
FIELD_NAME:
type: string
FIELD_ORDER:
format: int64
type: integer
FIELD_FOR:
maxLength: 12
minLength: 0
type: string
FIELD_LABEL:
maxLength: 255
minLength: 0
type: string
FIELD_TYPE:
maxLength: 20
minLength: 0
type: string
FIELD_HELP_TEXT:
maxLength: 1000
minLength: 0
type: string
DEFAULT_VALUE:
type: string
EDITABLE:
type: boolean
VISIBLE:
type: boolean
CUSTOM_FIELD_OPTIONS:
type: array
items:
type: object
title: CustomFieldOption
properties:
OPTION_ID:
format: int32
type: integer
OPTION_VALUE:
maxLength: 100
minLength: 0
type: string
OPTION_DEFAULT:
type: boolean
DEPENDENCY:
type: object
properties:
CONTROLLING_FIELD_ID:
type: string
OPTIONS_FILTERS:
type: array
items:
type: object
properties:
CONTROLLING_VALUE:
type: string
OPTION_IDS:
type: array
items:
format: int32
type: integer
JOIN_OBJECT:
type: string