HomeGuidesRecipesAPI ReferencePython SDK
Alation Help Center
API Reference

GET multiple Custom Field Values

This API is used to list all the active Custom Field Values.

Query Params
array of strings

The object type(s) with the Custom Field Value as a string. To specify more than one type, use ampersand (&) to denote additional types.

i.e. "otype=dataflow&otype=bi_server" will match either dataflow OR bi_server. For Catalog Set Shared Fields, use "propagated_catalog_set". For Catalog Set itself, use "dynamic_set_property".

otype
array of strings

The object id of the specified object with a Custom Field Value. Can be an integer, or string representation of an UUID. To specify more than one oid, use ampersand (&) to denote additional oids.

i.e. "oid=1&oid=5" will match oids of 1 OR 5.

oid
array of integers

The id of the specified Custom Field as an integer. Can be an integer or string; to specify multiple, use ampersand(&) to denote more than one id.

Note - Since title and description fields are not supported for RDBMS objects, field_id 3 and field_id 4 shouldn't be used for following otypes - data, schema, table, attribute.

field_id
integer
≥ 1
Defaults to 100

The number of items to return.

integer
Defaults to 0

The number of items to skip.

string

A filter parameter for specific attributes to be passed back in the returned Custom Field Values. Formatted as a comma separated list without spaces.

Available values - otype,oid,field_id,ts_updated,value

Responses

Language
Credentials
URL
Choose an example:
application/json