Skip to content

Rippling: Validate metadata components — response body — results item

Validate metadata components: response body, field results / item. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: 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

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.