Anaplan icon

Anaplan

Anaplan API actions: Export, Import, Lists, Files, Module updates, Single Cell, etc.
Join our community

Actions25

Overview

This node interacts with the Anaplan API to perform various operations related to Anaplan workspaces, models, and lists. Specifically, the 'Get List Read Request Status' operation retrieves the status of a read request for a list within a specified Anaplan workspace and model. This is useful for monitoring the progress or completion of data read requests in Anaplan, which can be part of data integration or automation workflows.

Use Case Examples

  1. Monitoring the status of a data extraction request from an Anaplan list to ensure data is ready for further processing.
  2. Automating workflows that depend on the completion of list read requests in Anaplan by checking their status programmatically.

Properties

Name Meaning
Authentication Method used to authenticate with the Anaplan API, currently supports Basic Auth.
Workspace ID Selects the Anaplan workspace where the list and model reside. This is required to scope the API request.
Model ID Selects the Anaplan model within the chosen workspace. Required to specify the context for the list and read request.
List ID Selects the specific Anaplan list related to the read request. This is optional and shown for multiple operations including getting read request status.
Read Request ID Selects an existing read request to check its status. This is optional and required for operations involving read requests.

Output

JSON

  • status - The current status of the list read request, indicating progress or completion.
  • readRequestId - The identifier of the read request whose status is being retrieved.
  • listId - The identifier of the list associated with the read request.
  • workspaceId - The workspace identifier where the list and read request exist.
  • modelId - The model identifier within the workspace related to the read request.

Dependencies

  • Anaplan API with Basic Authentication

Troubleshooting

  • Ensure that the workspaceId, modelId, listId, and readRequestId are correctly selected and exist in Anaplan; incorrect IDs will cause API errors.
  • Verify that the Basic Auth credentials are valid and have sufficient permissions to access the specified workspace and model.
  • Common error messages may include authentication failures, resource not found, or permission denied. Check credentials and resource IDs to resolve these.

Links

Discussion