total is 0 is the
one the web app badges as unused.
For an integration the answer covers its synced data tables and quotas, the
same two kinds the web app’s own dependencies dialog lists. It does not cover
the users, user attributes and groups an HRIS connection syncs, which
disconnecting would unsync too. So a total of 0 on an integration is not on
its own a verdict that disconnecting it is safe.
One call returns every dependent — there is no pagination and no cap, because a
partial impact analysis is worse than none. counts_by_type rolls the same rows
up per nature so you can read the shape of the impact at a glance, and a total
of 0 means nothing references the resource, so changing or deleting it breaks
nothing.
Dependents are reported in full even when you could not open one yourself:
withholding one would read as “nothing uses this”, which is the wrong conclusion
to act on. Each dependent carries only its id and name, never its contents.
Permissions
Reading a resource’s dependents needs full read access to that kind of resource — a resource merely shared with you does not admit you, since the question exists to be asked before changing or deleting it. The tool is visible as soon as your role can read any of the seven resource types, but each call is checked against the permission theresource_type argument selects: you can
only analyze the kinds you may read. Analyzing an integration needs read
access to company settings’ integrations. Analyzing a report additionally
requires the reporting feature to be enabled for your company. This tool is
read-only: it says what would break and changes nothing.
Parameters
Body
Body
string
required
What kind of resource
resource_id names. One of: quota, data_table,
group, group_dimension, plan, report, integration. Each kind is
read under its own permission, so you can analyze only the kinds you may
read.string
required
Id of the resource to analyze — the id the matching list tool returns
(list_quotas, list_data_tables, list_groups, list_group_dimensions,
list_plans, list_reports, list_integrations). An id, never a name.
Response
Body
Body
string
The kind of resource that was analyzed. One of:
quota, data_table,
group, group_dimension, plan, report, integration.object
The resource whose dependents were analyzed.
integer
Total dependents across every nature — the length of
dependencies. Zero
means nothing references this resource, so changing or deleting it breaks
nothing.object[]
Per-nature rollup of
dependencies, to read the shape of the impact at a
glance. Natures with no dependent are omitted.object[]
Every dependent, ordered by nature then name. The whole set, never a page
and never capped —
total is always its length.