Skip to content

Rippling: Extract existing metadata components

Rippling restApi.extractMetadataComponents: arguments, response, policy and SDK examples.

← Rest API operations · Get started

Operation rippling.rest_api.extract_metadata_components

Provider route: GET /metadata/extract/. Alter supplies the connection’s credentials and routing.

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"]["extractMetadataComponents"]>[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.extractMetadataComponents(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from 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_metadata_components(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.qstringOptional
query.limitintegerOptionalMinimum: 1

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Extract existing metadata components — response body

Referenced models: Extract existing metadata components — response body

Extract existing metadata components — response body
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
component_configsarrayRequired within parentReadable component configs for the selected roots. Dependencies the caller cannot read are omitted, so the result may not be deployable as-is.
component_configs[]ModelEach itemExpand Extract existing metadata components — response body — component configs item
context_completebooleanOptionalFor search-backed extraction, whether contextual expansion completed without warnings or unreadable components being omitted.
context_warningsarrayOptionalWarnings from search-backed contextual expansion.
context_warnings[]stringEach item
dependency_graphobjectRequired within parentSerialized dependency graph for the extracted package.
Additional keys: allowed
external_managed_dependenciesarrayOptional
external_managed_dependencies[]objectEach itemExternal managed dependency.
Additional keys: allowed
install_orderarrayRequired within parentTopological install order for the extracted package.
install_order[]objectEach itemComponent identifier.
Additional keys: allowed
root_componentsarrayRequired within parentComponents selected as extraction roots.
root_components[]ModelEach itemExpand Extract existing metadata components — response body — root components item

Referenced models: Extract existing metadata components — response body — component configs item, Extract existing metadata components — response body — root components item

Extract existing metadata components — response body — component configs item
FieldTypePresenceDescription and constraints
$objectRootA metadata component config. The `type` field selects the concrete component schema. Fetch type-specific fields from GET /metadata/schema/?type=<TYPE>.
Additional keys: allowed
typestringRequired within parentMetadata component type, such as CUSTOM_OBJECT or CUSTOM_OBJECT_FIELD.
Extract existing metadata components — response body — root components item
FieldTypePresenceDescription and constraints
$objectRootSelectable package root returned by metadata extraction.
Additional keys: allowed
identifierobjectOptionalIdentifier for the selected component.
Additional keys: allowed
namestringOptionalDisplay name for the selectable component.

SDK function policy ID: rippling.rest_api.extract_metadata_components. Catalog operation: extract-metadata-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: ["metadata.read"]

Provider entitlements: ["Metadata_Platform_API"]

Pinned headers: {"Rippling-Api-Version": "2024-08-01"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.