Anaplan icon

Anaplan

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

Get List Metadata

AI-generated

Overview

This node interacts with the Anaplan API to perform various operations related to Anaplan workspaces, models, and lists. Specifically, the 'Get List Metadata' operation retrieves metadata information about a selected Anaplan list within a specified workspace and model. This is useful for users who need to access detailed list structure or properties for further processing or integration in workflows, such as data synchronization, reporting, or automation tasks involving Anaplan data.

Use Case Examples

  1. Retrieve metadata of a specific list in an Anaplan model to understand its structure before importing or exporting data.
  2. Automate the extraction of list metadata to dynamically adjust workflows based on list properties.

Properties

Name Meaning
Authentication Method used to authenticate with the Anaplan API, currently supports Basic Auth.
Workspace ID Select the Anaplan workspace to operate within. This is required to scope the API requests to the correct workspace.
Model ID Select the Anaplan model within the chosen workspace. This is required to specify the model context for the list operations.
List ID Select the specific Anaplan list to retrieve metadata for. This is optional but required for operations that target a specific list.

Output

JSON

  • listMetadata - Contains the metadata information of the selected Anaplan list, such as structure, properties, and other relevant details.

Dependencies

  • Anaplan API with Basic Authentication

Troubleshooting

  • Ensure that the workspace ID, model ID, and list ID are correctly selected and exist in your Anaplan environment to avoid errors.
  • Authentication failures may occur if the Basic Auth credentials are incorrect or expired; verify credentials and update if necessary.
  • If the operation is not implemented or the node throws an error about the operation, check that the node version supports the requested operation and that the operation name is correctly specified.

Discussion