All REST Endpoints
Applications
- Get all applications
- Method: getPath:
/epm/rest/v1/applications - Run an extract package
- Method: postPath:
/epm/rest/v1/applications/extractPackage
Applications/Connections
- Get a connection for an application
- Method: getPath:
/epm/rest/v1/applications/{applicationId}/connections/{connectionId} - Get all connections for an application
- Method: getPath:
/epm/rest/v1/applications/{applicationId}/connections - Test a connection for an application
- Method: postPath:
/epm/rest/v1/applications/{applicationId}/connections/{connectionId}/test - Update a connection for an application
- Method: putPath:
/epm/rest/v1/applications/{applicationId}/connections/{connectionId}
Applications/Dimensions
- Export a dimension by name
- Method: postPath:
/epm/rest/v1/dimensions/byName/export - Export a dimension to a configured connection
- Method: postPath:
/epm/rest/v1/dimensions/{dimensionId}/export/connection - Export a dimension to a file
- Method: postPath:
/epm/rest/v1/dimensions/{dimensionId}/export/download - Extract a dimension viewpoint
- Method: postPath:
/epm/rest/v1/dimensions/byName/extract - Import a dimension by name
- Method: postPath:
/epm/rest/v1/dimensions/byName/import - Import a dimension from a file
- Method: postPath:
/epm/rest/v1/dimensions/{dimensionId}/import/file - Import a dimension via a connection
- Method: postPath:
/epm/rest/v1/dimensions/{dimensionId}/import/connection - Incremental export for a dimension
- Method: postPath:
/epm/rest/v1/dimensions/byName/incrementalExport - Load a dimension viewpoint
- Method: postPath:
/epm/rest/v1/dimensions/byName/load
Applications/Dimensions/Mappings
- Export a dimension mapping by name
- Method: postPath:
/epm/rest/v1/dimensions/byName/exportMappings - Export a dimension mapping to a connection
- Method: postPath:
/epm/rest/v1/dimensions/{dimensionId}/mapping/export/connection - Export a dimension mapping to a CSV file
- Method: postPath:
/epm/rest/v1/dimensions/{dimensionId}/mapping/export/download - Get the mappings for a dimension
- Method: getPath:
/epm/rest/v1/dimensions/{dimensionId}/bindings/{bindingId}/mappingKeys
Extracts
- Get viewpoint extracts
- Method: getPath:
/epm/rest/v1/extracts - Update global connection for an extract
- Method: putPath:
/epm/rest/v1/extracts/{extractId}/connectionInfo
Files
- Delete a file from the staging area
- Method: deletePath:
/epm/rest/v1/files/staging/{fileName} - Download a file from staging area
- Method: getPath:
/epm/rest/v1/files/staging/{fileName} - Download a temporary file
- Method: getPath:
/epm/rest/v1/files/temp/{fileId} - List files in the staging area
- Method: getPath:
/epm/rest/v1/files/staging - Upload a file to the staging area
- Method: postPath:
/epm/rest/v1/files/staging - Upload a temporary file
- Method: postPath:
/epm/rest/v1/files/temp
Global Connections
- Get a global connection
- Method: getPath:
/epm/rest/v1/globalConnections/{globalConnectionId} - Get all global connections
- Method: getPath:
/epm/rest/v1/globalConnections - Test a global connection
- Method: postPath:
/epm/rest/v1/globalConnections/{globalConnectionId}/test - Update a global connection
- Method: putPath:
/epm/rest/v1/globalConnections/{globalConnectionId}
Jobs
- Get the job run with the given id
- Method: getPath:
/epm/rest/v1/jobRuns/{jobRunId} - Get the result body of the job run with the given id
- Method: getPath:
/epm/rest/v1/jobRuns/{jobRunId}/result
Policies
- Get all policies
- Method: getPath:
/epm/rest/v1/policies - Update enabled flag of a policy
- Method: postPath:
/epm/rest/v1/policies/{policyId}/updateEnabledFlag
Requests
- Assign a request to user
- Method: postPath:
/epm/rest/v1/requests/assignRequest - Create a new request
- Method: postPath:
/epm/rest/v1/requests - Create request items from a saved attachment
- Method: postPath:
/epm/rest/v1/requests/{requestId}/import - Delete a request
- Method: deletePath:
/epm/rest/v1/requests/{requestId} - Generate a request attachment
- Method: postPath:
/epm/rest/v1/requests/{requestId}/attachments/generate - Get a request
- Method: getPath:
/epm/rest/v1/requests/{requestId} - Get the lineage of a request
- Method: getPath:
/epm/rest/v1/requests/{requestId}/lineage - Query requests
- Method: getPath:
/epm/rest/v1/requests/byName/query - Transition request to a new status
- Method: postPath:
/epm/rest/v1/requests/{requestId}/transitions - Upload a request item file
- Method: postPath:
/epm/rest/v1/requests/{requestId}/attachments/importFile
System Settings
- Get system settings
- Method: getPath:
/epm/rest/v1/systemSettings - Update system settings
- Method: postPath:
/epm/rest/v1/systemSettings
Templates
- Export a template file
- Method: postPath:
/epm/rest/v1/templates/export - Import a template file
- Method: postPath:
/epm/rest/v1/templates/import
Transaction History
- Export transaction history to a file
- Method: postPath:
/epm/rest/v1/transactionHistory/byName/export
Views
- Compare viewpoints and write results to file
- Method: postPath:
/epm/rest/v1/views/compare/writeToFile - Gets the views
- Method: getPath:
/epm/rest/v1/views
Views/Viewpoints
- Get the lineage of a viewpoint
- Method: getPath:
/epm/rest/v1/views/{viewId}/viewpoints/{viewpointId}/lineage - Gets the viewpoints in the given view
- Method: getPath:
/epm/rest/v1/views/{viewId}/viewpoints - Load a viewpoint from a file
- Method: postPath:
/epm/rest/v1/viewpoints/byName/load/file - Query a viewpoint and write results to file
- Method: postPath:
/epm/rest/v1/viewpoints/query/writeToFile - Validate viewpoint and write results to file
- Method: postPath:
/epm/rest/v1/viewpoints/validate/writeToFile
Views/Viewpoints/Nodes
- Gets a node in a specified location of a viewpoint
- Method: getPath:
/epm/rest/v1/views/{viewId}/viewpoints/{viewpointId}/nodes/{nodeId}/locations/{location} - Gets a node in a viewpoint
- Method: getPath:
/epm/rest/v1/views/{viewId}/viewpoints/{viewpointId}/nodes/{nodeId} - Gets nodes in a viewpoint
- Method: getPath:
/epm/rest/v1/views/{viewId}/viewpoints/{viewpointId}/nodes - Searches for nodes in the viewpoint using supplied criteria
- Method: postPath:
/epm/rest/v1/views/{viewId}/viewpoints/{viewpointId}/nodes/search