Rippling: List selectable package components
Rippling restApi.listPackageComponents: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.list_package_components
Provider route: GET /package-components/. 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"]["listPackageComponents"]>[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.listPackageComponents(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.list_package_components(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Required within parent | Additional keys: not allowed |
query.type | string | Required within parent | Minimum length: 1 |
query.search | string | Optional | |
query.limit | integer | Optional | Default: 50 Maximum: 100 Minimum: 1 |
query.cursor | string | Optional |
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 List selectable package components — response body |
Referenced models: List selectable package components — response body
Schemas
Section titled “Schemas”List selectable package components — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
next_link | JSON | Required within parent | |
next_link (anyOf 1) | string | Alternative | URL for the next page of summaries, or null when there are no more results. |
next_link (anyOf 2) | null | Alternative | |
results | array | Required within parent | One page of component summaries, without configurations or source code. Maximum items: 100 |
results[] | Model | Each item | Expand List selectable package components — response body — results item |
Referenced models: List selectable package components — response body — results item
List selectable package components — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Component description, when available. |
description (anyOf 2) | null | Alternative | |
identifier | object | Required within parent | Complete package picker identifier to pass unchanged to extraction; fields depend on component type. |
name | string | Required within parent | Component display name in the package builder. |
selectable | boolean | Required within parent | Whether the package builder permits selecting this component. |
unsupported_reason | JSON | Required within parent | |
unsupported_reason (anyOf 1) | string | Alternative | Why selection is unavailable, when supplied by the package builder. |
unsupported_reason (anyOf 2) | null | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.rest_api.list_package_components. Catalog operation: list-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", "packages.read-write"]
Provider entitlements: ["Unity_Packages_V2_Platform_API"]
Pinned headers: {"Rippling-Api-Version": "2024-08-01"}