Skip to content

Rippling: Validate metadata components

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

← Rest API operations · Get started

Operation rippling.rest_api.validate_metadata_components

Provider route: POST /metadata/validate/. 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"]["validateMetadataComponents"]>[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.validateMetadataComponents(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.validate_metadata_components(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelRequired within parentExpand Validate metadata components — request body — body

Referenced models: Validate metadata components — request body — body

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Validate metadata components — response body

Referenced models: Validate metadata components — response body

Validate metadata components — response body
FieldTypePresenceDescription and constraints
$objectRoot
errorsarrayRequired within parentPackage-level validation issues.
errors[]ModelEach itemExpand Deploy a metadata component package — response body — error
resultsarrayRequired within parentPer-component validation results.
results[]ModelEach itemExpand Validate metadata components — response body — results item
validbooleanRequired within parentTrue only when every component and dependency check passed.

Referenced models: Validate metadata components — response body — results item, Deploy a metadata component package — response body — error

Validate metadata components — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
componentsarrayRequired within parentComplete package of metadata components, including dependencies.
Minimum items: 1
components[]ModelEach itemExpand Extract existing metadata components — response body — component configs item

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

Validate metadata components — response body — results item
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
errorsarrayOptional
errors[]ModelEach itemExpand Deploy a metadata component package — response body — error
existingobjectOptionalExisting component config matched by the identifier, when available.
Additional keys: allowed
identifierobjectOptionalResolved component identifier.
Additional keys: allowed
mergedobjectOptionalMerged target state for updates, when available.
Additional keys: allowed
normalizedobjectOptionalSchema-normalized component config.
Additional keys: allowed
outcomeJSONOptional
outcome (anyOf 1)stringAlternativeUpsert classification computed during validation.
Known values: CREATE, NO_OP, UPDATE, UNSUPPORTED_UPDATE
outcome (anyOf 2)nullAlternative
typestringRequired within parentMetadata component type.
validbooleanRequired within parentWhether this component passed validation.

Referenced models: Deploy a metadata component package — response body — error

Deploy a metadata component package — response body — error
FieldTypePresenceDescription and constraints
$objectRootA validation, dependency, permission, or deployment issue.
Additional keys: allowed
causeJSONOptional
cause (anyOf 1)stringAlternativeLower-level cause associated with the issue, when available.
cause (anyOf 2)nullAlternative
codestringRequired within parentStable machine-readable issue code.
component_typeJSONOptional
component_type (anyOf 1)stringAlternativeComponent type associated with the issue, when available.
component_type (anyOf 2)nullAlternative
messagestringRequired within parentHuman-readable remediation message.
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.

SDK function policy ID: rippling.rest_api.validate_metadata_components. Catalog operation: validate-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-write"]

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.