Rippling: Extract live package components and dependencies
Rippling restApi.extractPackageComponents: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.extract_package_components
Provider route: POST /package-components/extract/. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["restApi"]["extractPackageComponents"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.restApi.extractPackageComponents(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_rippling import RipplingIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.rest_api.extract_package_components(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | Model | Required within parent | Expand Extract live package components and dependencies — request body — body |
Referenced models: Extract live package components and dependencies — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Extract live package components and dependencies — response body |
Referenced models: Extract live package components and dependencies — response body
Schemas
Section titled “Schemas”Extract live package components and dependencies — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
component_configs | array | Required within parent | Full packaging configurations for selected live components and their dependencies. |
component_configs[] | object | Each item | |
external_managed_dependencies | array | Required within parent | Required components owned by other managed packages, outside this snapshot. |
external_managed_dependencies[] | object | Each item | |
external_zobject_references | array | Required within parent | Native object and field references required in the destination company. |
external_zobject_references[] | object | Each item | |
has_omitted_unreadable_components | boolean | Required within parent | True when extraction skipped a missing, deleted, or unreadable component, including a selected root or dependency. The returned snapshot is partial and must not be used to create a package version. |
install_order | array | Required within parent | Component identifiers ordered for installation by the packaging dependency graph. |
install_order[] | object | Each item | |
omitted_components | array | Required within parent | Missing or deleted components skipped by the shared extractor, with identifiers and omission reasons. An empty list means no missing-component omissions were reported. |
omitted_components[] | Model | Each item | Expand Extract live package components and dependencies — response body — omitted components item |
Referenced models: Extract live package components and dependencies — response body — omitted components item
Extract live package components and dependencies — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
identifiers | array | Required within parent | Complete picker identifiers; fields depend on the component type. Maximum items: 100 Minimum items: 1 |
identifiers[] | object | Each item |
Extract live package components and dependencies — response body — omitted components item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
identifier | object | Required within parent | Identifier of the selected component or dependency omitted from extraction. |
message | string | Required within parent | Explanation of why the component was omitted. |
reason | string | Required within parent | Machine-readable reason the component was omitted. Known values: NOT_FOUND |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.rest_api.extract_package_components. Catalog operation: extract-package-components. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["packages.read-write"]
Provider entitlements: ["Unity_Packages_V2_Platform_API"]
Pinned headers: {"Rippling-Api-Version": "2024-08-01"}