Bulk Read Custom Fields

get {protocol}://{base-url}/integration/v2/custom_field/

This endpoint can be used to list all the active Custom Fields. Deleted Custom Fields are ignored.

Query Params

allow_multiple

boolean

Defaults to false

Filter by allow_multiple. Only used when field_type is OBJECT_SET.

field_type

string

Filter by field_type.

integer

≥ 1

Filter by Custom Field ID. Multiple IDs can be specified using the format ?id=3&id=4.

limit

integer

≥ 1

Defaults to 100

The number of items to return.

name_plural

string

length ≤ 255

Filter by an exact match on name_plural.

name_plural__contains

string

length ≤ 255

Filter by a case-sensitive substring on name_plural.

name_plural__icontains

string

length ≤ 255

Filter by a case-insensitive substring on name_plural.

name_singular

string

length ≤ 255

Filter by an exact match on name_singular.

name_singular__contains

string

length ≤ 255

Filter by a case-sensitive substring on name_singular.

name_singular__icontains

string

length ≤ 255

Filter by a case-insensitive subsring on name_singular.

skip

integer

Defaults to 0

The number of items to skip.

order_by

string

Sort by a specified property:

field_type - Ordering: TEXT, DATE, PICKER, OBJECT_SET, RICH_TEXT, MULTI_PICKER
-field_type - Ordering: MULTI_PICKER, RICH_TEXT, OBJECT_SET, PICKER, DATE, TEXT
id - Ascending by id
-id - Descending by id
name_plural - A to Z, by name_plural
-name_plural - Z to A, by name_plural
name_singular - A to Z, by name_singular
-name_singular - Z to A, by name_singular

tooltip_text

string

length ≤ 255

tooltip_text__contains

string

length ≤ 255

tooltip_text__icontains

string

length ≤ 255

values

string

A comma-separated sub-set of properties to select for each item.

Responses

Response body

array of objects

object

allow_multiple

boolean

Defaults to false

Used only when field_type is OBJECT_SET (Object Set, People Set, or Reference Field). 'false' means the Field is a Reference Field, while 'true' means the Field is either Object Set or People Set. Defaults to 'false' if not specified.

allowed_otypes

array of strings | null

Defaults to null

Required and used only when field_type is OBJECT_SET (Object Set, People Set, or Reference Field). Indicates what object types are allowed as values for this field. People Set Fields have allowed_otypes set exactly to ['user', 'groupprofile']. Valid values are any of the following strings: 'data' (Data Source), 'schema' (Schema), 'table' (Table), 'attribute' (Column), 'user' (User), 'groupprofile' (Group), 'article' (Article), 'glossary_term' (Term), 'business_policy' (Policy). When specifying 'user' or 'groupprofile', both must be specified (the User option in Customize Catalog corresponds to both). When specifying 'business_policy', the 'Enable Policy Center' feature must first be enabled in Feature Configuration. When specifying 'glossary_term', the 'Glossary Terms GA' feature must first be enabled in Feature Configuration.

allowed_otypes

backref_name

string

length ≤ 255

The text shown as the title for a Custom Field Backreference on an Object Set, People Set, or Reference Field. Required when field_type is set to OBJECT_SET.

backref_tooltip_text

string

length ≤ 255

builtin_name

string

A special, read-only string value used to uniquely identify built-in Custom Fields provided by Alation.

field_type

string

The type of Custom Field, one of DATE, MULTI_PICKER, OBJECT_SET, PICKER, or RICH_TEXT. People Set Fields use OBJECT_SET together with allowed_otypes. Reference Fields use OBJECT_SET together with allow_multiple. Cannot be changed after creation. See "CustomFieldBulkCreate" for examples.

DATE MULTI_PICKER OBJECT_SET PICKER RICH_TEXT

integer

≥ 1

The read-only unique ID of the Custom Field.

name_plural

string

length ≤ 255

The plural name for the Custom Field. Required when field_type is set to MULTI_PICKER, or when field_type is set to OBJECT_SET and allow_multiple is set to 'true' (Object Set and People Set Fields only; Reference Fields do not use this).

name_singular

string

length ≤ 255

The singular name for the Custom Field. Always required.

options

array of strings

Defaults to

Required and used only when the field_type is PICKER or MULTI_PICKER. Provides a list of string values for the available options that can be selected with these fields.

options

tooltip_text

string

length ≤ 255

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://alation_domain/integration/v2/custom_field/?allow_multiple=false&limit=100&skip=0' \
3
     --header 'accept: application/json'

Choose an example:

application/json

200Requested Custom Fields

400Malformed Request

401Unauthorized bad/missing token

403Forbidden User cannot edit this resource

404The specified resource was not found

500Internal Server Error