HomeGuidesRecipesAPI ReferencePython SDK
Alation Help Center
API Reference

Adds the requested objects to a domain.

This API lets you add multiple alation catalog objects to a domain, at once. For recursive additions, the request allows a maximum of 99 objects at a time. If the count of requested objects is lesser than 1000, then it runs synchronously, otherwise asynchronously. The limit is configurable under property alation.domains.bulk_membership.sync_job_max_batch_size.

Body Params
integer
required

Domain id, to which objects will be added.

boolean

Should it unassign objects from the domain? (By default, it's false. i.e. it will assign the objects to the domain.)

boolean

When enabled, will automatically include children of the specified objects as members of the domain. When recursive is set to true, children of the specified objects will automatically be included as members of the domain. Available for the following object types: data (data sources), schema, table, article, bi_server, bi_folder, bi_report, bi_datasource, and glossary_v3 (glossaries).
When adding or excluding recursively, try to avoid applying redundant or overlapping domain assignments, as it may cause additional load and delays in applying domain membership assignments. For example, if a schema and its children are already assigned to a domain, recursively assigning that same domain to the schema's parent data source creates redundant assignments for the schema. Recursive membership assignment is best used when targeting isolated and unconnected sets of objects, for example multiple independent schemas or multiple articles that are not part of the same child tree.

array of integers
required

List of object IDs to be assigned to the domain. When recursive is set to true, the oid array can contain a maximum of 99 object IDs.

oid*
string
required

otype of the Catalog Objects

Responses

Language
Credentials
URL
Choose an example:
application/json