HomeGuidesRecipesAPI ReferencePython SDK
Alation Help Center
API Reference
Alation Help Center
Start typing to search…

Get columns along with its custom fields

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

This API allows fetching of multiple columns along with its custom fields. The URL request length is limited to 1800 characters, including reserved characters that will be percent encoded.

Query Params
integer

filter by id of the object

string

filter by object name

integer

filter by table id

string

filter by table name

integer

filter by schema id

integer

Unique identifier of the data source

string

Ordering of objects by id and name

array of objects

filter objects by custom fields. Currently we can only filter by a single custom field. The example below shows only {}, please add array braces [] around the {} object for it work properly. eg: To list objects which have user id 1 as a steward is [{"field_id":8,"value":[{"otype": "user", "oid":1}]}]. Note: Use the appropritate data structure for the value.

custom_fields
integer
Defaults to 100

Specifies the number of objects to be fetched in one paginated request. Response may have a X-Next-Page URL parameter in the header to fetch next set of objects or page

integer
Defaults to 0

Specifies the number of objects to be skipped in one request. Used together with Limit parameter to fetch paginated requests. This is automatically set in X-Next-Page response header if present

string

Specifies a comma-separated list of fields to be included in the response. When provided, the API will return only the specified set of fields for each object in the response. If not supplied, the API will return all fields by default.

string

Specifies a comma-separated list of fields to be included in the response. When provided, the API will return only the specified set of fields for each object in the response. If not supplied, the API will return all fields by default.

integer

filter by id greater than a value

integer

filter by id greater than or equal to a value

integer

filter by id lesser than a value

integer

filter by id lesser than or equal to a value

string

filter by object name case insensitive exact match

string

filter by object name containing the given string

string

filter by object name containing the given string, case insensitive match

string

filter by object name starting with the given string

string

filter by object name starting with the given string, case insensitive match

string

filter by object name ending with the given string

string

filter by object name ending with the given string, case insensitive match

integer

filter by table id greater than a value

integer

filter by table id greater than or equal to a value

integer

filter by table id lesser than a value

integer

filter by table id lesser than or equal to a value

string

filter by table name case insensitive exact match

string

filter by table name containing the given string

string

filter by table name containing the given string, case insensitive match

string

filter by table name starting with the given string

string

filter by table name starting with the given string, case insensitive match

string

filter by table name ending with the given string

string

filter by table name ending with the given string, case insensitive match

integer

filter by schema id greater than a value

integer

filter by schema id greater than or equal to a value

integer

filter by schema id lesser than a value

integer

filter by schema id lesser than or equal to a value

integer

filter by data source id greater than a value

integer

filter by data source id greater than or equal to a value

integer

filter by data source id lesser than a value

integer

filter by data source id lesser than or equal to a value

Responses

Updated 27 days ago

Did this page help you?
Language
Credentials
URL
Choose an example:
application/json

Updated 27 days ago

Did this page help you?