Articles in this section

Available Planful APIs

Tanisha Ray
Updated

When you configure an export, import, or other type of flow step using the prebuilt Planful connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Planful API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Approval roles

Get approval role for all users

X

Get approval role

X

Data extract APIs

Retrieve the GL data

X

Retrieve the segment 1 data

X

Retrieve the Segment 2 data

X

Retrieve the Segment 3 to Segment 8 data

X

Data load status APIs

Get data load status

X

Get running data load status

X

Edit user roles & properties

Edit user

X

Update support role

X

Task manager role

X

External source model

Clear data

X

Clear dimension members (metadata)

X

Export leaf-level data (scoped)

X

Load data

X

Load dimension members (metadata)

X

Master and analytic model

Append attributes

X

Append dimension members

X

Calculation run

X

Calculation status

X

Clear data

X

Clear leaf data

X

Export dimension/attribute hierarchy

X

Export leaf-level data with attribute and operation type

X

Platform APIs

Get version

X

Retrieve data load rules APIs

Get the list of DLRs

X

Get the complete list of GL data and GL with translations DLRs

X

Get the complete list of transaction data DLR

X

Scenario access

Allow scenario access

X

Remove scenario access based on user

X

Get scenario access based on user

X

Structured planning APIs

Get report data

X

Execute a process flow in cloud scheduler

X

Transfer data APIs

Transfer at once

X

Transfer in batches (last request)

X

Transfer file

X

User management

Add user

X

Delete user

X

Map user to user group

X

Unmap user from user group

X

Get user groups by user

X