Rippling: GET Dimensions for Company
Rippling tandAapi.getDimensions: arguments, response, policy and SDK examples.
← Tand aapi operations · Get started
Operation rippling.t_and_a_api.get_dimensions
Provider route: GET /platform/api/dimensions. 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["tandAapi"]["getDimensions"]>[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.getDimensions(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.tand_aapi.get_dimensions(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
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 |
|---|---|---|---|
$ | array | Root | |
$[] | Model | Each item | Expand GET Dimension — response body |
Referenced models: GET Dimension — response body
Schemas
Section titled “Schemas”GET Dimension — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A 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. |
group | string or null | Optional | The id of the group that applies to the dimension, if one exists. |
id | string | Required within parent | The id of the dimension. |
name | string | Required within parent | The name of the dimension. |
spoke_identifier | string or null | Optional | The unique identifier of the dimension in an outside system. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.t_and_a_api.get_dimensions. Catalog operation: t-and-a-api.get-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.