Anaplan API - Parable

Anaplan is a cloud-based enterprise planning platform that provides REST APIs for bulk data import/export, transactional data operations, model lifecycle management, audit logging, user identity management (SCIM), and financial consolidation across workspaces and models.

Overview
Setup Guide
Permissions
Troubleshooting

Connect Parable to Anaplan for workspace, SCIM, and audit data using email and password with HTTP Basic authentication against the Anaplan token endpoint.

Planning data

Models, lists, workspaces you can access with the integration account

Identity & audit

SCIM users and groups (with Tenant Admin), audit events (with Tenant Auditor)

Data streams

This Provider Plugin defines 20 data streams.

Stream	Description	Sync
`workspaces`	Lists all workspaces accessible to the authenticated user. Core organizational container in Anaplan.	full
`models`	Lists all models across all workspaces accessible to the authenticated user, with optional detailed memory usage information.	full
`workspace_models`	Lists all models within a specific workspace. Useful for workspace-scoped model enumeration.	full
`model_exports`	Lists all export action definitions within a specific model. Export actions define data extractions from Anaplan modules/views.	full
`model_imports`	Lists all import action definitions within a specific model. Import actions define data loading configurations into Anaplan.	full
`model_actions`	Lists all actions (delete actions, other named actions) defined within a specific model.	full
`model_files`	Lists all files (data sources and export outputs) within a specific model.	full
`model_lists`	Lists all lists (dimensions/hierarchies) defined within a specific model. Lists are core structural elements in Anaplan.	full
`list_items`	Retrieves all items within a specific list (dimension members). These are the actual data records within Anaplan lists/hierarchies.	full
`model_modules`	Lists all modules defined within a specific model. Modules are the primary data containers in Anaplan holding line items and views.	full
`module_views`	Lists all saved views within a specific module. Views represent different perspectives/layouts of module data.	full
`model_line_items`	Lists all line items defined within a specific model. Line items are the individual data elements (metrics/measures) in Anaplan modules.	full
`cloudworks_connections`	Lists all CloudWorks connections configured for the tenant. Connections define external data source/destination endpoints (S3, Azure Blob, BigQuery, etc.).	full
`cloudworks_integrations`	Lists all CloudWorks integrations configured for the tenant. Integrations define automated data flows between Anaplan models and external cloud services.	full
`cloudworks_run_history`	Lists CloudWorks integration run history records. Provides execution logs showing when integrations ran, their status, and duration.	full
`users`	Lists all users in the Anaplan tenant via the Integration API v2. Returns user identity, email, active status, and admin role. Does not require SCIM provisioning or Enterprise tier.	full
`scim_users`	Lists all users provisioned in the Anaplan tenant via SCIM 2.0. Returns user identity, email, active status, and workspace assignments.	full
`audit_events`	Retrieves audit events from the Anaplan tenant. Captures who-did-what-when across the platform including model changes, user actions, data imports/exports, and administrative operations. Anaplan retains up to 30 days of audit history. Requires Tenant Auditor role.	incremental
`model_calendar`	Retrieves the calendar/time configuration for an Anaplan model, including fiscal year settings, time ranges, and period definitions. This is a model-level metadata object but returns structured time taxonomy data.	full
`model_versions`	Retrieves version information (revision tags) for Anaplan models via the ALM API. Tracks model versioning history including who created each version and when, supporting change management and activity tracking.	full

Basic authentication

What You’ll Need

Credential	What it is
Email	Anaplan integration user email
Password	Anaplan account password

Info: Setup access in Anaplan. These steps require Tenant Admin / Workspace Admin as required for the data you sync, or a colleague with equivalent permissions who can create credentials for you. If that is not you, ask your Anaplan administrator.

Workspace Admin on all workspaces you want to sync
Tenant Admin (required for SCIM user and group access)
Tenant Auditor (required for audit event access)

Info: Designate the integration account as an Exception User under Administration → Security Policies so optional password rotation does not break the connection.

Step 1: Confirm integration account

Use (or create) a dedicated Anaplan user for Parable. Grant the roles above for the workspaces and APIs you need.

Step 2: How authentication works

Parable sends email and password to https://auth.anaplan.com/token/authenticate using HTTP Basic auth. Anaplan returns a short-lived AnaplanAuthToken for API calls; Parable refreshes it automatically.

Step 3: Enter values in the form

Email and Password: Enter the integration user credentials in the Provider form.
Click Save & test connection.

Token endpoint

curl -u "your-email@company.com" \
  -X POST -H "Content-Type: application/json" -d '' \
  https://auth.anaplan.com/token/authenticate

Info: Omitting the password after the colon makes curl prompt for it interactively so it is not stored in shell history.

Success: Success! If you received a 200 OK response with valid data, your credentials are configured correctly. You can now configure this Provider in Parable.

Tip: A successful response includes tokenInfo.tokenValue.

Tip: Rate Limits: Anaplan enforces rate limits of varies by API; implement backoff for throttling. Parable handles rate limiting automatically with exponential backoff, but initial syncs of large datasets may take longer due to these limits.

Audit Events

Developer identifier: audit_eventsAudit Events contain audit events from the Anaplan tenant. Captures who-did-what-when across the platform including model changes, user actions, data imports/exports, and administrative operations. Anaplan retains up to 30 days of audit history. Requires Tenant Auditor role.

Enables: trace recorded Anaplan changes and administrative actions to their actor and event time.
Scope: Reads provider changes through POST https://audit.anaplan.com/audit/api/1/events/search?limit=10000 using the declared incremental request boundary. The operation requires the Tenant Auditor role and is limited to Anaplan’s retained audit window, described here as up to 30 days.

Action Details

Developer identifier: audit_events.actionDetailsAction Details records detailed information about the specific action performed. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret action details according to the provider and Workspace configuration that produced each audit event record.
Interpretation: Keys and value shapes within actionDetails can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Action ID

Developer identifier: audit_events.actionDetails.actionIdAction ID captures the identifier of the action definition (e.g., import ID, export ID, process ID). It is needed to resolve references that repeat the same provider identifier.

Enables: match audit event records to provider records that carry the same action ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies actionId as a record-level identifier on ActionDetails. It is not a uniqueness guarantee unless a connector directive says so.

Action Name

Developer identifier: audit_events.actionDetails.actionNameAction Name captures the name of the action definition. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact action name value attached to each action detail record.
Interpretation: The provider supplies actionName at action detail granularity in the format stated by its description; omitted or redacted content remains unknown.

Action Type

Developer identifier: audit_events.actionDetails.actionTypeAction Type captures the type of action (e.g., import, export, process, delete). It preserves the provider’s current classification of this record.

Enables: separate audit event records by the exact provider-reported action type value when describing their recorded state.
Interpretation: The provider supplies actionType per action detail record using its own state vocabulary; unknown and missing values must remain distinct.

Changed Properties

Developer identifier: audit_events.actionDetails.changedPropertiesChanged Properties records list of properties that were changed during the event. It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: expand the nested changed properties object into its declared child fields for each action detail record.
Interpretation: The provider returns changedProperties as a list on ActionDetails; an absent value does not prove that no related object exists outside the credential’s visibility.

New Value

Developer identifier: audit_events.actionDetails.changedProperties.newValueNew Value captures the new value of the property after the change. It preserves the recorded before, after, or contextual value needed to explain a change event.

Enables: compare the recorded new value with the corresponding changed attribute when explaining an audit or changelog event.
Interpretation: The provider supplies newValue on each change record in the changed attribute’s own type or display format; it is not normalized into a common unit.

Old Value

Developer identifier: audit_events.actionDetails.changedProperties.oldValueOld Value captures the previous value of the property before the change. It preserves the recorded before, after, or contextual value needed to explain a change event.

Enables: compare the recorded old value with the corresponding changed attribute when explaining an audit or changelog event.
Interpretation: The provider supplies oldValue on each change record in the changed attribute’s own type or display format; it is not normalized into a common unit.

Property Name

Developer identifier: audit_events.actionDetails.changedProperties.propertyNameProperty Name captures the name of the property that was changed. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact property name value attached to each changed property record.
Interpretation: The provider supplies propertyName at changed property granularity in the format stated by its description; omitted or redacted content remains unknown.

Duration Ms

Developer identifier: audit_events.actionDetails.durationMsDuration Ms captures the duration of the action in milliseconds. It preserves the elapsed interval reported for this record.

Enables: compare the provider-recorded interval represented by duration ms across audit event records.
Interpretation: The provider supplies durationMs per action detail record in seconds; it is an elapsed or recorded interval, not an outcome measure.

Failure Count

Developer identifier: audit_events.actionDetails.failureCountFailure Count captures the number of records that failed during the action. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported failure count for each action detail record.
Interpretation: The provider supplies failureCount at action detail granularity as a count at one value per record; zero and missing are not interchangeable.

Record Count

Developer identifier: audit_events.actionDetails.recordCountRecord Count captures the number of records processed by the action, if applicable. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported record count for each action detail record.
Interpretation: The provider supplies recordCount at action detail granularity as a count at one value per record; zero and missing are not interchangeable.

Source File ID

Developer identifier: audit_events.actionDetails.sourceFileIdSource File ID captures the file ID used as the source for an import action. It is needed to resolve references that repeat the same provider identifier.

Enables: match audit event records to provider records that carry the same source file ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies sourceFileId as a record-level identifier on ActionDetails. It is not a uniqueness guarantee unless a connector directive says so.

Source File Name

Developer identifier: audit_events.actionDetails.sourceFileNameSource File Name captures the file name used as the source for an import action. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact source file name value attached to each action detail record.
Interpretation: The provider supplies sourceFileName at action detail granularity in the format stated by its description; omitted or redacted content remains unknown.

Target List ID

Developer identifier: audit_events.actionDetails.targetListIdTarget List ID captures the target list ID for an import action. It is needed to resolve references that repeat the same provider identifier.

Enables: match audit event records to provider records that carry the same target list ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies targetListId as a record-level identifier on ActionDetails. It is not a uniqueness guarantee unless a connector directive says so.

Target Module ID

Developer identifier: audit_events.actionDetails.targetModuleIdTarget Module ID captures the target module ID for an import action. It is needed to resolve references that repeat the same provider identifier.

Enables: match audit event records to provider records that carry the same target module ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies targetModuleId as a record-level identifier on ActionDetails. It is not a uniqueness guarantee unless a connector directive says so.

Task ID

Developer identifier: audit_events.actionDetails.taskIdTask ID captures the task ID if the action was executed as an asynchronous task. It is needed to resolve references that repeat the same provider identifier.

Enables: match audit event records to provider records that carry the same task ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies taskId as a record-level identifier on ActionDetails. It is not a uniqueness guarantee unless a connector directive says so.

Task State

Developer identifier: audit_events.actionDetails.taskStateTask State captures the final state of the task (e.g., COMPLETE, FAILED, CANCELLED). It preserves the provider’s current classification of this record.

Enables: separate audit event records by the exact provider-reported task state value when describing their recorded state.
Interpretation: The provider supplies taskState per action detail record using its own state vocabulary; unknown and missing values must remain distinct.

Activity ID

Developer identifier: audit_events.activityIdActivity ID is the identifier linking related audit events within a single activity or transaction. It is needed to resolve references that repeat the same provider identifier.

Enables: match audit event records to provider records that carry the same activity ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies activityId as a record-level identifier on AuditEvent. It is not a uniqueness guarantee unless a connector directive says so.

Additional Attributes

Developer identifier: audit_events.additionalAttributesAdditional Attributes records event-specific attributes that vary by event type, returned as a key-value map by the Anaplan audit API. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact additional attributes when validating the configuration or technical definition of a audit event record.
Interpretation: The provider supplies additionalAttributes as configuration or technical metadata on AuditEvent; consumers must preserve the exact syntax and documented vocabulary.

Checksum

Developer identifier: audit_events.checksumChecksum records integrity checksum returned by the Anaplan audit API for the event record. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact checksum when validating the configuration or technical definition of a audit event record.
Interpretation: The provider supplies checksum as configuration or technical metadata on AuditEvent; consumers must preserve the exact syntax and documented vocabulary.

Created Date

Developer identifier: audit_events.createdDateCreated Date records epoch timestamp (milliseconds) when the audit record was created. It anchors the named event or boundary on the record’s timeline.

Enables: place audit event records on a timeline by created date and select the records within an explicit reporting window.
Interpretation: The provider supplies createdDate per audit event record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Created Time Zone

Developer identifier: audit_events.createdTimeZoneCreated Time Zone records time zone associated with createdDate when returned by the audit API. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.

Enables: interpret dates, times, or localized text for audit events using the recorded created time zone.
Interpretation: The provider supplies createdTimeZone as location or localization context per audit event record; it does not establish a person’s real-time physical location.

Error Message

Developer identifier: audit_events.errorMessageError Message records error message if the action was unsuccessful. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact error message value attached to each audit event record.
Interpretation: The provider supplies errorMessage at audit event granularity in the format stated by its description; omitted or redacted content remains unknown.

Event Category

Developer identifier: audit_events.eventCategoryEvent Category states high-level category grouping for the audit event. It preserves the provider’s current classification of this record.

Enables: separate audit event records by the exact provider-reported event category value when describing their recorded state.
Interpretation: The provider supplies eventCategory per audit event record using its own state vocabulary; unknown and missing values must remain distinct.

Event Date

Developer identifier: audit_events.eventDateEvent Date captures the epoch timestamp (in milliseconds) when the event occurred. It anchors the named event or boundary on the record’s timeline.

Enables: place audit event records on a timeline by event date and select the records within an explicit reporting window.
Interpretation: The provider supplies eventDate per audit event record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Event Date Iso

Developer identifier: audit_events.eventDateIsoEvent Date Iso records ISO 8601 formatted timestamp of when the event occurred. It anchors the named event or boundary on the record’s timeline.

Enables: place audit event records on a timeline by event date iso and select the records within an explicit reporting window.
Interpretation: The provider supplies eventDateIso per audit event record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Event Time Zone

Developer identifier: audit_events.eventTimeZoneEvent Time Zone records time zone associated with eventDate when returned by the audit API. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.

Enables: interpret dates, times, or localized text for audit events using the recorded event time zone.
Interpretation: The provider supplies eventTimeZone as location or localization context per audit event record; it does not establish a person’s real-time physical location.

Event Type

Developer identifier: audit_events.eventTypeEvent Type states optional category label for the audit event when the audit API returns it. Live search results typically use eventTypeId instead. It preserves the provider’s current classification of this record.

Enables: separate audit event records by the exact provider-reported event type value when describing their recorded state.
Interpretation: The provider supplies eventType per audit event record using its own state vocabulary; unknown and missing values must remain distinct.

Event Type ID

Developer identifier: audit_events.eventTypeIdEvent Type ID identifies event type code returned by the Anaplan audit API (for example USR-8). It is needed to resolve references that repeat the same provider identifier.

Enables: match audit event records to provider records that carry the same event type ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies eventTypeId as a record-level identifier on AuditEvent. It is not a uniqueness guarantee unless a connector directive says so.

Host Name

Developer identifier: audit_events.hostNameHost Name captures the hostname or server from which the action was performed. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact host name when validating the configuration or technical definition of a audit event record.
Interpretation: The provider supplies hostName as configuration or technical metadata on AuditEvent; consumers must preserve the exact syntax and documented vocabulary.

Developer identifier: audit_events.idID is the unique identifier for the audit event. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same audit event source row before constructing its represented state.
Interpretation: The provider supplies id at one value per audit event record, and x-transformDedupKey explicitly marks it as the record key.

IP Address

Developer identifier: audit_events.ipAddressIP Address captures the IP address from which the action was performed. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.

Enables: segment audit event records by the recorded IP address without inferring a person’s physical presence.
Interpretation: The provider supplies ipAddress as location or localization context per audit event record; it does not establish a person’s real-time physical location.

Message

Developer identifier: audit_events.messageMessage records human-readable description of the audit event. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact message value attached to each audit event record.
Interpretation: The provider supplies message at audit event granularity in the format stated by its description; omitted or redacted content remains unknown.

Model ID

Developer identifier: audit_events.modelIdModel ID captures the model ID in which the event occurred, if applicable. It is needed to resolve references that repeat the same provider identifier.

Enables: match audit event records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies modelId as a record-level identifier on AuditEvent. It is not a uniqueness guarantee unless a connector directive says so.

Model Name

Developer identifier: audit_events.modelNameModel Name captures the name of the model in which the event occurred. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact model name value attached to each audit event record.
Interpretation: The provider supplies modelName at audit event granularity in the format stated by its description; omitted or redacted content remains unknown.

Object ID

Developer identifier: audit_events.objectIdObject ID captures the unique identifier of the primary object affected by the event. It is needed to resolve references that repeat the same provider identifier.

Enables: match audit event records to provider records that carry the same object ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies objectId as a record-level identifier on AuditEvent. It is not a uniqueness guarantee unless a connector directive says so.

Object Name

Developer identifier: audit_events.objectNameObject Name captures the name of the primary object affected by the event. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact object name value attached to each audit event record.
Interpretation: The provider supplies objectName at audit event granularity in the format stated by its description; omitted or redacted content remains unknown.

Object Type

Developer identifier: audit_events.objectTypeObject Type captures the type of the primary object affected (e.g., model, workspace, list, module). It preserves the provider’s current classification of this record.

Enables: separate audit event records by the exact provider-reported object type value when describing their recorded state.
Interpretation: The provider supplies objectType per audit event record using its own state vocabulary; unknown and missing values must remain distinct.

Parameters

Developer identifier: audit_events.parametersParameters records additional parameters or context details associated with the audit event. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret parameters according to the provider and Workspace configuration that produced each audit event record.
Interpretation: Keys and value shapes within parameters can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Name

Developer identifier: audit_events.parameters.nameName captures the parameter name or key. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same audit event parameter source row before constructing its represented state.
Interpretation: The provider supplies name at one value per audit event parameter record, and x-transformDedupKey explicitly marks it as the record key.

Type

Developer identifier: audit_events.parameters.typeType captures the data type or classification of the parameter value. It preserves the provider’s current classification of this record.

Enables: separate audit event records by the exact provider-reported type value when describing their recorded state.
Interpretation: The provider supplies type per audit event parameter record using its own state vocabulary; unknown and missing values must remain distinct.

Value

Developer identifier: audit_events.parameters.valueValue captures the parameter value. It preserves the recorded before, after, or contextual value needed to explain a change event.

Enables: compare the recorded value with the corresponding changed attribute when explaining an audit or changelog event.
Interpretation: The provider supplies value on each change record in the changed attribute’s own type or display format; it is not normalized into a common unit.

Role ID

Developer identifier: audit_events.roleIdRole ID captures the role ID involved in the event, if applicable (e.g., role grant/revoke). It is needed to resolve references that repeat the same provider identifier.

Enables: match audit event records to provider records that carry the same role ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies roleId as a record-level identifier on AuditEvent. It is not a uniqueness guarantee unless a connector directive says so.

Role Name

Developer identifier: audit_events.roleNameRole Name captures the name of the role involved in the event. It documents the access-related value reported for this object or membership.

Enables: describe the provider-reported role name attached to each audit event record.
Interpretation: The provider supplies roleName at audit event granularity. It describes provider-reported context and does not prove effective access beyond the returned record.

Session ID

Developer identifier: audit_events.sessionIdSession ID captures the session identifier associated with the user’s session at the time of the event. It is needed to resolve references that repeat the same provider identifier.

Enables: match audit event records to provider records that carry the same session ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies sessionId as a record-level identifier on AuditEvent. It is not a uniqueness guarantee unless a connector directive says so.

Source Type

Developer identifier: audit_events.sourceTypeSource Type captures the source or channel through which the action was initiated. It preserves the provider’s current classification of this record.

Enables: separate audit event records by the exact provider-reported source type value when describing their recorded state.
Interpretation: The provider supplies sourceType per audit event record using its own state vocabulary; unknown and missing values must remain distinct.

Success

Developer identifier: audit_events.successSuccess indicates whether the audited action completed successfully. It preserves the provider-reported yes-or-no condition for this record.

Enables: select audit event records for which the provider reports success as true or false.
Interpretation: The provider supplies success as a boolean per audit event record; false and missing are distinct when the field is optional.

Target User Email

Developer identifier: audit_events.targetUserEmailTarget User Email captures the email of the target user, if the event involves an action on another user. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the audit event record to the provider-reported actor represented by target user email.
Interpretation: The provider supplies targetUserEmail as identity or attribution context on each audit event record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Target User ID

Developer identifier: audit_events.targetUserIdTarget User ID captures the user ID of the target user, if the event involves an action on another user (e.g., role assignment). It is needed to resolve references that repeat the same provider identifier.

Enables: match audit event records to provider records that carry the same target user ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies targetUserId as a record-level identifier on AuditEvent. It is not a uniqueness guarantee unless a connector directive says so.

Tenant ID

Developer identifier: audit_events.tenantIdTenant ID captures the Anaplan tenant ID associated with this audit event. It is needed to resolve references that repeat the same provider identifier.

Enables: match audit event records to provider records that carry the same tenant ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies tenantId as a record-level identifier on AuditEvent. It is not a uniqueness guarantee unless a connector directive says so.

User Agent

Developer identifier: audit_events.userAgentUser Agent records user-Agent string for the client that performed the action, when present. It preserves the client environment reported with the event.

Enables: count Mixpanel events by the reported user agent client environment.
Interpretation: Mixpanel supplies userAgent per tracked event from client metadata; missing values do not identify an operating system or browser.

User Email

Developer identifier: audit_events.userEmailUser Email captures the email address of the user who performed the action. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the audit event record to the provider-reported actor represented by user email.
Interpretation: The provider supplies userEmail as identity or attribution context on each audit event record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

User ID

Developer identifier: audit_events.userIdUser ID captures the unique identifier of the user who performed the action. It is needed to resolve references that repeat the same provider identifier.

Enables: match audit event records to provider records that carry the same user ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies userId as a record-level identifier on AuditEvent. It is not a uniqueness guarantee unless a connector directive says so.

User Name

Developer identifier: audit_events.userNameUser Name captures the display name or email of the user who performed the action. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the audit event record to the provider-reported actor represented by user name.
Interpretation: The provider supplies userName as identity or attribution context on each audit event record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Workspace ID

Developer identifier: audit_events.workspaceIdWorkspace ID captures the workspace ID in which the event occurred, if applicable. It is needed to resolve references that repeat the same provider identifier.

Enables: match audit event records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies workspaceId as a record-level identifier on AuditEvent. It is not a uniqueness guarantee unless a connector directive says so.

Workspace Name

Developer identifier: audit_events.workspaceNameWorkspace Name captures the name of the workspace in which the event occurred. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact workspace name value attached to each audit event record.
Interpretation: The provider supplies workspaceName at audit event granularity in the format stated by its description; omitted or redacted content remains unknown.

Cloudworks Connections

Developer identifier: cloudworks_connectionsCloudworks Connections contain all CloudWorks connections configured for the tenant. Connections define external data source/destination endpoints (S3, Azure Blob, BigQuery, etc.).

Enables: review the external connection definitions available to CloudWorks integrations.
Scope: Reads the declared collection through GET /cloudworks/2/0/integrations/connections as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.

Body

Developer identifier: cloudworks_connections.bodyBody records connection-specific configuration details such as bucket name, container, project, etc. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret body according to the provider and Workspace configuration that produced each cloudworks connection record.
Interpretation: Keys and value shapes within body can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Access Key ID

Developer identifier: cloudworks_connections.body.accessKeyIdAccess Key ID identifies AWS access key ID for S3 connections (may be masked or omitted in responses). It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks connection records to provider records that carry the same access key ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies accessKeyId as a record-level identifier on ConnectionBody. It is not a uniqueness guarantee unless a connector directive says so.

Account

Developer identifier: cloudworks_connections.body.accountAccount records snowflake account identifier. It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: expand the nested account object into its declared child fields for each connection body record.
Interpretation: The provider returns account as a nested object or reference on ConnectionBody; an absent value does not prove that no related object exists outside the credential’s visibility.

Auth Type

Developer identifier: cloudworks_connections.body.authTypeAuth Type states authentication type used by the connection (e.g., password, key, token, oauth). It documents the access-related value reported for this object or membership.

Enables: describe the provider-reported auth type attached to each connection body record.
Interpretation: The provider supplies authType at connection body granularity. It describes provider-reported context and does not prove effective access beyond the returned record.

Bucket

Developer identifier: cloudworks_connections.body.bucketBucket records s3 bucket name or GCS bucket name (applicable to AmazonS3, GoogleCloudStorage). It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact bucket when validating the configuration or technical definition of a connection body record.
Interpretation: The provider supplies bucket as configuration or technical metadata on ConnectionBody; consumers must preserve the exact syntax and documented vocabulary.

Catalog

Developer identifier: cloudworks_connections.body.catalogCatalog records catalog name for Databricks Unity Catalog or similar. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact catalog when validating the configuration or technical definition of a connection body record.
Interpretation: The provider supplies catalog as configuration or technical metadata on ConnectionBody; consumers must preserve the exact syntax and documented vocabulary.

Container Name

Developer identifier: cloudworks_connections.body.containerNameContainer Name records Azure Blob Storage container name. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact container name when validating the configuration or technical definition of a connection body record.
Interpretation: The provider supplies containerName as configuration or technical metadata on ConnectionBody; consumers must preserve the exact syntax and documented vocabulary.

Database

Developer identifier: cloudworks_connections.body.databaseDatabase records database name for Snowflake, Redshift, JDBC, AzureSql, or AzureSynapse connections. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact database when validating the configuration or technical definition of a connection body record.
Interpretation: The provider supplies database as configuration or technical metadata on ConnectionBody; consumers must preserve the exact syntax and documented vocabulary.

Dataset ID

Developer identifier: cloudworks_connections.body.datasetIdDataset ID identifies bigQuery dataset ID. It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks connection records to provider records that carry the same dataset ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies datasetId as a record-level identifier on ConnectionBody. It is not a uniqueness guarantee unless a connector directive says so.

External ID

Developer identifier: cloudworks_connections.body.externalIdExternal ID identifies external ID used with the IAM role for S3 cross-account access. It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks connection records to provider records that carry the same external ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies externalId as a record-level identifier on ConnectionBody. It is not a uniqueness guarantee unless a connector directive says so.

Host

Developer identifier: cloudworks_connections.body.hostHost records hostname or IP address for SFTP, JDBC, Snowflake, Databricks, or database connections. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact host when validating the configuration or technical definition of a connection body record.
Interpretation: The provider supplies host as configuration or technical metadata on ConnectionBody; consumers must preserve the exact syntax and documented vocabulary.

HTTP Path

Developer identifier: cloudworks_connections.body.httpPathHTTP Path records databricks HTTP path for SQL endpoint. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact HTTP path when validating the configuration or technical definition of a connection body record.
Interpretation: The provider supplies httpPath as configuration or technical metadata on ConnectionBody; consumers must preserve the exact syntax and documented vocabulary.

Port

Developer identifier: cloudworks_connections.body.portPort records the network port configured for an SFTP, JDBC, or database connection. It preserves the connection endpoint setting used with the host and protocol.

Enables: construct and audit the destination endpoint for each CloudWorks connection.
Interpretation: The provider supplies port as an integer connection setting, not a quantity or duration; a missing value may leave protocol-default behavior to other configuration.

Project ID

Developer identifier: cloudworks_connections.body.projectIdProject ID identifies Google Cloud project ID for BigQuery or GCS connections. It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks connection records to provider records that carry the same project ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies projectId as a record-level identifier on ConnectionBody. It is not a uniqueness guarantee unless a connector directive says so.

Region

Developer identifier: cloudworks_connections.body.regionRegion records AWS region for S3 connections (e.g., us-east-1). It preserves the geographic, locale, time-zone, or coordinate context represented by the field.

Enables: segment cloudworks connection records by the recorded region without inferring a person’s physical presence.
Interpretation: The provider supplies region as location or localization context per connection body record; it does not establish a person’s real-time physical location.

Role Arn

Developer identifier: cloudworks_connections.body.roleArnRole Arn states AWS IAM role ARN used for cross-account access to S3. It documents the access-related value reported for this object or membership.

Enables: describe the provider-reported role arn attached to each connection body record.
Interpretation: The provider supplies roleArn at connection body granularity. It describes provider-reported context and does not prove effective access beyond the returned record.

SAS Token

Developer identifier: cloudworks_connections.body.sasTokenSAS Token states Azure SAS token for authentication (may be masked in responses). It documents the access-related value reported for this object or membership.

Enables: confirm which CloudWorks connection authentication mode is configured during narrowly authorized troubleshooting without revealing the token value.
Interpretation: Anaplan may mask sasToken in responses; treat any returned value as sensitive configuration metadata, never expose it, and never assume it is a reusable credential.

Schema

Developer identifier: cloudworks_connections.body.schemaSchema records schema name within the database (Snowflake, Redshift, etc.). It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact schema when validating the configuration or technical definition of a connection body record.
Interpretation: The provider supplies schema as configuration or technical metadata on ConnectionBody; consumers must preserve the exact syntax and documented vocabulary.

Service Account Email

Developer identifier: cloudworks_connections.body.serviceAccountEmailService Account Email records Google service account email used for authentication. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the connection body record to the provider-reported person or account represented by service account email.
Interpretation: The provider supplies serviceAccountEmail as identity or attribution context on each connection body record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Storage Account Name

Developer identifier: cloudworks_connections.body.storageAccountNameStorage Account Name records Azure Storage account name. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact storage account name when validating the configuration or technical definition of a connection body record.
Interpretation: The provider supplies storageAccountName as configuration or technical metadata on ConnectionBody; consumers must preserve the exact syntax and documented vocabulary.

URL

Developer identifier: cloudworks_connections.body.urlURL records connection URL for Databricks, JDBC, or other URL-based connections. It retains the exact provider location for the referenced resource.

Enables: open or trace the exact provider resource referenced by URL on a connection body record.
Interpretation: The provider supplies url as a URL or resource locator on each connection body record. Availability still follows the provider’s permissions and retention.

User Name

Developer identifier: cloudworks_connections.body.usernameUser Name records username for SFTP, database, or other credential-based connections. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the connection body record to the provider-reported actor represented by user name.
Interpretation: The provider supplies username as identity or attribution context on each connection body record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Warehouse

Developer identifier: cloudworks_connections.body.warehouseWarehouse records snowflake warehouse name. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact warehouse when validating the configuration or technical definition of a connection body record.
Interpretation: The provider supplies warehouse as configuration or technical metadata on ConnectionBody; consumers must preserve the exact syntax and documented vocabulary.

Connection ID

Developer identifier: cloudworks_connections.connectionIdConnection ID is the unique identifier for the CloudWorks connection. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same cloud works connection source row before constructing its represented state.
Interpretation: The provider supplies connectionId at one value per cloud works connection record, and x-transformDedupKey explicitly marks it as the record key.

Created At

Developer identifier: cloudworks_connections.createdAtCreated At records ISO 8601 timestamp when the connection was created. It anchors the named event or boundary on the record’s timeline.

Enables: place cloudworks connection records on a timeline by created at and select the records within an explicit reporting window.
Interpretation: The provider supplies createdAt per cloud works connection record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Created By

Developer identifier: cloudworks_connections.createdByCreated By records identifier or email of the user who created the connection. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the cloud works connection record to the provider-reported person or account represented by created by.
Interpretation: The provider supplies createdBy as identity or attribution context on each cloud works connection record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Modified At

Developer identifier: cloudworks_connections.modifiedAtModified At records ISO 8601 timestamp when the connection was last modified. It anchors the named event or boundary on the record’s timeline.

Enables: place cloudworks connection records on a timeline by modified at and select the records within an explicit reporting window.
Interpretation: The provider supplies modifiedAt per cloud works connection record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Modified By

Developer identifier: cloudworks_connections.modifiedByModified By records identifier or email of the user who last modified the connection. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the cloud works connection record to the provider-reported person or account represented by modified by.
Interpretation: The provider supplies modifiedBy as identity or attribution context on each cloud works connection record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Name

Developer identifier: cloudworks_connections.nameName records human-readable name of the connection. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name value attached to each cloud works connection record.
Interpretation: The provider supplies name at cloud works connection granularity in the format stated by its description; omitted or redacted content remains unknown.

Type

Developer identifier: cloudworks_connections.typeType captures the type of external service this connection targets (e.g., AmazonS3, AzureBlob, GoogleBigQuery). It preserves the provider’s current classification of this record.

Enables: separate cloudworks connection records by the exact provider-reported type value when describing their recorded state.
Interpretation: The provider supplies type per cloud works connection record using its own state vocabulary; unknown and missing values must remain distinct.

Cloudworks Integrations

Developer identifier: cloudworks_integrationsCloudworks Integrations contain all CloudWorks integrations configured for the tenant. Integrations define automated data flows between Anaplan models and external cloud services.

Enables: map automated CloudWorks data flows to their model and connection configuration.
Scope: Reads the declared collection through GET /cloudworks/2/0/integrations as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.

Action ID

Developer identifier: cloudworks_integrations.actionIdAction ID is the identifier of the Anaplan import or export action linked to this integration. It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks integration records to provider records that carry the same action ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies actionId as a record-level identifier on CloudWorksIntegration. It is not a uniqueness guarantee unless a connector directive says so.

Connection ID

Developer identifier: cloudworks_integrations.connectionIdConnection ID is the identifier of the CloudWorks connection (external cloud service) used by this integration. It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks integration records to provider records that carry the same connection ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies connectionId as a record-level identifier on CloudWorksIntegration. It is not a uniqueness guarantee unless a connector directive says so.

Connection Type

Developer identifier: cloudworks_integrations.connectionTypeConnection Type captures the type of external cloud service connection (e.g., S3, Azure Blob, BigQuery). It preserves the provider’s current classification of this record.

Enables: separate cloudworks integration records by the exact provider-reported connection type value when describing their recorded state.
Interpretation: The provider supplies connectionType per cloud works integration record using its own state vocabulary; unknown and missing values must remain distinct.

Created At

Developer identifier: cloudworks_integrations.createdAtCreated At records ISO 8601 timestamp when the integration was created. It anchors the named event or boundary on the record’s timeline.

Enables: place cloudworks integration records on a timeline by created at and select the records within an explicit reporting window.
Interpretation: The provider supplies createdAt per cloud works integration record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Created By

Developer identifier: cloudworks_integrations.createdByCreated By records identifier or email of the user who created the integration. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the cloud works integration record to the provider-reported person or account represented by created by.
Interpretation: The provider supplies createdBy as identity or attribution context on each cloud works integration record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

File ID

Developer identifier: cloudworks_integrations.fileIdFile ID is the identifier of the Anaplan file used in the integration data transfer. It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks integration records to provider records that carry the same file ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies fileId as a record-level identifier on CloudWorksIntegration. It is not a uniqueness guarantee unless a connector directive says so.

Integration ID

Developer identifier: cloudworks_integrations.integrationIdIntegration ID is the unique identifier for the CloudWorks integration. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same cloud works integration source row before constructing its represented state.
Interpretation: The provider supplies integrationId at one value per cloud works integration record, and x-transformDedupKey explicitly marks it as the record key.

Last Run Status

Developer identifier: cloudworks_integrations.lastRunStatusLast Run Status states status of the most recent run of this integration. It preserves the provider’s current classification of this record.

Enables: separate cloudworks integration records by the exact provider-reported last run status value when describing their recorded state.
Interpretation: The provider supplies lastRunStatus per cloud works integration record using its own state vocabulary; unknown and missing values must remain distinct.

Last Run Time

Developer identifier: cloudworks_integrations.lastRunTimeLast Run Time records ISO 8601 timestamp of the most recent run. It anchors the named event or boundary on the record’s timeline.

Enables: place cloudworks integration records on a timeline by last run time and select the records within an explicit reporting window.
Interpretation: The provider supplies lastRunTime per cloud works integration record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Last Successful Run Time

Developer identifier: cloudworks_integrations.lastSuccessfulRunTimeLast Successful Run Time records ISO 8601 timestamp of the most recent successful run. It anchors the named event or boundary on the record’s timeline.

Enables: place cloudworks integration records on a timeline by last successful run time and select the records within an explicit reporting window.
Interpretation: The provider supplies lastSuccessfulRunTime per cloud works integration record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Model ID

Developer identifier: cloudworks_integrations.modelIdModel ID is the identifier of the Anaplan model associated with this integration. It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks integration records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies modelId as a record-level identifier on CloudWorksIntegration. It is not a uniqueness guarantee unless a connector directive says so.

Name

Developer identifier: cloudworks_integrations.nameName records human-readable name of the integration. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name value attached to each cloud works integration record.
Interpretation: The provider supplies name at cloud works integration granularity in the format stated by its description; omitted or redacted content remains unknown.

Notification

Developer identifier: cloudworks_integrations.notificationNotification records notification settings for integration run results. It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: enumerate the nested notification records contained by each cloud works integration record.
Interpretation: The provider returns notification as a nested object or reference on CloudWorksIntegration; an absent value does not prove that no related object exists outside the credential’s visibility.

Enabled

Developer identifier: cloudworks_integrations.notification.enabledEnabled indicates whether notifications are enabled for this integration. It preserves the provider-reported yes-or-no condition for this record.

Enables: select cloudworks integration records for which the provider reports enabled as true or false.
Interpretation: The provider supplies enabled as a boolean per integration notification record; false and missing are distinct when the field is optional.

Notify On Failure

Developer identifier: cloudworks_integrations.notification.notifyOnFailureNotify On Failure indicates whether to send notifications on failed runs. It preserves the provider-reported yes-or-no condition for this record.

Enables: select cloudworks integration records for which the provider reports notify on failure as true or false.
Interpretation: The provider supplies notifyOnFailure as a boolean per integration notification record; false and missing are distinct when the field is optional.

Notify On Success

Developer identifier: cloudworks_integrations.notification.notifyOnSuccessNotify On Success indicates whether to send notifications on successful runs. It preserves the provider-reported yes-or-no condition for this record.

Enables: select cloudworks integration records for which the provider reports notify on success as true or false.
Interpretation: The provider supplies notifyOnSuccess as a boolean per integration notification record; false and missing are distinct when the field is optional.

Recipients

Developer identifier: cloudworks_integrations.notification.recipientsRecipients records list of email addresses to receive notifications. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the integration notification record to the provider-reported person or account represented by recipients.
Interpretation: The provider supplies recipients as identity or attribution context on each integration notification record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Nux Visible

Developer identifier: cloudworks_integrations.nuxVisibleNux Visible indicates whether the integration is visible in the new user experience UI. It preserves the provider-reported yes-or-no condition for this record.

Enables: select cloudworks integration records for which the provider reports nux visible as true or false.
Interpretation: The provider supplies nuxVisible as a boolean per cloud works integration record; false and missing are distinct when the field is optional.

Run Count

Developer identifier: cloudworks_integrations.runCountRun Count reports the total number of times this integration has been executed. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported run count for each cloud works integration record.
Interpretation: The provider supplies runCount at cloud works integration granularity as a count at one value per record; zero and missing are not interchangeable.

Schedule

Developer identifier: cloudworks_integrations.scheduleSchedule records schedule configuration for automated runs of this integration, if any. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact schedule when validating the configuration or technical definition of a cloud works integration record.
Interpretation: The provider supplies schedule as configuration or technical metadata on CloudWorksIntegration; consumers must preserve the exact syntax and documented vocabulary.

Cron Expression

Developer identifier: cloudworks_integrations.schedule.cronExpressionCron Expression records cron expression defining the schedule, if applicable. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact cron expression when validating the configuration or technical definition of a integration schedule record.
Interpretation: The provider supplies cronExpression as configuration or technical metadata on IntegrationSchedule; consumers must preserve the exact syntax and documented vocabulary.

Days Of Month

Developer identifier: cloudworks_integrations.schedule.daysOfMonthDays Of Month records days of the month on which the schedule runs (for monthly schedules). It preserves the provider-defined period or schedule cadence for this record.

Enables: group cloudworks integration records by the provider-defined days of month period or schedule.
Interpretation: The provider supplies daysOfMonth per integration schedule record using its own period or schedule vocabulary; it is not an elapsed-duration measurement.

Days Of Week

Developer identifier: cloudworks_integrations.schedule.daysOfWeekDays Of Week records days of the week on which the schedule runs (for weekly schedules). It preserves the provider-defined period or schedule cadence for this record.

Enables: group cloudworks integration records by the provider-defined days of week period or schedule.
Interpretation: The provider supplies daysOfWeek per integration schedule record using its own period or schedule vocabulary; it is not an elapsed-duration measurement.

Enabled

Developer identifier: cloudworks_integrations.schedule.enabledEnabled indicates whether the schedule is currently active. It preserves the provider-reported yes-or-no condition for this record.

Enables: select cloudworks integration records for which the provider reports enabled as true or false.
Interpretation: The provider supplies enabled as a boolean per integration schedule record; false and missing are distinct when the field is optional.

End Date

Developer identifier: cloudworks_integrations.schedule.endDateEnd Date records ISO 8601 date or datetime when the schedule ends, if applicable. It anchors the named event or boundary on the record’s timeline.

Enables: place cloudworks integration records on a timeline by end date and select the records within an explicit reporting window.
Interpretation: The provider supplies endDate per integration schedule record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Interval Minutes

Developer identifier: cloudworks_integrations.schedule.intervalMinutesInterval Minutes reports interval in minutes between runs for interval-based schedules. It preserves the elapsed interval reported for this record.

Enables: compare the provider-recorded interval represented by interval minutes across cloudworks integration records.
Interpretation: The provider supplies intervalMinutes per integration schedule record in the unit stated by the provider description; it is an elapsed or recorded interval, not an outcome measure.

Schedule ID

Developer identifier: cloudworks_integrations.schedule.scheduleIdSchedule ID is the unique identifier for the schedule. It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks integration records to provider records that carry the same schedule ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies scheduleId as a record-level identifier on IntegrationSchedule. It is not a uniqueness guarantee unless a connector directive says so.

Start Date

Developer identifier: cloudworks_integrations.schedule.startDateStart Date records ISO 8601 date or datetime when the schedule begins. It anchors the named event or boundary on the record’s timeline.

Enables: place cloudworks integration records on a timeline by start date and select the records within an explicit reporting window.
Interpretation: The provider supplies startDate per integration schedule record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Time

Developer identifier: cloudworks_integrations.schedule.timeTime records time of day for scheduled execution (HH:mm format). It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact time when validating the configuration or technical definition of a integration schedule record.
Interpretation: The provider supplies time as configuration or technical metadata on IntegrationSchedule; consumers must preserve the exact syntax and documented vocabulary.

Timezone

Developer identifier: cloudworks_integrations.schedule.timezoneTimezone identifies IANA timezone identifier for the schedule (e.g., America/New_York). It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks integration records to provider records that carry the same timezone, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies timezone as a record-level identifier on IntegrationSchedule. It is not a uniqueness guarantee unless a connector directive says so.

Type

Developer identifier: cloudworks_integrations.schedule.typeType captures the recurrence type of the schedule. It preserves the provider’s current classification of this record.

Enables: separate cloudworks integration records by the exact provider-reported type value when describing their recorded state.
Interpretation: The provider supplies type per integration schedule record using its own state vocabulary; unknown and missing values must remain distinct.

Sources

Developer identifier: cloudworks_integrations.sourcesSources lists the configured origin endpoints that feed the integration. It preserves the input-side relationships of the CloudWorks data flow.

Enables: reconstruct which source connections and processes supply data to each integration.
Interpretation: The provider returns sources as a list of endpoint definitions on CloudWorksIntegration; an empty list and an omitted list are distinct.

Action ID

Developer identifier: cloudworks_integrations.sources.actionIdAction ID identifies Anaplan action identifier (import/export) for Anaplan-type endpoints. It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks integration records to provider records that carry the same action ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies actionId as a record-level identifier on IntegrationEndpoint. It is not a uniqueness guarantee unless a connector directive says so.

Bucket

Developer identifier: cloudworks_integrations.sources.bucketBucket records bucket or container name in the external cloud storage. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact bucket when validating the configuration or technical definition of a integration endpoint record.
Interpretation: The provider supplies bucket as configuration or technical metadata on IntegrationEndpoint; consumers must preserve the exact syntax and documented vocabulary.

Connection ID

Developer identifier: cloudworks_integrations.sources.connectionIdConnection ID is the identifier of the CloudWorks connection for external endpoints. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same integration endpoint source row before constructing its represented state.
Interpretation: The provider supplies connectionId at one value per integration endpoint record, and x-transformDedupKey explicitly marks it as the record key.

Dataset

Developer identifier: cloudworks_integrations.sources.datasetDataset records dataset name for BigQuery or similar database endpoints. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact dataset when validating the configuration or technical definition of a integration endpoint record.
Interpretation: The provider supplies dataset as configuration or technical metadata on IntegrationEndpoint; consumers must preserve the exact syntax and documented vocabulary.

File ID

Developer identifier: cloudworks_integrations.sources.fileIdFile ID identifies Anaplan file identifier for Anaplan-type endpoints. It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks integration records to provider records that carry the same file ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies fileId as a record-level identifier on IntegrationEndpoint. It is not a uniqueness guarantee unless a connector directive says so.

Model ID

Developer identifier: cloudworks_integrations.sources.modelIdModel ID identifies Anaplan model identifier for Anaplan-type endpoints. It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks integration records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies modelId as a record-level identifier on IntegrationEndpoint. It is not a uniqueness guarantee unless a connector directive says so.

Path

Developer identifier: cloudworks_integrations.sources.pathPath records file path or object key in the external cloud storage. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact path when validating the configuration or technical definition of a integration endpoint record.
Interpretation: The provider supplies path as configuration or technical metadata on IntegrationEndpoint; consumers must preserve the exact syntax and documented vocabulary.

Table

Developer identifier: cloudworks_integrations.sources.tableTable states table name for database-type endpoints. It preserves the provider’s current classification of this record.

Enables: separate cloudworks integration records by the exact provider-reported table value when describing their recorded state.
Interpretation: The provider supplies table per integration endpoint record using its own state vocabulary; unknown and missing values must remain distinct.

Type

Developer identifier: cloudworks_integrations.sources.typeType captures the endpoint type (e.g., ‘anaplan’, ‘s3’, ‘azureblob’, ‘bigquery’, ‘googlecloud’, ‘snowflake’). It preserves the provider’s current classification of this record.

Enables: separate cloudworks integration records by the exact provider-reported type value when describing their recorded state.
Interpretation: The provider supplies type per integration endpoint record using its own state vocabulary; unknown and missing values must remain distinct.

Status

Developer identifier: cloudworks_integrations.statusStatus states current status of the integration. It preserves the provider’s current classification of this record.

Enables: separate cloudworks integration records by the exact provider-reported status value when describing their recorded state.
Interpretation: The provider supplies status per cloud works integration record using its own state vocabulary; unknown and missing values must remain distinct.

Targets

Developer identifier: cloudworks_integrations.targetsTargets lists the configured destination endpoints that receive integration output. It preserves the output-side relationships of the CloudWorks data flow.

Enables: reconstruct which target connections and processes receive data from each integration.
Interpretation: The provider returns targets as a list of endpoint definitions on CloudWorksIntegration; an empty list and an omitted list are distinct.

Tenant ID

Developer identifier: cloudworks_integrations.tenantIdTenant ID is the identifier of the Anaplan tenant that owns this integration. It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks integration records to provider records that carry the same tenant ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies tenantId as a record-level identifier on CloudWorksIntegration. It is not a uniqueness guarantee unless a connector directive says so.

Type

Developer identifier: cloudworks_integrations.typeType captures the type/direction of the integration (e.g., import or export). It preserves the provider’s current classification of this record.

Enables: separate cloudworks integration records by the exact provider-reported type value when describing their recorded state.
Interpretation: The provider supplies type per cloud works integration record using its own state vocabulary; unknown and missing values must remain distinct.

Updated At

Developer identifier: cloudworks_integrations.updatedAtUpdated At records ISO 8601 timestamp when the integration was last updated. It anchors the named event or boundary on the record’s timeline.

Enables: place cloudworks integration records on a timeline by updated at and select the records within an explicit reporting window.
Interpretation: The provider supplies updatedAt per cloud works integration record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Updated By

Developer identifier: cloudworks_integrations.updatedByUpdated By records identifier or email of the user who last updated the integration. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the cloud works integration record to the provider-reported person or account represented by updated by.
Interpretation: The provider supplies updatedBy as identity or attribution context on each cloud works integration record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Version

Developer identifier: cloudworks_integrations.versionVersion identifies version identifier for the integration configuration. It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks integration records to provider records that carry the same version, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies version as a record-level identifier on CloudWorksIntegration. It is not a uniqueness guarantee unless a connector directive says so.

Workspace ID

Developer identifier: cloudworks_integrations.workspaceIdWorkspace ID is the identifier of the Anaplan workspace associated with this integration. It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks integration records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies workspaceId as a record-level identifier on CloudWorksIntegration. It is not a uniqueness guarantee unless a connector directive says so.

Cloudworks Run History

Developer identifier: cloudworks_run_historyCloudworks Run History contains CloudWorks integration run history records. Provides execution logs showing when integrations ran, their status, and duration.

Enables: compare integration executions by recorded status, start time, and duration.
Scope: Reads the declared collection through GET /cloudworks/2/0/integrations/{id}/runs as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.

Cancelled By

Developer identifier: cloudworks_run_history.cancelledByCancelled By records identifier or email of the user who cancelled the run, if applicable. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the cloud works run history record to the provider-reported person or account represented by cancelled by.
Interpretation: The provider supplies cancelledBy as identity or attribution context on each cloud works run history record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Completed At

Developer identifier: cloudworks_run_history.completedAtCompleted At states ISO 8601 timestamp indicating when the integration run completed. It preserves the provider’s current classification of this record.

Enables: separate cloudworks run history records by the exact provider-reported completed at value when describing their recorded state.
Interpretation: The provider supplies completedAt per cloud works run history record using its own state vocabulary; unknown and missing values must remain distinct.

Created At

Developer identifier: cloudworks_run_history.createdAtCreated At records ISO 8601 timestamp indicating when the run record was created. It anchors the named event or boundary on the record’s timeline.

Enables: place cloudworks run history records on a timeline by created at and select the records within an explicit reporting window.
Interpretation: The provider supplies createdAt per cloud works run history record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Duration

Developer identifier: cloudworks_run_history.durationDuration reports duration of the integration run in seconds. It preserves the elapsed interval reported for this record.

Enables: compare the provider-recorded interval represented by duration across cloudworks run history records.
Interpretation: The provider supplies duration per cloud works run history record in seconds; it is an elapsed or recorded interval, not an outcome measure.

Failed Count

Developer identifier: cloudworks_run_history.failedCountFailed Count reports the number of records or items that failed during the run. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported failed count for each cloud works run history record.
Interpretation: The provider supplies failedCount at cloud works run history granularity as a count at one value per record; zero and missing are not interchangeable.

Failure Dump Available

Developer identifier: cloudworks_run_history.failureDumpAvailableFailure Dump Available indicates whether a failure dump file is available for download. It preserves the provider-reported yes-or-no condition for this record.

Enables: select cloudworks run history records for which the provider reports failure dump available as true or false.
Interpretation: The provider supplies failureDumpAvailable as a boolean per cloud works run history record; false and missing are distinct when the field is optional.

Failure Reason

Developer identifier: cloudworks_run_history.failureReasonFailure Reason records description of the failure reason if the run did not succeed. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact failure reason value attached to each cloud works run history record.
Interpretation: The provider supplies failureReason at cloud works run history granularity in the format stated by its description; omitted or redacted content remains unknown.

Developer identifier: cloudworks_run_history.idID identifies parent key injected by the ingestor from the cloudworks_integrations to cloudworks_run_history traversal parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks run history records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies id as a record-level identifier on CloudWorksRunHistory. It is not a uniqueness guarantee unless a connector directive says so.

Ignored Count

Developer identifier: cloudworks_run_history.ignoredCountIgnored Count reports the number of records or items ignored during the run. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported ignored count for each cloud works run history record.
Interpretation: The provider supplies ignoredCount at cloud works run history granularity as a count at one value per record; zero and missing are not interchangeable.

Integration ID

Developer identifier: cloudworks_run_history.integrationIdIntegration ID is the identifier of the CloudWorks integration that was executed. It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks run history records to provider records that carry the same integration ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies integrationId as a record-level identifier on CloudWorksRunHistory. It is not a uniqueness guarantee unless a connector directive says so.

Integration Name

Developer identifier: cloudworks_run_history.integrationNameIntegration Name records human-readable name of the CloudWorks integration. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact integration name value attached to each cloud works run history record.
Interpretation: The provider supplies integrationName at cloud works run history granularity in the format stated by its description; omitted or redacted content remains unknown.

Progress

Developer identifier: cloudworks_run_history.progressProgress reports the integration run’s completion percentage from 0 to 100. It records how far execution advanced at the captured state.

Enables: distinguish completed, partial, and potentially stalled runs when reviewing run history.
Interpretation: The provider supplies progress as a numeric percentage per CloudWorks run; zero, a partial value, and missing are distinct.

Retry Count

Developer identifier: cloudworks_run_history.retryCountRetry Count reports the number of retry attempts made for this run. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported retry count for each cloud works run history record.
Interpretation: The provider supplies retryCount at cloud works run history granularity as a count at one value per record; zero and missing are not interchangeable.

Run ID

Developer identifier: cloudworks_run_history.runIdRun ID is the unique identifier for this specific integration run. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same cloud works run history source row before constructing its represented state.
Interpretation: The provider supplies runId at one value per cloud works run history record, and x-transformDedupKey explicitly marks it as the record key.

Schedule ID

Developer identifier: cloudworks_run_history.scheduleIdSchedule ID is the identifier of the schedule that triggered this run, if applicable. It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks run history records to provider records that carry the same schedule ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies scheduleId as a record-level identifier on CloudWorksRunHistory. It is not a uniqueness guarantee unless a connector directive says so.

Source Info

Developer identifier: cloudworks_run_history.sourceInfoSource Info identifies the source endpoint used by this integration run. It keeps execution history tied to the input-side connection and process details.

Enables: correlate a run’s outcome with the exact source configuration involved in that execution.
Interpretation: The provider returns sourceInfo as a nested RunEndpointInfo object; absence means no source detail was reported for the run.

Connection ID

Developer identifier: cloudworks_run_history.sourceInfo.connectionIdConnection ID is the identifier of the CloudWorks connection used. It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks run history records to provider records that carry the same connection ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies connectionId as a record-level identifier on RunEndpointInfo. It is not a uniqueness guarantee unless a connector directive says so.

Connection Name

Developer identifier: cloudworks_run_history.sourceInfo.connectionNameConnection Name records name of the CloudWorks connection. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact connection name value attached to each run endpoint info record.
Interpretation: The provider supplies connectionName at run endpoint info granularity in the format stated by its description; omitted or redacted content remains unknown.

File ID

Developer identifier: cloudworks_run_history.sourceInfo.fileIdFile ID is the identifier of the file involved in the integration, if applicable. It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks run history records to provider records that carry the same file ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies fileId as a record-level identifier on RunEndpointInfo. It is not a uniqueness guarantee unless a connector directive says so.

File Name

Developer identifier: cloudworks_run_history.sourceInfo.fileNameFile Name records name of the file involved in the integration, if applicable. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact file name value attached to each run endpoint info record.
Interpretation: The provider supplies fileName at run endpoint info granularity in the format stated by its description; omitted or redacted content remains unknown.

Model ID

Developer identifier: cloudworks_run_history.sourceInfo.modelIdModel ID identifies Anaplan model identifier, if the endpoint is an Anaplan model. It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks run history records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies modelId as a record-level identifier on RunEndpointInfo. It is not a uniqueness guarantee unless a connector directive says so.

Path

Developer identifier: cloudworks_run_history.sourceInfo.pathPath records path or bucket location for cloud storage endpoints. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact path when validating the configuration or technical definition of a run endpoint info record.
Interpretation: The provider supplies path as configuration or technical metadata on RunEndpointInfo; consumers must preserve the exact syntax and documented vocabulary.

Type

Developer identifier: cloudworks_run_history.sourceInfo.typeType states type of the endpoint, such as Anaplan, S3, Azure Blob, or Google BigQuery. It preserves the provider’s current classification of this record.

Enables: separate cloudworks run history records by the exact provider-reported type value when describing their recorded state.
Interpretation: The provider supplies type per run endpoint info record using its own state vocabulary; unknown and missing values must remain distinct.

Workspace ID

Developer identifier: cloudworks_run_history.sourceInfo.workspaceIdWorkspace ID identifies Anaplan workspace identifier, if the endpoint is an Anaplan model. It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks run history records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies workspaceId as a record-level identifier on RunEndpointInfo. It is not a uniqueness guarantee unless a connector directive says so.

Started At

Developer identifier: cloudworks_run_history.startedAtStarted At records ISO 8601 timestamp indicating when the integration run started. It anchors the named event or boundary on the record’s timeline.

Enables: place cloudworks run history records on a timeline by started at and select the records within an explicit reporting window.
Interpretation: The provider supplies startedAt per cloud works run history record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Started By

Developer identifier: cloudworks_run_history.startedByStarted By records identifier or email of the user or system that initiated the run. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the cloud works run history record to the provider-reported person or account represented by started by.
Interpretation: The provider supplies startedBy as identity or attribution context on each cloud works run history record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Status

Developer identifier: cloudworks_run_history.statusStatus states current status of the integration run. It preserves the provider’s current classification of this record.

Enables: separate cloudworks run history records by the exact provider-reported status value when describing their recorded state.
Interpretation: The provider supplies status per cloud works run history record using its own state vocabulary; unknown and missing values must remain distinct.

Successful Count

Developer identifier: cloudworks_run_history.successfulCountSuccessful Count reports the number of records or items successfully processed during the run. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported successful count for each cloud works run history record.
Interpretation: The provider supplies successfulCount at cloud works run history granularity as a count at one value per record; zero and missing are not interchangeable.

Target Info

Developer identifier: cloudworks_run_history.targetInfoTarget Info identifies the destination endpoint used by this integration run. It keeps execution history tied to the output-side connection and process details.

Enables: correlate a run’s outcome with the exact target configuration involved in that execution.
Interpretation: The provider returns targetInfo as a nested RunEndpointInfo object; absence means no target detail was reported for the run.

Task Details

Developer identifier: cloudworks_run_history.taskDetailsTask Details records list of individual task details within this integration run. It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: enumerate the nested task details records contained by each cloud works run history record.
Interpretation: The provider returns taskDetails as a list on CloudWorksRunHistory; an absent value does not prove that no related object exists outside the credential’s visibility.

Action ID

Developer identifier: cloudworks_run_history.taskDetails.actionIdAction ID is the identifier of the Anaplan action (import/export/process) executed by this task. It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks run history records to provider records that carry the same action ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies actionId as a record-level identifier on RunTaskDetail. It is not a uniqueness guarantee unless a connector directive says so.

Completed At

Developer identifier: cloudworks_run_history.taskDetails.completedAtCompleted At states ISO 8601 timestamp indicating when the task completed. It preserves the provider’s current classification of this record.

Enables: separate cloudworks run history records by the exact provider-reported completed at value when describing their recorded state.
Interpretation: The provider supplies completedAt per run task detail record using its own state vocabulary; unknown and missing values must remain distinct.

Failed Count

Developer identifier: cloudworks_run_history.taskDetails.failedCountFailed Count reports the number of records that failed in this task. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported failed count for each run task detail record.
Interpretation: The provider supplies failedCount at run task detail granularity as a count at one value per record; zero and missing are not interchangeable.

Failure Reason

Developer identifier: cloudworks_run_history.taskDetails.failureReasonFailure Reason records description of the failure reason for this task, if applicable. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact failure reason value attached to each run task detail record.
Interpretation: The provider supplies failureReason at run task detail granularity in the format stated by its description; omitted or redacted content remains unknown.

Ignored Count

Developer identifier: cloudworks_run_history.taskDetails.ignoredCountIgnored Count reports the number of records ignored by this task. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported ignored count for each run task detail record.
Interpretation: The provider supplies ignoredCount at run task detail granularity as a count at one value per record; zero and missing are not interchangeable.

Model ID

Developer identifier: cloudworks_run_history.taskDetails.modelIdModel ID is the identifier of the Anaplan model associated with this task. It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks run history records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies modelId as a record-level identifier on RunTaskDetail. It is not a uniqueness guarantee unless a connector directive says so.

Started At

Developer identifier: cloudworks_run_history.taskDetails.startedAtStarted At records ISO 8601 timestamp indicating when the task started. It anchors the named event or boundary on the record’s timeline.

Enables: place cloudworks run history records on a timeline by started at and select the records within an explicit reporting window.
Interpretation: The provider supplies startedAt per run task detail record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Successful Count

Developer identifier: cloudworks_run_history.taskDetails.successfulCountSuccessful Count reports the number of records successfully processed by this task. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported successful count for each run task detail record.
Interpretation: The provider supplies successfulCount at run task detail granularity as a count at one value per record; zero and missing are not interchangeable.

Task ID

Developer identifier: cloudworks_run_history.taskDetails.taskIdTask ID is the unique identifier for the task. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same run task detail source row before constructing its represented state.
Interpretation: The provider supplies taskId at one value per run task detail record, and x-transformDedupKey explicitly marks it as the record key.

Task Name

Developer identifier: cloudworks_run_history.taskDetails.taskNameTask Name records name of the task. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact task name value attached to each run task detail record.
Interpretation: The provider supplies taskName at run task detail granularity in the format stated by its description; omitted or redacted content remains unknown.

Task Status

Developer identifier: cloudworks_run_history.taskDetails.taskStatusTask Status states status of this individual task. It preserves the provider’s current classification of this record.

Enables: separate cloudworks run history records by the exact provider-reported task status value when describing their recorded state.
Interpretation: The provider supplies taskStatus per run task detail record using its own state vocabulary; unknown and missing values must remain distinct.

Task Type

Developer identifier: cloudworks_run_history.taskDetails.taskTypeTask Type states type of the task, such as import or export. It preserves the provider’s current classification of this record.

Enables: separate cloudworks run history records by the exact provider-reported task type value when describing their recorded state.
Interpretation: The provider supplies taskType per run task detail record using its own state vocabulary; unknown and missing values must remain distinct.

Workspace ID

Developer identifier: cloudworks_run_history.taskDetails.workspaceIdWorkspace ID is the identifier of the Anaplan workspace associated with this task. It is needed to resolve references that repeat the same provider identifier.

Enables: match cloudworks run history records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies workspaceId as a record-level identifier on RunTaskDetail. It is not a uniqueness guarantee unless a connector directive says so.

Total Count

Developer identifier: cloudworks_run_history.totalCountTotal Count reports the total number of records or items processed during the run. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported total count for each cloud works run history record.
Interpretation: The provider supplies totalCount at cloud works run history granularity as a count at one value per record; zero and missing are not interchangeable.

Trigger

Developer identifier: cloudworks_run_history.triggerTrigger states how the integration run was triggered. It preserves the provider’s current classification of this record.

Enables: separate cloudworks run history records by the exact provider-reported trigger value when describing their recorded state.
Interpretation: The provider supplies trigger per cloud works run history record using its own state vocabulary; unknown and missing values must remain distinct.

Updated At

Developer identifier: cloudworks_run_history.updatedAtUpdated At records ISO 8601 timestamp indicating when the run record was last updated. It anchors the named event or boundary on the record’s timeline.

Enables: place cloudworks run history records on a timeline by updated at and select the records within an explicit reporting window.
Interpretation: The provider supplies updatedAt per cloud works run history record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

List Items

Developer identifier: list_itemsList Items contain all items within a specific list (dimension members). These are the actual data records within Anaplan lists/hierarchies.

Enables: enumerate the dimension members contained by each Anaplan list.
Scope: Reads the declared collection through GET /2/0/workspaces/{workspaceId}/models/{modelId}/lists/{id}/items as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.

Code

Developer identifier: list_items.codeCode contains an optional external code assigned to the list item, often used for integration mapping with external systems. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact code when validating the configuration or technical definition of a anaplan list item record.
Interpretation: The provider supplies code as configuration or technical metadata on AnaplanListItem; consumers must preserve the exact syntax and documented vocabulary.

Developer identifier: list_items.idID captures the unique numeric identifier of the list item within the Anaplan model. This is the internal Anaplan item ID. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same anaplan list item source row before constructing its represented state.
Interpretation: The provider supplies id at one value per anaplan list item record, and x-transformDedupKey explicitly marks it as the record key.

Model ID

Developer identifier: list_items.modelIdModel ID identifies parent modelId injected by the ingestor from the model_lists to list_items traversal parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.

Enables: match list item records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies modelId as a record-level identifier on AnaplanListItem. It is not a uniqueness guarantee unless a connector directive says so.

Name

Developer identifier: list_items.nameName captures the display name of the list item. This is the human-readable label shown in Anaplan. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name value attached to each anaplan list item record.
Interpretation: The provider supplies name at anaplan list item granularity in the format stated by its description; omitted or redacted content remains unknown.

Parent

Developer identifier: list_items.parentParent captures the ID of the parent list item in a hierarchical list. Null or absent if the item is a top-level member. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the anaplan list item record to the provider-reported person or account represented by parent.
Interpretation: The provider supplies parent as identity or attribution context on each anaplan list item record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Parent Name

Developer identifier: list_items.parentNameParent Name captures the display name of the parent list item, if the list is hierarchical. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact parent name value attached to each anaplan list item record.
Interpretation: The provider supplies parentName at anaplan list item granularity in the format stated by its description; omitted or redacted content remains unknown.

Properties

Developer identifier: list_items.propertiesProperties contains a map of custom properties (list-level attributes) defined on the list, keyed by property name or ID. Contains values specific to this list item. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret properties according to the provider and Workspace configuration that produced each list item record.
Interpretation: Keys and value shapes within properties can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Additional Properties

Developer identifier: list_items.properties.additionalPropertiesAdditional Properties records each key represents a property name or ID defined on the list. The value contains the property’s current value for this list item. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact additional properties value attached to each list item property record.
Interpretation: The provider supplies additionalProperties at list item property granularity in the format stated by its description; omitted or redacted content remains unknown.

Developer identifier: list_items.properties.additionalProperties.idID identifies for properties that reference another list, the ID of the referenced list item. It is needed to resolve references that repeat the same provider identifier.

Enables: match list item records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies id as a record-level identifier on ListItemPropertyValue. It is not a uniqueness guarantee unless a connector directive says so.

Name

Developer identifier: list_items.properties.additionalProperties.nameName records for properties that reference another list, the name of the referenced list item. For text properties, the text value. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name value attached to each list item property value record.
Interpretation: The provider supplies name at list item property value granularity in the format stated by its description; omitted or redacted content remains unknown.

Type

Developer identifier: list_items.properties.additionalProperties.typeType captures the data type of the property value, such as TEXT, NUMBER, BOOLEAN, DATE, or LIST. It preserves the provider’s current classification of this record.

Enables: separate list item records by the exact provider-reported type value when describing their recorded state.
Interpretation: The provider supplies type per list item property value record using its own state vocabulary; unknown and missing values must remain distinct.

Value

Developer identifier: list_items.properties.additionalProperties.valueValue captures the raw value of the property, represented as a string. Numeric, boolean, and date values are serialized as strings. It anchors the named event or boundary on the record’s timeline.

Enables: place list item records on a timeline by value and select the records within an explicit reporting window.
Interpretation: The provider supplies value per list item property value record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Subsets

Developer identifier: list_items.subsetsSubsets contains a map of subset memberships for this list item, keyed by subset name or ID. Values indicate whether the item belongs to each subset. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact subsets value attached to each anaplan list item record.
Interpretation: The provider supplies subsets at anaplan list item granularity in the format stated by its description; omitted or redacted content remains unknown.

Additional Properties

Developer identifier: list_items.subsets.additionalPropertiesAdditional Properties records true if the list item belongs to the subset identified by the key, false otherwise. It preserves the provider-reported yes-or-no condition for this record.

Enables: select list item records for which the provider reports additional properties as true or false.
Interpretation: The provider supplies additionalProperties as a boolean per list item subset record; false and missing are distinct when the field is optional.

Workspace ID

Developer identifier: list_items.workspaceIdWorkspace ID identifies parent workspaceId injected by the ingestor from the model_lists to list_items traversal parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.

Enables: match list item records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies workspaceId as a record-level identifier on AnaplanListItem. It is not a uniqueness guarantee unless a connector directive says so.

Model Actions

Developer identifier: model_actionsModel Actions contain all actions (delete actions, other named actions) defined within a specific model.

Enables: catalog named actions available within each model.
Scope: Reads the declared collection through GET /2/0/workspaces/{workspaceId}/models/{id}/actions as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.

Action Type

Developer identifier: model_actions.actionTypeAction Type states action type code returned by the Anaplan actions API (for example DELETE_BY_SELECTION, ORDER_HIERARCHY). It preserves the provider’s current classification of this record.

Enables: separate model action records by the exact provider-reported action type value when describing their recorded state.
Interpretation: The provider supplies actionType per model action record using its own state vocabulary; unknown and missing values must remain distinct.

Developer identifier: model_actions.idID is the unique identifier of the action within the model. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same model action source row before constructing its represented state.
Interpretation: The provider supplies id at one value per model action record, and x-transformDedupKey explicitly marks it as the record key.

Model ID

Developer identifier: model_actions.modelIdModel ID identifies parent id injected by the ingestor from the workspace_models to model_actions traversal parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.

Enables: match model action records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies modelId as a record-level identifier on ModelAction. It is not a uniqueness guarantee unless a connector directive says so.

Module ID

Developer identifier: model_actions.moduleIdModule ID is the identifier of the module associated with this action, if applicable. It is needed to resolve references that repeat the same provider identifier.

Enables: match model action records to provider records that carry the same module ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies moduleId as a record-level identifier on ModelAction. It is not a uniqueness guarantee unless a connector directive says so.

Module Name

Developer identifier: model_actions.moduleNameModule Name records name of the module associated with this action, if applicable. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact module name value attached to each model action record.
Interpretation: The provider supplies moduleName at model action granularity in the format stated by its description; omitted or redacted content remains unknown.

Name

Developer identifier: model_actions.nameName records display name of the action. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name value attached to each model action record.
Interpretation: The provider supplies name at model action granularity in the format stated by its description; omitted or redacted content remains unknown.

Type

Developer identifier: model_actions.typeType states legacy/alternate type field when present. Live Integration API responses use actionType. It preserves the provider’s current classification of this record.

Enables: separate model action records by the exact provider-reported type value when describing their recorded state.
Interpretation: The provider supplies type per model action record using its own state vocabulary; unknown and missing values must remain distinct.

Workspace ID

Developer identifier: model_actions.workspaceIdWorkspace ID identifies parent workspaceId injected by the ingestor from the workspace_models to model_actions traversal parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.

Enables: match model action records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies workspaceId as a record-level identifier on ModelAction. It is not a uniqueness guarantee unless a connector directive says so.

Model Calendar

Developer identifier: model_calendarModel Calendar contains the calendar/time configuration for an Anaplan model, including fiscal year settings, time ranges, and period definitions. This is a model-level metadata object but returns structured time taxonomy data.

Enables: interpret model periods against the configured fiscal calendar and time ranges.
Scope: Reads the declared collection through GET /2/0/workspaces/{workspaceId}/models/{id}/modelCalendar as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.

Calendar Type

Developer identifier: model_calendar.calendarTypeCalendar Type captures the type of calendar used by the model. It preserves the provider’s current classification of this record.

Enables: separate model calendar records by the exact provider-reported calendar type value when describing their recorded state.
Interpretation: The provider supplies calendarType per model calendar record using its own state vocabulary; unknown and missing values must remain distinct.

Current Fiscal Year

Developer identifier: model_calendar.currentFiscalYearCurrent Fiscal Year records details about the current fiscal year. It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: expand the nested current fiscal year object into its declared child fields for each model calendar record.
Interpretation: The provider returns currentFiscalYear as a nested object or reference on ModelCalendar; an absent value does not prove that no related object exists outside the credential’s visibility.

End Date

Developer identifier: model_calendar.currentFiscalYear.endDateEnd Date captures the end date of the fiscal year in ISO 8601 format. It anchors the named event or boundary on the record’s timeline.

Enables: place model calendar records on a timeline by end date and select the records within an explicit reporting window.
Interpretation: The provider supplies endDate per fiscal year detail record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Name

Developer identifier: model_calendar.currentFiscalYear.nameName captures the display name of the fiscal year (e.g., ‘FY24’). It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name value attached to each fiscal year detail record.
Interpretation: The provider supplies name at fiscal year detail granularity in the format stated by its description; omitted or redacted content remains unknown.

Start Date

Developer identifier: model_calendar.currentFiscalYear.startDateStart Date captures the start date of the fiscal year in ISO 8601 format. It anchors the named event or boundary on the record’s timeline.

Enables: place model calendar records on a timeline by start date and select the records within an explicit reporting window.
Interpretation: The provider supplies startDate per fiscal year detail record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Year

Developer identifier: model_calendar.currentFiscalYear.yearYear identifies the calendar year mapped to the fiscal-year definition. It anchors the provider’s fiscal label to a calendar grouping.

Enables: align fiscal periods with calendar-year reporting and resolve labels such as FY24.
Interpretation: The provider supplies year as a calendar-year value, not a quantity or elapsed duration; missing means no calendar mapping was reported.

Current Period

Developer identifier: model_calendar.currentPeriodCurrent Period captures the current active time period in the model calendar. It preserves the provider’s current classification of this record.

Enables: separate model calendar records by the exact provider-reported current period value when describing their recorded state.
Interpretation: The provider supplies currentPeriod per model calendar record using its own state vocabulary; unknown and missing values must remain distinct.

End Date

Developer identifier: model_calendar.currentPeriod.endDateEnd Date records end date of the current period in ISO 8601 format. It anchors the named event or boundary on the record’s timeline.

Enables: place model calendar records on a timeline by end date and select the records within an explicit reporting window.
Interpretation: The provider supplies endDate per current period record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Developer identifier: model_calendar.currentPeriod.idID is the unique identifier of the current period. It is needed to resolve references that repeat the same provider identifier.

Enables: match model calendar records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies id as a record-level identifier on CurrentPeriod. It is not a uniqueness guarantee unless a connector directive says so.

Level

Developer identifier: model_calendar.currentPeriod.levelLevel captures the time level of the current period (e.g., ‘Month’, ‘Quarter’). It preserves the provider’s current classification of this record.

Enables: separate model calendar records by the exact provider-reported level value when describing their recorded state.
Interpretation: The provider supplies level per current period record using its own state vocabulary; unknown and missing values must remain distinct.

Name

Developer identifier: model_calendar.currentPeriod.nameName records display name of the current period (e.g., ‘Jan 24’, ‘Q1 FY24’). It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name value attached to each current period record.
Interpretation: The provider supplies name at current period granularity in the format stated by its description; omitted or redacted content remains unknown.

Start Date

Developer identifier: model_calendar.currentPeriod.startDateStart Date records start date of the current period in ISO 8601 format. It anchors the named event or boundary on the record’s timeline.

Enables: place model calendar records on a timeline by start date and select the records within an explicit reporting window.
Interpretation: The provider supplies startDate per current period record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Enabled

Developer identifier: model_calendar.enabledEnabled indicates whether the calendar/time dimension is enabled for the model. It preserves the provider-reported yes-or-no condition for this record.

Enables: select model calendar records for which the provider reports enabled as true or false.
Interpretation: The provider supplies enabled as a boolean per model calendar record; false and missing are distinct when the field is optional.

Fiscal Year

Developer identifier: model_calendar.fiscalYearFiscal Year records fiscal year configuration including start month and year offset settings. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact fiscal year when validating the configuration or technical definition of a model calendar record.
Interpretation: The provider supplies fiscalYear as configuration or technical metadata on ModelCalendar; consumers must preserve the exact syntax and documented vocabulary.

Fiscal Year Name Based On End Year

Developer identifier: model_calendar.fiscalYear.fiscalYearNameBasedOnEndYearFiscal Year Name Based On End Year records if true, the fiscal year is named based on the calendar year in which it ends; if false, based on the year in which it starts. It preserves the provider-reported yes-or-no condition for this record.

Enables: select model calendar records for which the provider reports fiscal year name based on end year as true or false.
Interpretation: The provider supplies fiscalYearNameBasedOnEndYear as a boolean per fiscal year config record; false and missing are distinct when the field is optional.

Start Month

Developer identifier: model_calendar.fiscalYear.startMonthStart Month captures the month in which the fiscal year begins. It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: expand the nested start month object into its declared child fields for each fiscal year config record.
Interpretation: The provider returns startMonth as a nested object or reference on FiscalYearConfig; an absent value does not prove that no related object exists outside the credential’s visibility.

Year Label

Developer identifier: model_calendar.fiscalYear.yearLabelYear Label captures the label format used for fiscal years (e.g., ‘FY’ prefix). It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact year label value attached to each fiscal year config record.
Interpretation: The provider supplies yearLabel at fiscal year config granularity in the format stated by its description; omitted or redacted content remains unknown.

Model ID

Developer identifier: model_calendar.modelIdModel ID identifies parent id injected by the ingestor from the workspace_models to model_calendar traversal parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same model calendar source row before constructing its represented state.
Interpretation: The provider supplies modelId at one value per model calendar record, and x-transformDedupKey explicitly marks it as the record key.

Periods

Developer identifier: model_calendar.periodsPeriods records list of period definitions configured in the model calendar (e.g., months, quarters, years). It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: expand the nested periods object into its declared child fields for each model calendar record.
Interpretation: The provider returns periods as a list on ModelCalendar; an absent value does not prove that no related object exists outside the credential’s visibility.

End Date

Developer identifier: model_calendar.periods.endDateEnd Date records end date of the period in ISO 8601 format. It anchors the named event or boundary on the record’s timeline.

Enables: place model calendar records on a timeline by end date and select the records within an explicit reporting window.
Interpretation: The provider supplies endDate per period definition record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Developer identifier: model_calendar.periods.idID is the unique identifier of the period. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same period definition source row before constructing its represented state.
Interpretation: The provider supplies id at one value per period definition record, and x-transformDedupKey explicitly marks it as the record key.

Is Current

Developer identifier: model_calendar.periods.isCurrentIs Current indicates whether this period is the current active period. It preserves the provider-reported yes-or-no condition for this record.

Enables: select model calendar records for which the provider reports is current as true or false.
Interpretation: The provider supplies isCurrent as a boolean per period definition record; false and missing are distinct when the field is optional.

Level

Developer identifier: model_calendar.periods.levelLevel captures the time level this period belongs to (e.g., ‘Month’, ‘Quarter’, ‘Year’). It preserves the provider’s current classification of this record.

Enables: separate model calendar records by the exact provider-reported level value when describing their recorded state.
Interpretation: The provider supplies level per period definition record using its own state vocabulary; unknown and missing values must remain distinct.

Name

Developer identifier: model_calendar.periods.nameName records display name of the period (e.g., ‘Jan 23’, ‘Q2 FY24’, ‘FY24’). It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name value attached to each period definition record.
Interpretation: The provider supplies name at period definition granularity in the format stated by its description; omitted or redacted content remains unknown.

Order

Developer identifier: model_calendar.periods.orderOrder reports sort order of the period within its level. It preserves the stated measure at this record’s granularity.

Enables: order or classify model calendar records using the provider-defined order value.
Interpretation: The provider supplies order at period definition granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.

Parent ID

Developer identifier: model_calendar.periods.parentIdParent ID is the identifier of the parent period in the time hierarchy (e.g., a month’s parent quarter). It is needed to resolve references that repeat the same provider identifier.

Enables: match model calendar records to provider records that carry the same parent ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies parentId as a record-level identifier on PeriodDefinition. It is not a uniqueness guarantee unless a connector directive says so.

Start Date

Developer identifier: model_calendar.periods.startDateStart Date records start date of the period in ISO 8601 format. It anchors the named event or boundary on the record’s timeline.

Enables: place model calendar records on a timeline by start date and select the records within an explicit reporting window.
Interpretation: The provider supplies startDate per period definition record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Time Dimension

Developer identifier: model_calendar.timeDimensionTime Dimension captures the time dimension definition for the model. It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: reconstruct the declared time dimension layout or dimensional scope of each model calendar record.
Interpretation: The provider returns timeDimension as a nested object or reference on ModelCalendar; an absent value does not prove that no related object exists outside the credential’s visibility.

Developer identifier: model_calendar.timeDimension.idID is the unique identifier of the time dimension. It is needed to resolve references that repeat the same provider identifier.

Enables: match model calendar records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies id as a record-level identifier on TimeDimension. It is not a uniqueness guarantee unless a connector directive says so.

Name

Developer identifier: model_calendar.timeDimension.nameName records name of the time dimension. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name value attached to each time dimension record.
Interpretation: The provider supplies name at time dimension granularity in the format stated by its description; omitted or redacted content remains unknown.

Time Levels

Developer identifier: model_calendar.timeLevelsTime Levels records hierarchy of time levels available in the model (e.g., Day, Week, Month, Quarter, Half Year, Year). It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: reconstruct the parent-child structure expressed by time levels on each model calendar record.
Interpretation: The provider returns timeLevels as a list on ModelCalendar; an absent value does not prove that no related object exists outside the credential’s visibility.

Enabled

Developer identifier: model_calendar.timeLevels.enabledEnabled indicates whether this time level is enabled in the model. It preserves the provider-reported yes-or-no condition for this record.

Enables: select model calendar records for which the provider reports enabled as true or false.
Interpretation: The provider supplies enabled as a boolean per time level record; false and missing are distinct when the field is optional.

Developer identifier: model_calendar.timeLevels.idID is the unique identifier of the time level. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same time level source row before constructing its represented state.
Interpretation: The provider supplies id at one value per time level record, and x-transformDedupKey explicitly marks it as the record key.

Name

Developer identifier: model_calendar.timeLevels.nameName records name of the time level (e.g., ‘Month’, ‘Quarter’, ‘Year’). It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name value attached to each time level record.
Interpretation: The provider supplies name at time level granularity in the format stated by its description; omitted or redacted content remains unknown.

Order

Developer identifier: model_calendar.timeLevels.orderOrder reports hierarchical order of the time level, with lower values being more granular. It preserves the stated measure at this record’s granularity.

Enables: order or classify model calendar records using the provider-defined order value.
Interpretation: The provider supplies order at time level granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.

Periods Per Year

Developer identifier: model_calendar.timeLevels.periodsPerYearPeriods Per Year reports the number of periods of this level per year (e.g., 12 for months, 4 for quarters). It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported periods per year for each time level record.
Interpretation: The provider supplies periodsPerYear at time level granularity as a count at one value per record; zero and missing are not interchangeable.

Time Range

Developer identifier: model_calendar.timeRangeTime Range captures the overall time range configured for the model. It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: expand the nested time range object into its declared child fields for each model calendar record.
Interpretation: The provider returns timeRange as a nested object or reference on ModelCalendar; an absent value does not prove that no related object exists outside the credential’s visibility.

End Date

Developer identifier: model_calendar.timeRange.endDateEnd Date captures the end date of the model’s time range in ISO 8601 format. It anchors the named event or boundary on the record’s timeline.

Enables: place model calendar records on a timeline by end date and select the records within an explicit reporting window.
Interpretation: The provider supplies endDate per time range record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

End Period

Developer identifier: model_calendar.timeRange.endPeriodEnd Period captures the name or identifier of the last period in the time range. It is needed to resolve references that repeat the same provider identifier.

Enables: match model calendar records to provider records that carry the same end period, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies endPeriod as a record-level identifier on TimeRange. It is not a uniqueness guarantee unless a connector directive says so.

Future Years

Developer identifier: model_calendar.timeRange.futureYearsFuture Years reports the number of future years included in the time range relative to the current year. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported future years for each time range record.
Interpretation: The provider supplies futureYears at time range granularity as a count at one value per record; zero and missing are not interchangeable.

Number Of Years

Developer identifier: model_calendar.timeRange.numberOfYearsNumber Of Years reports the total number of years spanned by the time range. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported number of years for each time range record.
Interpretation: The provider supplies numberOfYears at time range granularity as a count at one value per record; zero and missing are not interchangeable.

Past Years

Developer identifier: model_calendar.timeRange.pastYearsPast Years reports the number of past years included in the time range relative to the current year. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported past years for each time range record.
Interpretation: The provider supplies pastYears at time range granularity as a count at one value per record; zero and missing are not interchangeable.

Start Date

Developer identifier: model_calendar.timeRange.startDateStart Date captures the start date of the model’s time range in ISO 8601 format. It anchors the named event or boundary on the record’s timeline.

Enables: place model calendar records on a timeline by start date and select the records within an explicit reporting window.
Interpretation: The provider supplies startDate per time range record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Start Period

Developer identifier: model_calendar.timeRange.startPeriodStart Period captures the name or identifier of the first period in the time range. It is needed to resolve references that repeat the same provider identifier.

Enables: match model calendar records to provider records that carry the same start period, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies startPeriod as a record-level identifier on TimeRange. It is not a uniqueness guarantee unless a connector directive says so.

Workspace ID

Developer identifier: model_calendar.workspaceIdWorkspace ID identifies parent workspaceId injected by the ingestor from the workspace_models to model_calendar traversal parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.

Enables: match model calendar records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies workspaceId as a record-level identifier on ModelCalendar. It is not a uniqueness guarantee unless a connector directive says so.

Year Range

Developer identifier: model_calendar.yearRangeYear Range captures the range of years covered by the model calendar. It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: expand the nested year range object into its declared child fields for each model calendar record.
Interpretation: The provider returns yearRange as a nested object or reference on ModelCalendar; an absent value does not prove that no related object exists outside the credential’s visibility.

End Year

Developer identifier: model_calendar.yearRange.endYearEnd Year identifies the last calendar year included in the model’s time range. It marks the closing boundary of the configured planning horizon.

Enables: determine whether forecast periods required for analysis fall within the model calendar.
Interpretation: The provider supplies endYear as a calendar-year boundary, not a count or duration; missing means the upper boundary was not reported.

Start Year

Developer identifier: model_calendar.yearRange.startYearStart Year identifies the first calendar year included in the model’s time range. It marks the opening boundary of the configured planning horizon.

Enables: determine whether historical periods required for analysis fall within the model calendar.
Interpretation: The provider supplies startYear as a calendar-year boundary, not a count or duration; missing means the lower boundary was not reported.

Model Exports

Developer identifier: model_exportsModel Exports contain all export action definitions within a specific model. Export actions define data extractions from Anaplan modules/views.

Enables: review the export actions configured to extract data from a model.
Scope: Reads the declared collection through GET /2/0/workspaces/{workspaceId}/models/{id}/exports as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.

Column Count

Developer identifier: model_exports.columnCountColumn Count reports the number of columns in the export output, if available. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported column count for each model export record.
Interpretation: The provider supplies columnCount at model export granularity as a count at one value per record; zero and missing are not interchangeable.

Columns

Developer identifier: model_exports.columnsColumns records definitions of the columns included in the export output. It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: reconstruct the declared columns layout or dimensional scope of each model export record.
Interpretation: The provider returns columns as a list on ModelExport; an absent value does not prove that no related object exists outside the credential’s visibility.

Column Index

Developer identifier: model_exports.columns.columnIndexColumn Index reports zero-based index position of the column in the export output. It preserves the stated measure at this record’s granularity.

Enables: order or classify model export records using the provider-defined column index value.
Interpretation: The provider supplies columnIndex at export column granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.

Custom Header Name

Developer identifier: model_exports.columns.customHeaderNameCustom Header Name records custom header name assigned to this column, if any. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom header name according to the provider and Workspace configuration that produced each model export record.
Interpretation: Keys and value shapes within customHeaderName can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Data Type

Developer identifier: model_exports.columns.dataTypeData Type states data type of the column values, e.g., TEXT, NUMBER, BOOLEAN, DATE, LIST. It preserves the provider’s current classification of this record.

Enables: separate model export records by the exact provider-reported data type value when describing their recorded state.
Interpretation: The provider supplies dataType per export column record using its own state vocabulary; unknown and missing values must remain distinct.

Dimension ID

Developer identifier: model_exports.columns.dimensionIdDimension ID is the identifier of the dimension this column represents, if applicable. It is needed to resolve references that repeat the same provider identifier.

Enables: match model export records to provider records that carry the same dimension ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies dimensionId as a record-level identifier on ExportColumn. It is not a uniqueness guarantee unless a connector directive says so.

Dimension Name

Developer identifier: model_exports.columns.dimensionNameDimension Name records name of the dimension this column represents. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact dimension name value attached to each export column record.
Interpretation: The provider supplies dimensionName at export column granularity in the format stated by its description; omitted or redacted content remains unknown.

Line Item ID

Developer identifier: model_exports.columns.lineItemIdLine Item ID is the identifier of the line item this column represents, if applicable. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same export column source row before constructing its represented state.
Interpretation: The provider supplies lineItemId at one value per export column record, and x-transformDedupKey explicitly marks it as the record key.

Line Item Name

Developer identifier: model_exports.columns.lineItemNameLine Item Name records name of the line item this column represents, if applicable. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact line item name value attached to each export column record.
Interpretation: The provider supplies lineItemName at export column granularity in the format stated by its description; omitted or redacted content remains unknown.

Created At

Developer identifier: model_exports.createdAtCreated At records ISO 8601 timestamp when the export action was created. It anchors the named event or boundary on the record’s timeline.

Enables: place model export records on a timeline by created at and select the records within an explicit reporting window.
Interpretation: The provider supplies createdAt per model export record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Created By

Developer identifier: model_exports.createdByCreated By records identifier or name of the user who created the export action. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the model export record to the provider-reported person or account represented by created by.
Interpretation: The provider supplies createdBy as identity or attribution context on each model export record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Data Row

Developer identifier: model_exports.dataRowData Row identifies the row position where exported data begins. It separates header material from the records intended for parsing.

Enables: start export ingestion at the provider-declared data boundary without treating preceding rows as data.
Interpretation: The provider supplies dataRow as a row position, not a count or business measure; zero and missing are not interchangeable.

Delimiter

Developer identifier: model_exports.delimiterDelimiter records text qualifier/delimiter used to wrap field values, e.g., ’”’. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact delimiter when validating the configuration or technical definition of a model export record.
Interpretation: The provider supplies delimiter as configuration or technical metadata on ModelExport; consumers must preserve the exact syntax and documented vocabulary.

Encoding

Developer identifier: model_exports.encodingEncoding records character encoding used for the export output, e.g., ‘UTF-8’. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact encoding when validating the configuration or technical definition of a model export record.
Interpretation: The provider supplies encoding as configuration or technical metadata on ModelExport; consumers must preserve the exact syntax and documented vocabulary.

Export Format

Developer identifier: model_exports.exportFormatExport Format captures the output format of the exported data. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact export format when validating the configuration or technical definition of a model export record.
Interpretation: The provider supplies exportFormat as configuration or technical metadata on ModelExport; consumers must preserve the exact syntax and documented vocabulary.

Export Type

Developer identifier: model_exports.exportTypeExport Type captures the type of export, indicating what kind of data source is being exported. It preserves the provider’s current classification of this record.

Enables: separate model export records by the exact provider-reported export type value when describing their recorded state.
Interpretation: The provider supplies exportType per model export record using its own state vocabulary; unknown and missing values must remain distinct.

Header Row

Developer identifier: model_exports.headerRowHeader Row records row number that contains column headers in the export output. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact header row when validating the configuration or technical definition of a model export record.
Interpretation: The provider supplies headerRow as configuration or technical metadata on ModelExport; consumers must preserve the exact syntax and documented vocabulary.

Developer identifier: model_exports.idID is the unique identifier for the export action definition. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same model export source row before constructing its represented state.
Interpretation: The provider supplies id at one value per model export record, and x-transformDedupKey explicitly marks it as the record key.

Last Modified At

Developer identifier: model_exports.lastModifiedAtLast Modified At records ISO 8601 timestamp when the export action was last modified. It anchors the named event or boundary on the record’s timeline.

Enables: place model export records on a timeline by last modified at and select the records within an explicit reporting window.
Interpretation: The provider supplies lastModifiedAt per model export record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Last Modified By

Developer identifier: model_exports.lastModifiedByLast Modified By records identifier or name of the user who last modified the export action. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the model export record to the provider-reported person or account represented by last modified by.
Interpretation: The provider supplies lastModifiedBy as identity or attribution context on each model export record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Layout

Developer identifier: model_exports.layoutLayout captures the layout type of the export, such as grid or tabular. It preserves the provider’s current classification of this record.

Enables: separate model export records by the exact provider-reported layout value when describing their recorded state.
Interpretation: The provider supplies layout per model export record using its own state vocabulary; unknown and missing values must remain distinct.

Line Items

Developer identifier: model_exports.lineItemsLine Items records line item identifiers included in the export, if applicable. It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: reconstruct the declared line items layout or dimensional scope of each model export record.
Interpretation: The provider returns lineItems as a list on ModelExport; an absent value does not prove that no related object exists outside the credential’s visibility.

List ID

Developer identifier: model_exports.listIdList ID is the identifier of the list being exported, if the export type is a list export. It is needed to resolve references that repeat the same provider identifier.

Enables: match model export records to provider records that carry the same list ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies listId as a record-level identifier on ModelExport. It is not a uniqueness guarantee unless a connector directive says so.

List Name

Developer identifier: model_exports.listNameList Name states name of the list being exported, if the export type is a list export. It preserves the provider’s current classification of this record.

Enables: separate model export records by the exact provider-reported list name value when describing their recorded state.
Interpretation: The provider supplies listName per model export record using its own state vocabulary; unknown and missing values must remain distinct.

Model ID

Developer identifier: model_exports.modelIdModel ID identifies parent id injected by the ingestor from the workspace_models to model_exports traversal parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.

Enables: match model export records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies modelId as a record-level identifier on ModelExport. It is not a uniqueness guarantee unless a connector directive says so.

Module ID

Developer identifier: model_exports.moduleIdModule ID is the identifier of the source module from which data is exported. It is needed to resolve references that repeat the same provider identifier.

Enables: match model export records to provider records that carry the same module ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies moduleId as a record-level identifier on ModelExport. It is not a uniqueness guarantee unless a connector directive says so.

Module Name

Developer identifier: model_exports.moduleNameModule Name records name of the source module from which data is exported. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact module name value attached to each model export record.
Interpretation: The provider supplies moduleName at model export granularity in the format stated by its description; omitted or redacted content remains unknown.

Name

Developer identifier: model_exports.nameName records display name of the export action. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name value attached to each model export record.
Interpretation: The provider supplies name at model export granularity in the format stated by its description; omitted or redacted content remains unknown.

Pages

Developer identifier: model_exports.pagesPages records page dimension filters applied to the export, if any. It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: reconstruct the declared pages layout or dimensional scope of each model export record.
Interpretation: The provider returns pages as a list on ModelExport; an absent value does not prove that no related object exists outside the credential’s visibility.

Dimension ID

Developer identifier: model_exports.pages.dimensionIdDimension ID is the identifier of the dimension used as a page filter. It is needed to resolve references that repeat the same provider identifier.

Enables: match model export records to provider records that carry the same dimension ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies dimensionId as a record-level identifier on ExportPage. It is not a uniqueness guarantee unless a connector directive says so.

Dimension Name

Developer identifier: model_exports.pages.dimensionNameDimension Name records name of the dimension used as a page filter. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact dimension name value attached to each export page record.
Interpretation: The provider supplies dimensionName at export page granularity in the format stated by its description; omitted or redacted content remains unknown.

Item ID

Developer identifier: model_exports.pages.itemIdItem ID is the identifier of the selected item within the page dimension. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same export page source row before constructing its represented state.
Interpretation: The provider supplies itemId at one value per export page record, and x-transformDedupKey explicitly marks it as the record key.

Item Name

Developer identifier: model_exports.pages.itemNameItem Name records name of the selected item within the page dimension. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact item name value attached to each export page record.
Interpretation: The provider supplies itemName at export page granularity in the format stated by its description; omitted or redacted content remains unknown.

Row Count

Developer identifier: model_exports.rowCountRow Count reports the number of rows in the export output, if available. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported row count for each model export record.
Interpretation: The provider supplies rowCount at model export granularity as a count at one value per record; zero and missing are not interchangeable.

Separator

Developer identifier: model_exports.separatorSeparator records column separator/delimiter used in the export output, e.g., ’,’ or ‘\t’. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact separator when validating the configuration or technical definition of a model export record.
Interpretation: The provider supplies separator as configuration or technical metadata on ModelExport; consumers must preserve the exact syntax and documented vocabulary.

View ID

Developer identifier: model_exports.viewIdView ID is the identifier of the saved view used for the export, if applicable. It is needed to resolve references that repeat the same provider identifier.

Enables: match model export records to provider records that carry the same view ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies viewId as a record-level identifier on ModelExport. It is not a uniqueness guarantee unless a connector directive says so.

View Name

Developer identifier: model_exports.viewNameView Name records name of the saved view used for the export, if applicable. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact view name value attached to each model export record.
Interpretation: The provider supplies viewName at model export granularity in the format stated by its description; omitted or redacted content remains unknown.

Workspace ID

Developer identifier: model_exports.workspaceIdWorkspace ID identifies parent workspaceId injected by the ingestor from the workspace_models to model_exports traversal parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.

Enables: match model export records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies workspaceId as a record-level identifier on ModelExport. It is not a uniqueness guarantee unless a connector directive says so.

Model Files

Developer identifier: model_filesModel Files contain all files (data sources and export outputs) within a specific model.

Enables: trace model data-source and export-output files to their parent model.
Scope: Reads the declared collection through GET /2/0/workspaces/{workspaceId}/models/{id}/files as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.

Chunk Count

Developer identifier: model_files.chunkCountChunk Count captures the number of chunks the file is divided into for upload/download. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported chunk count for each model file record.
Interpretation: The provider supplies chunkCount at model file granularity as a count at one value per record; zero and missing are not interchangeable.

Code

Developer identifier: model_files.codeCode contains an optional code or identifier associated with the file. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact code when validating the configuration or technical definition of a model file record.
Interpretation: The provider supplies code as configuration or technical metadata on ModelFile; consumers must preserve the exact syntax and documented vocabulary.

Delimiter

Developer identifier: model_files.delimiterDelimiter captures the column delimiter used in the file (e.g., comma, tab). It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact delimiter when validating the configuration or technical definition of a model file record.
Interpretation: The provider supplies delimiter as configuration or technical metadata on ModelFile; consumers must preserve the exact syntax and documented vocabulary.

Description

Developer identifier: model_files.descriptionDescription contains a human-readable description of the file. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact description value attached to each model file record.
Interpretation: The provider supplies description at model file granularity in the format stated by its description; omitted or redacted content remains unknown.

Encoding

Developer identifier: model_files.encodingEncoding captures the character encoding of the file (e.g., UTF-8). It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact encoding when validating the configuration or technical definition of a model file record.
Interpretation: The provider supplies encoding as configuration or technical metadata on ModelFile; consumers must preserve the exact syntax and documented vocabulary.

First Data Row

Developer identifier: model_files.firstDataRowFirst Data Row identifies the zero-based row where file data begins after any headers. It preserves the parsing boundary recorded for the model file.

Enables: skip header rows and begin processing at the same row position Anaplan uses.
Interpretation: The provider supplies firstDataRow as a zero-based row index, not a row count; zero means the first row and missing means no boundary was reported.

Format

Developer identifier: model_files.formatFormat captures the format of the file content (e.g., txt, csv). It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact format when validating the configuration or technical definition of a model file record.
Interpretation: The provider supplies format as configuration or technical metadata on ModelFile; consumers must preserve the exact syntax and documented vocabulary.

Header Row

Developer identifier: model_files.headerRowHeader Row captures the row number that contains column headers (0-indexed). It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact header row when validating the configuration or technical definition of a model file record.
Interpretation: The provider supplies headerRow as configuration or technical metadata on ModelFile; consumers must preserve the exact syntax and documented vocabulary.

Developer identifier: model_files.idID captures the unique identifier of the file within the model. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same model file source row before constructing its represented state.
Interpretation: The provider supplies id at one value per model file record, and x-transformDedupKey explicitly marks it as the record key.

Model ID

Developer identifier: model_files.modelIdModel ID identifies parent model id injected by the ingestor when iterating per-model. Not part of the upstream Anaplan API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.

Enables: match model file records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies modelId as a record-level identifier on ModelFile. It is not a uniqueness guarantee unless a connector directive says so.

Name

Developer identifier: model_files.nameName captures the display name of the file. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name value attached to each model file record.
Interpretation: The provider supplies name at model file granularity in the format stated by its description; omitted or redacted content remains unknown.

Origin

Developer identifier: model_files.originOrigin carries the provider-reported origin for each model file record. It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: expand the nested origin object into its declared child fields for each model file record.
Interpretation: The provider returns origin as a nested object or reference on ModelFile; an absent value does not prove that no related object exists outside the credential’s visibility.

Action Name

Developer identifier: model_files.origin.actionNameAction Name captures the name of the action (import or export) that produced or consumes this file. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact action name value attached to each file origin record.
Interpretation: The provider supplies actionName at file origin granularity in the format stated by its description; omitted or redacted content remains unknown.

Export ID

Developer identifier: model_files.origin.exportIdExport ID captures the identifier of the export action associated with this file, if applicable. It is needed to resolve references that repeat the same provider identifier.

Enables: match model file records to provider records that carry the same export ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies exportId as a record-level identifier on FileOrigin. It is not a uniqueness guarantee unless a connector directive says so.

Import ID

Developer identifier: model_files.origin.importIdImport ID captures the identifier of the import action associated with this file, if applicable. It is needed to resolve references that repeat the same provider identifier.

Enables: match model file records to provider records that carry the same import ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies importId as a record-level identifier on FileOrigin. It is not a uniqueness guarantee unless a connector directive says so.

Type

Developer identifier: model_files.origin.typeType carries the source state or classification named Type for each file origin row. It preserves the provider’s current classification of this record.

Enables: separate model file records by the exact provider-reported type value when describing their recorded state.
Interpretation: The provider supplies type per file origin record using its own state vocabulary; unknown and missing values must remain distinct.

Separator

Developer identifier: model_files.separatorSeparator captures the separator character used in the file, such as a line separator or record delimiter. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact separator when validating the configuration or technical definition of a model file record.
Interpretation: The provider supplies separator as configuration or technical metadata on ModelFile; consumers must preserve the exact syntax and documented vocabulary.

Workspace ID

Developer identifier: model_files.workspaceIdWorkspace ID identifies parent workspace id injected by the ingestor when iterating per-workspace. Not part of the upstream Anaplan API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.

Enables: match model file records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies workspaceId as a record-level identifier on ModelFile. It is not a uniqueness guarantee unless a connector directive says so.

Model Imports

Developer identifier: model_importsModel Imports contain all import action definitions within a specific model. Import actions define data loading configurations into Anaplan.

Enables: review the import actions configured to load data into a model.
Scope: Reads the declared collection through GET /2/0/workspaces/{workspaceId}/models/{id}/imports as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.

Code

Developer identifier: model_imports.codeCode records optional user-defined code for the import action. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret code according to the provider and Workspace configuration that produced each model import record.
Interpretation: Keys and value shapes within code can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Column Mappings

Developer identifier: model_imports.columnMappingsColumn Mappings lists the relationships from source columns to target dimensions or line items. It preserves the import mapping needed to explain where each input value lands.

Enables: reconstruct and audit source-to-target assignments for each model import.
Interpretation: The provider supplies columnMappings as a list of mapping objects; an empty list and a missing mapping declaration are distinct.

Column Index

Developer identifier: model_imports.columnMappings.columnIndexColumn Index reports zero-based index of the source column. It preserves the stated measure at this record’s granularity.

Enables: order or classify model import records using the provider-defined column index value.
Interpretation: The provider supplies columnIndex at column mapping granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.

Column Name

Developer identifier: model_imports.columnMappings.columnNameColumn Name identifies name of the source column being mapped. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same column mapping source row before constructing its represented state.
Interpretation: The provider supplies columnName at one value per column mapping record, and x-transformDedupKey explicitly marks it as the record key.

Date Format

Developer identifier: model_imports.columnMappings.dateFormatDate Format records the date format pattern applied when the column contains date values. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact date format when validating the configuration or technical definition of a column mapping record.
Interpretation: The provider supplies dateFormat as configuration or technical metadata on ColumnMapping; consumers must preserve the exact syntax and documented vocabulary.

Ignored

Developer identifier: model_imports.columnMappings.ignoredIgnored indicates whether this source column is ignored and not mapped to any target. It preserves the provider-reported yes-or-no condition for this record.

Enables: select model import records for which the provider reports ignored as true or false.
Interpretation: The provider supplies ignored as a boolean per column mapping record; false and missing are distinct when the field is optional.

Mapping Type

Developer identifier: model_imports.columnMappings.mappingTypeMapping Type captures the type of mapping applied to this column. It preserves the provider’s current classification of this record.

Enables: separate model import records by the exact provider-reported mapping type value when describing their recorded state.
Interpretation: The provider supplies mappingType per column mapping record using its own state vocabulary; unknown and missing values must remain distinct.

Target Dimension ID

Developer identifier: model_imports.columnMappings.targetDimensionIdTarget Dimension ID is the identifier of the target dimension this column maps to. It is needed to resolve references that repeat the same provider identifier.

Enables: match model import records to provider records that carry the same target dimension ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies targetDimensionId as a record-level identifier on ColumnMapping. It is not a uniqueness guarantee unless a connector directive says so.

Target Dimension Name

Developer identifier: model_imports.columnMappings.targetDimensionNameTarget Dimension Name records name of the target dimension this column maps to. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact target dimension name value attached to each column mapping record.
Interpretation: The provider supplies targetDimensionName at column mapping granularity in the format stated by its description; omitted or redacted content remains unknown.

Target Line Item ID

Developer identifier: model_imports.columnMappings.targetLineItemIdTarget Line Item ID is the identifier of the target line item this column maps to. It is needed to resolve references that repeat the same provider identifier.

Enables: match model import records to provider records that carry the same target line item ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies targetLineItemId as a record-level identifier on ColumnMapping. It is not a uniqueness guarantee unless a connector directive says so.

Target Line Item Name

Developer identifier: model_imports.columnMappings.targetLineItemNameTarget Line Item Name records name of the target line item this column maps to. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact target line item name value attached to each column mapping record.
Interpretation: The provider supplies targetLineItemName at column mapping granularity in the format stated by its description; omitted or redacted content remains unknown.

Target Property Name

Developer identifier: model_imports.columnMappings.targetPropertyNameTarget Property Name records name of the target property (for list imports) this column maps to. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact target property name value attached to each column mapping record.
Interpretation: The provider supplies targetPropertyName at column mapping granularity in the format stated by its description; omitted or redacted content remains unknown.

Delimiter

Developer identifier: model_imports.delimiterDelimiter captures the delimiter character used in the source file (e.g., comma, tab). It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact delimiter when validating the configuration or technical definition of a model import record.
Interpretation: The provider supplies delimiter as configuration or technical metadata on ModelImport; consumers must preserve the exact syntax and documented vocabulary.

Encoding

Developer identifier: model_imports.encodingEncoding records character encoding of the source file (e.g., UTF-8). It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact encoding when validating the configuration or technical definition of a model import record.
Interpretation: The provider supplies encoding as configuration or technical metadata on ModelImport; consumers must preserve the exact syntax and documented vocabulary.

First Data Row

Developer identifier: model_imports.firstDataRowFirst Data Row identifies the source-file row where import data begins. It separates headers and preamble rows from the imported records.

Enables: reproduce the import boundary and diagnose row-alignment errors in source files.
Interpretation: The provider supplies firstDataRow as a row position, not a row count or business measure; zero and missing are not interchangeable.

Header Row

Developer identifier: model_imports.headerRowHeader Row captures the row number in the source file that contains column headers. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact header row when validating the configuration or technical definition of a model import record.
Interpretation: The provider supplies headerRow as configuration or technical metadata on ModelImport; consumers must preserve the exact syntax and documented vocabulary.

Developer identifier: model_imports.idID is the unique identifier of the import action. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same model import source row before constructing its represented state.
Interpretation: The provider supplies id at one value per model import record, and x-transformDedupKey explicitly marks it as the record key.

Import Data Source ID

Developer identifier: model_imports.importDataSourceIdImport Data Source ID is the identifier of the data source (file or list) used by this import action. It is needed to resolve references that repeat the same provider identifier.

Enables: match model import records to provider records that carry the same import data source ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies importDataSourceId as a record-level identifier on ModelImport. It is not a uniqueness guarantee unless a connector directive says so.

Import Data Source Name

Developer identifier: model_imports.importDataSourceNameImport Data Source Name records name of the data source used by this import action. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact import data source name value attached to each model import record.
Interpretation: The provider supplies importDataSourceName at model import granularity in the format stated by its description; omitted or redacted content remains unknown.

Import Data Source Type

Developer identifier: model_imports.importDataSourceTypeImport Data Source Type captures the type of data source feeding this import (e.g., file, list, module). It preserves the provider’s current classification of this record.

Enables: separate model import records by the exact provider-reported import data source type value when describing their recorded state.
Interpretation: The provider supplies importDataSourceType per model import record using its own state vocabulary; unknown and missing values must remain distinct.

Import Type

Developer identifier: model_imports.importTypeImport Type captures the type of import, indicating the target structure (e.g., module data, list items, or users). It preserves the provider’s current classification of this record.

Enables: separate model import records by the exact provider-reported import type value when describing their recorded state.
Interpretation: The provider supplies importType per model import record using its own state vocabulary; unknown and missing values must remain distinct.

Model ID

Developer identifier: model_imports.modelIdModel ID identifies parent model id injected by the ingestor when iterating per-model. Not part of the upstream Anaplan API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.

Enables: match model import records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies modelId as a record-level identifier on ModelImport. It is not a uniqueness guarantee unless a connector directive says so.

Name

Developer identifier: model_imports.nameName records display name of the import action. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name value attached to each model import record.
Interpretation: The provider supplies name at model import granularity in the format stated by its description; omitted or redacted content remains unknown.

Separator

Developer identifier: model_imports.separatorSeparator captures the text qualifier or separator used in the source file. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact separator when validating the configuration or technical definition of a model import record.
Interpretation: The provider supplies separator as configuration or technical metadata on ModelImport; consumers must preserve the exact syntax and documented vocabulary.

Source File ID

Developer identifier: model_imports.sourceFileIdSource File ID is the identifier of the source file used by this import action. It is needed to resolve references that repeat the same provider identifier.

Enables: match model import records to provider records that carry the same source file ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies sourceFileId as a record-level identifier on ModelImport. It is not a uniqueness guarantee unless a connector directive says so.

Source File Name

Developer identifier: model_imports.sourceFileNameSource File Name records name of the source file used by this import action. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact source file name value attached to each model import record.
Interpretation: The provider supplies sourceFileName at model import granularity in the format stated by its description; omitted or redacted content remains unknown.

Source List ID

Developer identifier: model_imports.sourceListIdSource List ID is the identifier of the source list when importing from a list. It is needed to resolve references that repeat the same provider identifier.

Enables: match model import records to provider records that carry the same source list ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies sourceListId as a record-level identifier on ModelImport. It is not a uniqueness guarantee unless a connector directive says so.

Source List Name

Developer identifier: model_imports.sourceListNameSource List Name records name of the source list when importing from a list. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact source list name value attached to each model import record.
Interpretation: The provider supplies sourceListName at model import granularity in the format stated by its description; omitted or redacted content remains unknown.

Source Model ID

Developer identifier: model_imports.sourceModelIdSource Model ID is the identifier of the source model if the import pulls data from another Anaplan model. It is needed to resolve references that repeat the same provider identifier.

Enables: match model import records to provider records that carry the same source model ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies sourceModelId as a record-level identifier on ModelImport. It is not a uniqueness guarantee unless a connector directive says so.

Source Model Name

Developer identifier: model_imports.sourceModelNameSource Model Name records name of the source model if the import pulls data from another Anaplan model. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact source model name value attached to each model import record.
Interpretation: The provider supplies sourceModelName at model import granularity in the format stated by its description; omitted or redacted content remains unknown.

Source Module ID

Developer identifier: model_imports.sourceModuleIdSource Module ID is the identifier of the source module when importing from a module view. It is needed to resolve references that repeat the same provider identifier.

Enables: match model import records to provider records that carry the same source module ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies sourceModuleId as a record-level identifier on ModelImport. It is not a uniqueness guarantee unless a connector directive says so.

Source Module Name

Developer identifier: model_imports.sourceModuleNameSource Module Name records name of the source module when importing from a module view. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact source module name value attached to each model import record.
Interpretation: The provider supplies sourceModuleName at model import granularity in the format stated by its description; omitted or redacted content remains unknown.

Source View ID

Developer identifier: model_imports.sourceViewIdSource View ID is the identifier of the source view when importing from a module view. It is needed to resolve references that repeat the same provider identifier.

Enables: match model import records to provider records that carry the same source view ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies sourceViewId as a record-level identifier on ModelImport. It is not a uniqueness guarantee unless a connector directive says so.

Source View Name

Developer identifier: model_imports.sourceViewNameSource View Name records name of the source view when importing from a module view. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact source view name value attached to each model import record.
Interpretation: The provider supplies sourceViewName at model import granularity in the format stated by its description; omitted or redacted content remains unknown.

Target List ID

Developer identifier: model_imports.targetListIdTarget List ID is the identifier of the target list when the import loads list items. It is needed to resolve references that repeat the same provider identifier.

Enables: match model import records to provider records that carry the same target list ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies targetListId as a record-level identifier on ModelImport. It is not a uniqueness guarantee unless a connector directive says so.

Target List Name

Developer identifier: model_imports.targetListNameTarget List Name records name of the target list when the import loads list items. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact target list name value attached to each model import record.
Interpretation: The provider supplies targetListName at model import granularity in the format stated by its description; omitted or redacted content remains unknown.

Target Module ID

Developer identifier: model_imports.targetModuleIdTarget Module ID is the identifier of the target module when the import loads module data. It is needed to resolve references that repeat the same provider identifier.

Enables: match model import records to provider records that carry the same target module ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies targetModuleId as a record-level identifier on ModelImport. It is not a uniqueness guarantee unless a connector directive says so.

Target Module Name

Developer identifier: model_imports.targetModuleNameTarget Module Name records name of the target module when the import loads module data. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact target module name value attached to each model import record.
Interpretation: The provider supplies targetModuleName at model import granularity in the format stated by its description; omitted or redacted content remains unknown.

Workspace ID

Developer identifier: model_imports.workspaceIdWorkspace ID identifies parent workspace id injected by the ingestor when iterating per-workspace. Not part of the upstream Anaplan API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.

Enables: match model import records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies workspaceId as a record-level identifier on ModelImport. It is not a uniqueness guarantee unless a connector directive says so.

Model Line Items

Developer identifier: model_line_itemsModel Line Items contain all line items defined within a specific model. Line items are the individual data elements (metrics/measures) in Anaplan modules.

Enables: inventory the measures defined by line items within each planning model.
Scope: Reads the declared collection through GET /2/0/workspaces/{workspaceId}/models/{id}/lineItems as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.

Applies To

Developer identifier: model_line_items.appliesToApplies To lists the dimensions and entities related to the line item. It preserves the relationships that determine where the line item’s values exist.

Enables: reconstruct line-item dimensionality and join each line item to its applicable lists or entities.
Interpretation: The provider supplies appliesTo as a list of dimension references; an empty list and a missing relationship list are distinct.

Developer identifier: model_line_items.appliesTo.idID is the unique identifier of the dimension. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same dimension reference source row before constructing its represented state.
Interpretation: The provider supplies id at one value per dimension reference record, and x-transformDedupKey explicitly marks it as the record key.

Name

Developer identifier: model_line_items.appliesTo.nameName records name of the dimension. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name value attached to each dimension reference record.
Interpretation: The provider supplies name at dimension reference granularity in the format stated by its description; omitted or redacted content remains unknown.

Breakback

Developer identifier: model_line_items.breakbackBreakback indicates whether breakback (spread) is enabled for this line item. It preserves the provider-reported yes-or-no condition for this record.

Enables: select model line item records for which the provider reports breakback as true or false.
Interpretation: The provider supplies breakback as a boolean per model line item record; false and missing are distinct when the field is optional.

Brought Forward

Developer identifier: model_line_items.broughtForwardBrought Forward indicates whether the line item uses brought-forward (opening balance) time functionality. It preserves the provider-reported yes-or-no condition for this record.

Enables: select model line item records for which the provider reports brought forward as true or false.
Interpretation: The provider supplies broughtForward as a boolean per model line item record; false and missing are distinct when the field is optional.

Cell Count

Developer identifier: model_line_items.cellCountCell Count captures the total number of cells occupied by this line item across all dimensions. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported cell count for each model line item record.
Interpretation: The provider supplies cellCount at model line item granularity as a count at one value per record; zero and missing are not interchangeable.

Code

Developer identifier: model_line_items.codeCode records optional code assigned to the line item for external reference or integration purposes. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact code when validating the configuration or technical definition of a model line item record.
Interpretation: The provider supplies code as configuration or technical metadata on ModelLineItem; consumers must preserve the exact syntax and documented vocabulary.

Data Tags

Developer identifier: model_line_items.dataTagsData Tags records data tags associated with this line item for classification or governance. It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: apply the provider-defined data tags classifications to each model line item record.
Interpretation: The provider returns dataTags as a list on ModelLineItem; an absent value does not prove that no related object exists outside the credential’s visibility.

Format

Developer identifier: model_line_items.formatFormat captures the data format/type of the line item (e.g., NUMBER, TEXT, BOOLEAN, DATE, TIME_ENTITY, LIST). It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact format when validating the configuration or technical definition of a model line item record.
Interpretation: The provider supplies format as configuration or technical metadata on ModelLineItem; consumers must preserve the exact syntax and documented vocabulary.

Format Metadata

Developer identifier: model_line_items.formatMetadataFormat Metadata records additional metadata about the line item’s format, such as associated list or entity details. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact format metadata when validating the configuration or technical definition of a model line item record.
Interpretation: The provider supplies formatMetadata as configuration or technical metadata on ModelLineItem; consumers must preserve the exact syntax and documented vocabulary.

Date Format

Developer identifier: model_line_items.formatMetadata.dateFormatDate Format records the date format pattern for DATE-format line items. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact date format when validating the configuration or technical definition of a format metadata record.
Interpretation: The provider supplies dateFormat as configuration or technical metadata on FormatMetadata; consumers must preserve the exact syntax and documented vocabulary.

Decimal Places

Developer identifier: model_line_items.formatMetadata.decimalPlacesDecimal Places defines how many digits appear after the decimal point for a NUMBER-format line item. It preserves the provider’s numeric display precision.

Enables: reproduce line-item formatting and interpret stored values with the intended decimal precision.
Interpretation: The provider supplies decimalPlaces as a formatting count, not an observed business value; zero and missing are not interchangeable.

Decimal Separator

Developer identifier: model_line_items.formatMetadata.decimalSeparatorDecimal Separator records decimal separator character. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact decimal separator when validating the configuration or technical definition of a format metadata record.
Interpretation: The provider supplies decimalSeparator as configuration or technical metadata on FormatMetadata; consumers must preserve the exact syntax and documented vocabulary.

Grouping Separator

Developer identifier: model_line_items.formatMetadata.groupingSeparatorGrouping Separator records thousands grouping separator character. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact grouping separator when validating the configuration or technical definition of a format metadata record.
Interpretation: The provider supplies groupingSeparator as configuration or technical metadata on FormatMetadata; consumers must preserve the exact syntax and documented vocabulary.

List ID

Developer identifier: model_line_items.formatMetadata.listIdList ID is the identifier of the associated list, if the line item format is LIST. It is needed to resolve references that repeat the same provider identifier.

Enables: match model line item records to provider records that carry the same list ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies listId as a record-level identifier on FormatMetadata. It is not a uniqueness guarantee unless a connector directive says so.

List Name

Developer identifier: model_line_items.formatMetadata.listNameList Name records name of the associated list, if the line item format is LIST. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact list name value attached to each format metadata record.
Interpretation: The provider supplies listName at format metadata granularity in the format stated by its description; omitted or redacted content remains unknown.

Minimum Significant Digits

Developer identifier: model_line_items.formatMetadata.minimumSignificantDigitsMinimum Significant Digits defines the minimum displayed precision for NUMBER-format line items. It preserves the formatting rule used with decimal places.

Enables: reproduce numeric presentation and distinguish formatting precision from the line item’s value.
Interpretation: The provider supplies minimumSignificantDigits as a digit-count setting, not an observed business measure; zero and missing are not interchangeable.

Negative Number Notation

Developer identifier: model_line_items.formatMetadata.negativeNumberNotationNegative Number Notation records notation style for negative numbers (e.g., minus sign, parentheses). It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact negative number notation when validating the configuration or technical definition of a format metadata record.
Interpretation: The provider supplies negativeNumberNotation as configuration or technical metadata on FormatMetadata; consumers must preserve the exact syntax and documented vocabulary.

Zero Format

Developer identifier: model_line_items.formatMetadata.zeroFormatZero Format records how zero values are displayed. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact zero format when validating the configuration or technical definition of a format metadata record.
Interpretation: The provider supplies zeroFormat as configuration or technical metadata on FormatMetadata; consumers must preserve the exact syntax and documented vocabulary.

Formula

Developer identifier: model_line_items.formulaFormula captures the formula expression defined for this line item, if any. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact formula when validating the configuration or technical definition of a model line item record.
Interpretation: The provider supplies formula as configuration or technical metadata on ModelLineItem; consumers must preserve the exact syntax and documented vocabulary.

Formula Scope

Developer identifier: model_line_items.formulaScopeFormula Scope captures the scope of the formula, indicating where the formula applies. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact formula scope when validating the configuration or technical definition of a model line item record.
Interpretation: The provider supplies formulaScope as configuration or technical metadata on ModelLineItem; consumers must preserve the exact syntax and documented vocabulary.

Developer identifier: model_line_items.idID is the unique identifier of the line item within the model. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same model line item source row before constructing its represented state.
Interpretation: The provider supplies id at one value per model line item record, and x-transformDedupKey explicitly marks it as the record key.

Is Summary

Developer identifier: model_line_items.isSummaryIs Summary indicates whether this line item is a summary line item. It preserves the provider-reported yes-or-no condition for this record.

Enables: select model line item records for which the provider reports is summary as true or false.
Interpretation: The provider supplies isSummary as a boolean per model line item record; false and missing are distinct when the field is optional.

Model ID

Developer identifier: model_line_items.modelIdModel ID identifies parent id injected by the ingestor from the workspace_models to model_line_items traversal parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.

Enables: match model line item records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies modelId as a record-level identifier on ModelLineItem. It is not a uniqueness guarantee unless a connector directive says so.

Module ID

Developer identifier: model_line_items.moduleIdModule ID is the identifier of the module that contains this line item. It is needed to resolve references that repeat the same provider identifier.

Enables: match model line item records to provider records that carry the same module ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies moduleId as a record-level identifier on ModelLineItem. It is not a uniqueness guarantee unless a connector directive says so.

Module Name

Developer identifier: model_line_items.moduleNameModule Name records name of the module that contains this line item. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact module name value attached to each model line item record.
Interpretation: The provider supplies moduleName at model line item granularity in the format stated by its description; omitted or redacted content remains unknown.

Name

Developer identifier: model_line_items.nameName records display name of the line item. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name value attached to each model line item record.
Interpretation: The provider supplies name at model line item granularity in the format stated by its description; omitted or redacted content remains unknown.

Notes

Developer identifier: model_line_items.notesNotes records user-defined notes or description for the line item. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret notes according to the provider and Workspace configuration that produced each model line item record.
Interpretation: Keys and value shapes within notes can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Parent

Developer identifier: model_line_items.parentParent records parent line item reference when nested. Live API returns {id, name}; absent or null when the line item has no parent. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact parent value attached to each model line item record.
Interpretation: The provider supplies parent at model line item granularity in the format stated by its description; omitted or redacted content remains unknown.

Developer identifier: model_line_items.parent.idID is the identifier of the parent line item. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same line item parent source row before constructing its represented state.
Interpretation: The provider supplies id at one value per line item parent record, and x-transformDedupKey explicitly marks it as the record key.

Name

Developer identifier: model_line_items.parent.nameName records display name of the parent line item. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name value attached to each line item parent record.
Interpretation: The provider supplies name at line item parent granularity in the format stated by its description; omitted or redacted content remains unknown.

Parent Name

Developer identifier: model_line_items.parentNameParent Name records name of the parent line item, if this line item is nested. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact parent name value attached to each model line item record.
Interpretation: The provider supplies parentName at model line item granularity in the format stated by its description; omitted or redacted content remains unknown.

Read Access Driver

Developer identifier: model_line_items.readAccessDriverRead Access Driver captures the access driver controlling read permissions for this line item. It documents the access-related value reported for this object or membership.

Enables: describe the provider-reported read access driver attached to each model line item record.
Interpretation: The provider supplies readAccessDriver at model line item granularity. It describes provider-reported context and does not prove effective access beyond the returned record.

Referenced By

Developer identifier: model_line_items.referencedByReferenced By records list of line items or formulas that reference this line item. It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: reconstruct the declared referenced by layout or dimensional scope of each model line item record.
Interpretation: The provider returns referencedBy as a list on ModelLineItem; an absent value does not prove that no related object exists outside the credential’s visibility.

Start Of Section

Developer identifier: model_line_items.startOfSectionStart Of Section indicates whether this line item marks the start of a section in the module. It preserves the provider-reported yes-or-no condition for this record.

Enables: select model line item records for which the provider reports start of section as true or false.
Interpretation: The provider supplies startOfSection as a boolean per model line item record; false and missing are distinct when the field is optional.

Style

Developer identifier: model_line_items.styleStyle records display style or formatting hint for the line item. It preserves the provider’s visual treatment for the represented object.

Enables: reproduce or compare the provider-supplied style for the represented design or board object.
Interpretation: The provider supplies style in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.

Summary

Developer identifier: model_line_items.summarySummary captures the summary (aggregation) method applied to the line item. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact summary value attached to each model line item record.
Interpretation: The provider supplies summary at model line item granularity in the format stated by its description; omitted or redacted content remains unknown.

Time Range

Developer identifier: model_line_items.timeRangeTime Range records time range label for the line item as returned by the API (for example Model Calendar, 2016 - 2026). It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact time range value attached to each model line item record.
Interpretation: The provider supplies timeRange at model line item granularity in the format stated by its description; omitted or redacted content remains unknown.

Time Scale

Developer identifier: model_line_items.timeScaleTime Scale captures the time scale granularity for the line item (e.g., Month, Quarter, Year). It preserves the provider-defined period or schedule cadence for this record.

Enables: group model line item records by the provider-defined time scale period or schedule.
Interpretation: The provider supplies timeScale per model line item record using its own period or schedule vocabulary; it is not an elapsed-duration measurement.

Use Switchover

Developer identifier: model_line_items.useSwitchoverUse Switchover indicates whether the line item uses switchover for actual vs. forecast data. It preserves the provider-reported yes-or-no condition for this record.

Enables: select model line item records for which the provider reports use switchover as true or false.
Interpretation: The provider supplies useSwitchover as a boolean per model line item record; false and missing are distinct when the field is optional.

Version

Developer identifier: model_line_items.versionVersion records version settings for the line item, if applicable. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact version when validating the configuration or technical definition of a model line item record.
Interpretation: The provider supplies version as configuration or technical metadata on ModelLineItem; consumers must preserve the exact syntax and documented vocabulary.

Developer identifier: model_line_items.version.idID is the identifier of the version. It is needed to resolve references that repeat the same provider identifier.

Enables: match model line item records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies id as a record-level identifier on VersionReference. It is not a uniqueness guarantee unless a connector directive says so.

Name

Developer identifier: model_line_items.version.nameName records name of the version. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name value attached to each version reference record.
Interpretation: The provider supplies name at version reference granularity in the format stated by its description; omitted or redacted content remains unknown.

Workspace ID

Developer identifier: model_line_items.workspaceIdWorkspace ID identifies parent workspaceId injected by the ingestor from the workspace_models to model_line_items traversal parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.

Enables: match model line item records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies workspaceId as a record-level identifier on ModelLineItem. It is not a uniqueness guarantee unless a connector directive says so.

Write Access Driver

Developer identifier: model_line_items.writeAccessDriverWrite Access Driver captures the access driver controlling write permissions for this line item. It documents the access-related value reported for this object or membership.

Enables: describe the provider-reported write access driver attached to each model line item record.
Interpretation: The provider supplies writeAccessDriver at model line item granularity. It describes provider-reported context and does not prove effective access beyond the returned record.

Model Lists

Developer identifier: model_listsModel Lists contain all lists (dimensions/hierarchies) defined within a specific model. Lists are core structural elements in Anaplan.

Enables: map the lists that define dimensions and hierarchies in each planning model.
Scope: Reads the declared collection through GET /2/0/workspaces/{workspaceId}/models/{id}/lists as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.

Error	Meaning	Solution
`401 Unauthorized` on token endpoint	Bad email or password	Verify credentials
`401 Caller is unauthorized` on SCIM	Missing Tenant Admin	Grant Tenant Admin to the integration account
`401 No valid token header` on audit	Audit auth mismatch	Confirm Tenant Auditor; audit may require different auth
`403 Forbidden` on workspaces	Insufficient access	Grant Workspace Admin on target workspaces
Password stopped working	Rotation policy	Use Exception User or update the Provider password

Common Issues

Account locked after failed attempts

Contact your Tenant Admin to unlock the account.

SCIM returns empty user list

Workspace Admin alone is not enough; the account needs Tenant Admin for SCIM.

Audit events not available

Confirm Tenant Auditor role and supported auth for the audit API with Anaplan support.Anaplan REST API — API documentationSCIM API — User provisioning APIAudit API — Audit event API reference

​Planning data

​Identity & audit

​Data streams

​Basic authentication

​What You’ll Need

​Step 1: Confirm integration account

​Step 2: How authentication works

​Step 3: Enter values in the form

​Common Issues

​Account locked after failed attempts

​SCIM returns empty user list

​Audit events not available

Planning data

Identity & audit

Data streams

Basic authentication

What You’ll Need

Step 1: Confirm integration account

Step 2: How authentication works

Step 3: Enter values in the form

Common Issues

Account locked after failed attempts

SCIM returns empty user list

Audit events not available