Skip to content

Rippling: POST Dimension

Rippling tandAapi.postDimensions: arguments, response, policy and SDK examples.

← Tand aapi operations · Get started

Operation rippling.t_and_a_api.post_dimensions

Provider route: POST /platform/api/dimensions. 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["tandAapi"]["postDimensions"]>[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.tandAapi.postDimensions(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.tand_aapi.post_dimensions(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyobjectOptional
body.namestringRequired within parentThe name of the dimension.
body.spoke_identifierstringOptionalThe external identifier of the dimension.

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

FieldTypePresenceDescription and constraints
$ModelRootExpand GET Dimension — response body

Referenced models: GET Dimension — response body

GET Dimension — response body
FieldTypePresenceDescription and constraints
$objectRootA dimension object can be created to track time worked under various different buckets. Examples of dimensions include 'Location' or 'Project', and each dimension typically has one or more specific job codes underneath it.
groupstring or nullOptionalThe id of the group that applies to the dimension, if one exists.
idstringRequired within parentThe id of the dimension.
namestringRequired within parentThe name of the dimension.
spoke_identifierstring or nullOptionalThe unique identifier of the dimension in an outside system.

SDK function policy ID: rippling.t_and_a_api.post_dimensions. Catalog operation: t-and-a-api.post-dimensions. 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.

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.