Rippling: Export a package version manifest
Rippling restApi.getPackageVersionManifest: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.get_package_version_manifest
Provider route: GET /package-manifests/versions/{version_id}/. 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"]["getPackageVersionManifest"]>[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.getPackageVersionManifest(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.get_package_version_manifest(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.version_id | string | Required within parent | Pattern: ^[0-9a-fA-F]{24}$ |
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 Export a package version manifest — response body |
Referenced models: Export a package version manifest — response body
Schemas
Section titled “Schemas”Export a package version manifest — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
components | array | Required within parent | Complete desired component snapshot compiled from the Metadata SDK's defineManifest. Each entry requires its component type and full configuration for that type. An empty array creates an empty draft version; it cannot be published until components are added. |
components[] | object | Each item | |
components_to_delete | array | Optional | Must be omitted or an empty array. Versions are complete snapshots, so deletion instructions are rejected. Default: [] Maximum items: 0 |
components_to_delete[] | object | Each item | |
metadata | Model | Required within parent | Expand Export a package version manifest — response body — metadata |
Referenced models: Export a package version manifest — response body — metadata
Export a package version manifest — response body — metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Source metadata from the SDK's defineManifest, retained with the snapshot. Use an empty object when no metadata is needed; package identity is supplied separately. Additional keys: not allowed |
description | string | Optional | Optional description of the source manifest, independent of the version description. |
key | string | Optional | Optional source-manifest identifier, retained on download; not the package key. |
name | string | Optional | Optional source-manifest label, retained on download; does not rename the package. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.rest_api.get_package_version_manifest. Catalog operation: get-package-version-manifest. 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"}