Anaplan Tool
Discover Anaplan workspaces, models, lists, exports and actions via the Anaplan Integration API v2.
Tool ID
anaplan-discovery
Credential Required
Yes — a server-refreshed oauth credential (auth mode oauth_user). The InTouch server resolves and refreshes the linked oauth credential and hands the tool a live access token at execution time; the tool never stores or refreshes tokens itself. Mint one with itcli.py /oauth. Every request is sent as Authorization: Bearer <access_token> to the fixed base URL https://api.anaplan.com/2/0.
Credential Properties
| Property | Type | Default | Description |
|---|---|---|---|
client_id |
string | — | OAuth app client ID (your registered Anaplan OAuth client) |
client_secret |
string | — | OAuth app client secret (if required on refresh) |
token_url |
string | — | Provider OAuth token endpoint — used to refresh |
access_token |
string | — | Required. Current access token — kept fresh by the server; do not edit by hand |
refresh_token |
string | — | Refresh token; enables automatic server-side refresh |
token_type |
string | Bearer |
Token type |
scope |
string | — | Granted OAuth scopes (space-separated) |
expires_at |
string | — | Access-token expiry in epoch seconds (0 = non-expiring) |
Operations
1. list_workspaces — List workspaces
Reads all Anaplan workspaces visible to the authenticated user.
Calls GET /workspaces.
Properties:
| Property | Type | Default | Description |
|---|---|---|---|
query |
string | — | Optional query params as a JSON object string |
Published Outputs:
- result — the JSON response body
- status — HTTP status code
2. list_models — List models in a workspace
Reads the models in one workspace.
Calls GET /workspaces/{workspaceId}/models.
Properties:
| Property | Type | Default | Description |
|---|---|---|---|
workspaceId |
string | — | Required. Anaplan workspace id (lowercase) |
query |
string | — | Optional query params as a JSON object string |
Published Outputs:
- result — the JSON response body
- status — HTTP status code
3. list_lists — List lists in a model
Reads the lists defined in one model.
Calls GET /workspaces/{workspaceId}/models/{modelId}/lists.
Properties:
| Property | Type | Default | Description |
|---|---|---|---|
workspaceId |
string | — | Required. Anaplan workspace id (lowercase) |
modelId |
string | — | Required. Anaplan model id (uppercase) |
query |
string | — | Optional query params as a JSON object string |
Published Outputs:
- result — the JSON response body
- status — HTTP status code
4. list_exports — List exports in a model
Reads the export definitions in one model.
Calls GET /workspaces/{workspaceId}/models/{modelId}/exports.
Properties:
| Property | Type | Default | Description |
|---|---|---|---|
workspaceId |
string | — | Required. Anaplan workspace id (lowercase) |
modelId |
string | — | Required. Anaplan model id (uppercase) |
query |
string | — | Optional query params as a JSON object string |
Published Outputs:
- result — the JSON response body
- status — HTTP status code
5. list_actions — List actions in a model
Reads the actions defined in one model.
Calls GET /workspaces/{workspaceId}/models/{modelId}/actions.
Properties:
| Property | Type | Default | Description |
|---|---|---|---|
workspaceId |
string | — | Required. Anaplan workspace id (lowercase) |
modelId |
string | — | Required. Anaplan model id (uppercase) |
query |
string | — | Optional query params as a JSON object string |
Published Outputs:
- result — the JSON response body
- status — HTTP status code
License
Requires a per-tool connector license on Department/Enterprise editions (Personal/Solo/Team editions are unaffected). Apply the license via the tool's Apply License action.
Self-Contained JAR
The jar bundles all runtime dependencies; only intouch-tool-api is provided by the server.
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
completeoperationresultstatuswarning