1. REST API for Oracle Fusion Cloud Enterprise Data Management
  2. Tasks
  3. Extracts

Get viewpoint extracts

get

/epm/rest/v1/extracts

Returns a list of all the extracts the user has access to.

Request

Query Parameters
  • Collection Format: multi
    filters Extracts
    • Allowed Values: [ "view::{view Id to match extract view}", "integration_only::{TRUE or FALSE}", "viewpoint::{viewpoint Id to match extract viewpoint}", "application::{application Id to match validation}", "dimension::{dimension Id to match validation}", "scope::{PUBLIC or PRIVATE}" ]
Back to Top

Response

Supported Media Types

200 Response

successful operation
Body ()
Root Schema : ItemExtract
Type: object
Show Source
Nested Schema : items
Type: array
Read Only: true
Show Source
Nested Schema : SimpleExtract
Type: object
Show Source
Nested Schema : User
Type: object
Show Source
Nested Schema : Dimension
Type: object
Dimension model that would be returned as response
Show Source
Nested Schema : ExtractConnection
Type: object
Show Source
Nested Schema : ExtractHistory
Type: object
Show Source
Nested Schema : View
Type: object
Show Source
Nested Schema : Viewpoint
Type: object
Show Source
Nested Schema : artifactAssignments
Type: array
Show Source
Nested Schema : associatedRoles
Type: array
Show Source
Nested Schema : emailAddresses
Type: array
Show Source
Nested Schema : Preferences
Type: object
Show Source
Nested Schema : ArtifactAssignment
Type: object
Show Source
Nested Schema : Artifact
Type: object
Show Source
Nested Schema : Role
Type: object
Show Source
Nested Schema : TimeZone
Type: object
Show Source
Nested Schema : bindings
Type: array
Read Only: true
Show Source
Nested Schema : BlockoutConfiguration
Type: object
Show Source
Nested Schema : DimensionImportExportSettings
Type: object
Discriminator: type
Dimension Import/Export settings
Show Source
  • Read Only: true
    Allowed Values: [ "DEFAULT", "FCGL" ]
    Type is set to "DEFAULT" for standard settings, "FCGL" for Financial Cloud Import/Export options.
Nested Schema : permittedActions
Type: array
Read Only: true
Unique Items Required: true
Show Source
  • Allowed Values: [ "CREATE_CONSTRAINT", "CREATE_NODETYPE", "CREATE_HIERARCHYSET", "CREATE_NODESET", "CREATE_VIEWPOINT", "CREATE_REQUEST", "CREATE_PROPERTY", "ASSIGN_REQUEST", "SUBMIT_REQUEST", "PUSHBACK_REQUEST", "REJECT_REQUEST", "APPROVE_REQUEST", "WITHDRAW_REQUEST", "COMMIT_REQUEST", "ADD_REQUEST_COMMENT", "ADD_REQUEST_ATTACHMENT", "EDIT_REQUEST_HEADER", "VALIDATE", "EDIT_METADATA", "REINDEX", "EDIT", "COPY_VIEWPOINT", "LOAD_VIEWPOINT", "ARCHIVE", "DELETE", "CLOSE", "IMPORT", "EXPORT", "MANAGE_GRANTS", "DELETE_NODE", "ADD_NODE", "INSERT_NODE", "REORDER_NODE", "REMOVE_NODE", "MOVE_NODE", "RECALL_REQUEST", "COPY_EXTRACT", "COPY_LOAD_PROFILE", "UPDATE_VISIBILITY", "COPY", "QUERY", "RUN_EXTRACT_PACKAGE", "CREATE_EXTRACT_PACKAGE" ]
Nested Schema : validationSettings
Type: array
Read Only: true
Show Source
Nested Schema : DimensionBinding
Type: object
Show Source
Nested Schema : DimensionSyncHistory
Type: object
Show Source
Nested Schema : messages
Type: array
Show Source
Nested Schema : Request
Type: object
A Request models changes to apply to a View
Show Source
Nested Schema : taskHistory
Type: array
Show Source
Nested Schema : approvalUsers
Type: array
Read Only: true
Show Source
Nested Schema : commitUsers
Type: array
Read Only: true
Show Source
Nested Schema : IdNameDescription
Type: object
Show Source
Nested Schema : inviteeUsers
Type: array
Read Only: true
Show Source
Nested Schema : subscriptions
Type: array
Read Only: true
Show Source
Nested Schema : TimeLabel
Type: object
Show Source
Nested Schema : validTransitionActions
Type: array
Read Only: true
Show Source
  • Allowed Values: [ "SUBMIT", "APPROVE", "PUSHBACK", "REJECT", "WITHDRAW", "RECALL", "COMMIT", "CLOSE" ]
Nested Schema : RollingTimeLabelData
Type: object
Show Source
Nested Schema : ZoneId
Type: object
Show Source
Nested Schema : ZoneRules
Type: object
Show Source
Nested Schema : transitionRules
Type: array
Show Source
Nested Schema : transitions
Type: array
Show Source
Nested Schema : ZoneOffsetTransitionRule
Type: object
Show Source
Nested Schema : LocalTime
Type: object
Show Source
Nested Schema : ZoneOffset
Type: object
Show Source
Nested Schema : ZoneOffsetTransition
Type: object
Show Source
Nested Schema : Duration
Type: object
Show Source
Nested Schema : units
Type: array
Show Source
Nested Schema : TemporalUnit
Type: object
Show Source
Nested Schema : DimensionSyncTaskHistory
Type: object
Show Source
Nested Schema : messages
Type: array
Show Source
Nested Schema : grantPermissionsAllowedToCommit
Type: array
Show Source
  • Allowed Values: [ "OWNER", "DATAMANAGER", "PARTICIPANT", "APPROVER", "NOTIFIED", "COMMITTER", "NONE", "METADATAMANAGER" ]
Nested Schema : RecurringBlockoutData
Type: object
Show Source
Nested Schema : ValidationSetting
Type: object
Show Source
Nested Schema : JsonNode
Type: object
Nested Schema : GlobalConnection
Type: object
Show Source
  • Global Connection Details
    Discriminator: type
    The details specific to this connection type. All connection types include a "type", the type of the connection. See the "type" object for allowed values. EPM connections also include: "url", the URL for the connection, "identityDomain", the identity domain for the connection, "username", the username for the connection, "password", a placeholder value for the connection's password, "folder", the default folder in the EPM inbox EPM OAuth connections also include: "url", the URL for the connection, "clientId", a placeholder value for the connection's client id, "accessToken", a placeholder value for the connection's access token, "refreshToken", a placeholder value for the connection's refresh token, "authType", the authentication type for the connection, "folder", the folder in the EPM inbox Oracle Object Store connections also include: "url", the URL for the connection, "username", the username for the connection, "password", a placeholder value for the connection's password, "defaultBucket", the default Object Storage bucket, "defaultSubFolder", the default Object Storage subfolder Oracle Object Store API Request Sign authenticated connections also include: "tenancyOciId", the OCI Tenancy Id for the connection, "userOciId", the OCI user Id for the connection, "authType", the authentication type for the connection, "publicKeyFingerprint", the Fingerprint of the public key for the connection, "privateKeyFileId", the file Id of the private key that was uploaded to temp for the connection, UCM connections using Basic Authentication also include: "url", the URL for the connection, "username", the username for the connection, "password", a placeholder value for the connection's password, "identityDomain", the identity domain for the connection, "defaultDocumentAccount", the default UCM document account UCM connections using OAuth authentication also include: "url", the ERP Application URL for the connection, "idcsTokenUrl", Provider authentication server used to exchange an authorization code for an access token, "clientId", Client ID for the connection, "scope", provides a method to govern the amount of access that is granted to a JSON Web Token, "certificateAlias", Alias name that an EDM user provides while creating the client in ERP IDCS, "privateKeyFileId", the file Id of the private key that was uploaded to temp for the connection, "authType", the authentication type for the connection, "defaultDocumentAccount", the default UCM document account AVCS connections also include: "url", the URL for the connection, "clientId", the client Id for the connection, "clientSecret", the client Secret for the connection AZURE connections also include: "url", the URL for the connection, "authType", the authentication type for the connection, "tenantId", the tenant Id for the connection, "clientId", the client Id for the connection, "clientSecret", the client Secret for the connection, "defaultContainerName", the name of the default container "defaultFolder", the name of the default folder
  • Read Only: true
    Allowed Values: [ "ORACLE_OBJECT_STORE", "UCM", "EPM", "AVCS", "AZURE" ]
  • User
  • Read Only: true
  • Read Only: true
  • links
  • User
  • Read Only: true
  • supportedApplications
    Read Only: true
  • Read Only: true
  • Read Only: true
Nested Schema : Global Connection Details
Type: object
Discriminator: type
The details specific to this connection type. All connection types include a "type", the type of the connection. See the "type" object for allowed values. EPM connections also include: "url", the URL for the connection, "identityDomain", the identity domain for the connection, "username", the username for the connection, "password", a placeholder value for the connection's password, "folder", the default folder in the EPM inbox EPM OAuth connections also include: "url", the URL for the connection, "clientId", a placeholder value for the connection's client id, "accessToken", a placeholder value for the connection's access token, "refreshToken", a placeholder value for the connection's refresh token, "authType", the authentication type for the connection, "folder", the folder in the EPM inbox Oracle Object Store connections also include: "url", the URL for the connection, "username", the username for the connection, "password", a placeholder value for the connection's password, "defaultBucket", the default Object Storage bucket, "defaultSubFolder", the default Object Storage subfolder Oracle Object Store API Request Sign authenticated connections also include: "tenancyOciId", the OCI Tenancy Id for the connection, "userOciId", the OCI user Id for the connection, "authType", the authentication type for the connection, "publicKeyFingerprint", the Fingerprint of the public key for the connection, "privateKeyFileId", the file Id of the private key that was uploaded to temp for the connection, UCM connections using Basic Authentication also include: "url", the URL for the connection, "username", the username for the connection, "password", a placeholder value for the connection's password, "identityDomain", the identity domain for the connection, "defaultDocumentAccount", the default UCM document account UCM connections using OAuth authentication also include: "url", the ERP Application URL for the connection, "idcsTokenUrl", Provider authentication server used to exchange an authorization code for an access token, "clientId", Client ID for the connection, "scope", provides a method to govern the amount of access that is granted to a JSON Web Token, "certificateAlias", Alias name that an EDM user provides while creating the client in ERP IDCS, "privateKeyFileId", the file Id of the private key that was uploaded to temp for the connection, "authType", the authentication type for the connection, "defaultDocumentAccount", the default UCM document account AVCS connections also include: "url", the URL for the connection, "clientId", the client Id for the connection, "clientSecret", the client Secret for the connection AZURE connections also include: "url", the URL for the connection, "authType", the authentication type for the connection, "tenantId", the tenant Id for the connection, "clientId", the client Id for the connection, "clientSecret", the client Secret for the connection, "defaultContainerName", the name of the default container "defaultFolder", the name of the default folder
Show Source
  • Read Only: true
    Allowed Values: [ "ORACLE_OBJECT_STORE", "ORACLE_OBJECT_STORE_REQ_SIGN", "EPM", "EPM_OAUTH", "UCM", "UCM_OAUTH", "AVCS", "AZURE" ]
    Type should be set to "EPM" for Oracle Cloud EPM connections, "EPM_OAUTH" for Oracle EPM_OAUTH connections, "UCM" for Oracle Cloud ERP connections, "UCM_OAUTH" for Oracle Cloud ERP OAuth connections, "ORACLE_OBJECT_STORE" for Oracle Object Store connections, "ORACLE_OBJECT_STORE_REQ_SIGN" for Oracle Object Store API Request Sign Authenticated connections, "AZURE" for Microsoft Azure connections, and "AVCS" for Oracle Address, Email, and Phone Verification connections.
Nested Schema : supportedApplications
Type: array
Read Only: true
Show Source
Nested Schema : messages
Type: array
Show Source
Nested Schema : permittedActions
Type: array
Unique Items Required: true
Show Source
  • Allowed Values: [ "CREATE_CONSTRAINT", "CREATE_NODETYPE", "CREATE_HIERARCHYSET", "CREATE_NODESET", "CREATE_VIEWPOINT", "CREATE_REQUEST", "CREATE_PROPERTY", "ASSIGN_REQUEST", "SUBMIT_REQUEST", "PUSHBACK_REQUEST", "REJECT_REQUEST", "APPROVE_REQUEST", "WITHDRAW_REQUEST", "COMMIT_REQUEST", "ADD_REQUEST_COMMENT", "ADD_REQUEST_ATTACHMENT", "EDIT_REQUEST_HEADER", "VALIDATE", "EDIT_METADATA", "REINDEX", "EDIT", "COPY_VIEWPOINT", "LOAD_VIEWPOINT", "ARCHIVE", "DELETE", "CLOSE", "IMPORT", "EXPORT", "MANAGE_GRANTS", "DELETE_NODE", "ADD_NODE", "INSERT_NODE", "REORDER_NODE", "REMOVE_NODE", "MOVE_NODE", "RECALL_REQUEST", "COPY_EXTRACT", "COPY_LOAD_PROFILE", "UPDATE_VISIBILITY", "COPY", "QUERY", "RUN_EXTRACT_PACKAGE", "CREATE_EXTRACT_PACKAGE" ]
Nested Schema : UsersBrowseFilter
Type: object
Show Source
Nested Schema : userGroups
Type: array
Unique Items Required: true
Show Source
Nested Schema : users
Type: array
Unique Items Required: true
Show Source
Nested Schema : compatibleDimensions
Type: array
Unique Items Required: true
Show Source
Nested Schema : layoutOptions
Type: object
Additional Properties Allowed
Show Source
Nested Schema : loadHistory
Type: array
Show Source
Nested Schema : nodeTypeAssignments
Type: array
Show Source
Nested Schema : permittedActions
Type: array
Unique Items Required: true
Show Source
  • Allowed Values: [ "CREATE_CONSTRAINT", "CREATE_NODETYPE", "CREATE_HIERARCHYSET", "CREATE_NODESET", "CREATE_VIEWPOINT", "CREATE_REQUEST", "CREATE_PROPERTY", "ASSIGN_REQUEST", "SUBMIT_REQUEST", "PUSHBACK_REQUEST", "REJECT_REQUEST", "APPROVE_REQUEST", "WITHDRAW_REQUEST", "COMMIT_REQUEST", "ADD_REQUEST_COMMENT", "ADD_REQUEST_ATTACHMENT", "EDIT_REQUEST_HEADER", "VALIDATE", "EDIT_METADATA", "REINDEX", "EDIT", "COPY_VIEWPOINT", "LOAD_VIEWPOINT", "ARCHIVE", "DELETE", "CLOSE", "IMPORT", "EXPORT", "MANAGE_GRANTS", "DELETE_NODE", "ADD_NODE", "INSERT_NODE", "REORDER_NODE", "REMOVE_NODE", "MOVE_NODE", "RECALL_REQUEST", "COPY_EXTRACT", "COPY_LOAD_PROFILE", "UPDATE_VISIBILITY", "COPY", "QUERY", "RUN_EXTRACT_PACKAGE", "CREATE_EXTRACT_PACKAGE" ]
Nested Schema : properties
Type: array
Show Source
Nested Schema : propertiesByNodeType
Type: array
Show Source
Nested Schema : propertyOverrides
Type: object
Additional Properties Allowed
Show Source
Nested Schema : ViewpointLoadHistory
Type: object
Show Source
Nested Schema : messages
Type: array
Show Source
Nested Schema : NodeTypeAssignment
Type: object
Show Source
Nested Schema : AllowedActions
Type: object
Show Source
Nested Schema : propertyOverrides
Type: array
Show Source
Nested Schema : relatedViewpoints
Type: array
Show Source
Nested Schema : PropertyOverride
Type: object
Show Source
Nested Schema : Property
Type: object
Show Source
Nested Schema : AllowedValues
Type: object
Show Source
Nested Schema : defaultValue
Type: object
Read Only: true
Nested Schema : nodeTypeDetails
Type: array
Read Only: true
Show Source
Nested Schema : overrides
Type: array
Show Source
Nested Schema : parameters
Type: array
Read Only: true
Show Source
Nested Schema : permittedActions
Type: array
Unique Items Required: true
Show Source
  • Allowed Values: [ "CREATE_CONSTRAINT", "CREATE_NODETYPE", "CREATE_HIERARCHYSET", "CREATE_NODESET", "CREATE_VIEWPOINT", "CREATE_REQUEST", "CREATE_PROPERTY", "ASSIGN_REQUEST", "SUBMIT_REQUEST", "PUSHBACK_REQUEST", "REJECT_REQUEST", "APPROVE_REQUEST", "WITHDRAW_REQUEST", "COMMIT_REQUEST", "ADD_REQUEST_COMMENT", "ADD_REQUEST_ATTACHMENT", "EDIT_REQUEST_HEADER", "VALIDATE", "EDIT_METADATA", "REINDEX", "EDIT", "COPY_VIEWPOINT", "LOAD_VIEWPOINT", "ARCHIVE", "DELETE", "CLOSE", "IMPORT", "EXPORT", "MANAGE_GRANTS", "DELETE_NODE", "ADD_NODE", "INSERT_NODE", "REORDER_NODE", "REMOVE_NODE", "MOVE_NODE", "RECALL_REQUEST", "COPY_EXTRACT", "COPY_LOAD_PROFILE", "UPDATE_VISIBILITY", "COPY", "QUERY", "RUN_EXTRACT_PACKAGE", "CREATE_EXTRACT_PACKAGE" ]
Nested Schema : allowedPropertyValues
Type: array
Show Source
Nested Schema : nodeTypes
Type: array
Show Source
Nested Schema : AllowedPropertyValue
Type: object
Show Source
Nested Schema : value
Type: object
Read Only: true
Nested Schema : NodeTypeDetail
Type: object
Show Source
Nested Schema : ApplicationOverride
Type: object
Show Source
Nested Schema : defaultValue
Type: object
Read Only: true
Nested Schema : nodeTypeOverrides
Type: array
Read Only: true
Show Source
Nested Schema : parameterValues
Type: array
Show Source
Nested Schema : NodeTypeOverride
Type: object
Show Source
Nested Schema : parameterValues
Type: array
Show Source
Nested Schema : PropertyNodeTypeOverrideValue
Type: object
Show Source
Nested Schema : labels
Type: array
Show Source
Nested Schema : value
Type: object
Nested Schema : PropertyParameterValue
Type: object
Show Source
Nested Schema : labels
Type: array
Show Source
Nested Schema : NodeTypeProperties
Type: object
Show Source
Nested Schema : propertyIds
Type: array
Unique Items Required: true
Show Source
Nested Schema : ViewpointPropertyOverride
Type: object
Show Source
Nested Schema : propertyGroups
Type: array
Show Source
Nested Schema : PropertyGroup
Type: object
Show Source
Nested Schema : viewpoints
Type: array
Read Only: true
Show Source
Nested Schema : HierarchySet
Type: object
Hierarchy Set model that would be returned as response
Show Source
Nested Schema : Application
Type: object
Show Source
Nested Schema : assignedNodeTypes
Type: array
Show Source
Nested Schema : permittedActions
Type: array
Unique Items Required: true
Show Source
  • Allowed Values: [ "CREATE_CONSTRAINT", "CREATE_NODETYPE", "CREATE_HIERARCHYSET", "CREATE_NODESET", "CREATE_VIEWPOINT", "CREATE_REQUEST", "CREATE_PROPERTY", "ASSIGN_REQUEST", "SUBMIT_REQUEST", "PUSHBACK_REQUEST", "REJECT_REQUEST", "APPROVE_REQUEST", "WITHDRAW_REQUEST", "COMMIT_REQUEST", "ADD_REQUEST_COMMENT", "ADD_REQUEST_ATTACHMENT", "EDIT_REQUEST_HEADER", "VALIDATE", "EDIT_METADATA", "REINDEX", "EDIT", "COPY_VIEWPOINT", "LOAD_VIEWPOINT", "ARCHIVE", "DELETE", "CLOSE", "IMPORT", "EXPORT", "MANAGE_GRANTS", "DELETE_NODE", "ADD_NODE", "INSERT_NODE", "REORDER_NODE", "REMOVE_NODE", "MOVE_NODE", "RECALL_REQUEST", "COPY_EXTRACT", "COPY_LOAD_PROFILE", "UPDATE_VISIBILITY", "COPY", "QUERY", "RUN_EXTRACT_PACKAGE", "CREATE_EXTRACT_PACKAGE" ]
Nested Schema : CustomApplicationMetadata
Type: object
Custom Application Metadata
Show Source
  • Allowed Values: [ "ORACLE_AUTONOMOUS_DATA_WAREHOUSE", "ORACLE_AUTONOMOUS_DATABASE", "ORACLE_CUSTOMER_EXPERIENCE", "ORACLE_DATA_RELATIONSHIP_MANAGEMENT", "ORACLE_EPM_ACCOUNT_RECONCILIATION", "ORACLE_EPM_PROFITABILITY_AND_COST_MANAGEMENT", "ORACLE_EPM_TAX_REPORTING", "ORACLE_FINANCIAL_SERVICES_ANALYTICAL_APPLICATIONS", "ORACLE_HUMAN_CAPITAL_MANAGEMENT", "ORACLE_HYPERION_FINANCIAL_MANAGEMENT", "ORACLE_JD_EDWARDS_ENTERPRISE_ONE", "ORACLE_JD_EDWARDS_WORLD", "ORACLE_NETSUITE", "ORACLE_PEOPLESOFT", "ORACLE_PROJECT_MANAGEMENT", "ORACLE_SIEBEL_CRM", "ORACLE_SUPPLY_CHAIN_N_MANUFACTURING", "ORACLE_DATA_FOUNDATION", "ORACLE_ACCOUNTING_FOUNDATION", "AMAZON_REDSHIFT", "ANAPLAN", "BOARD_INTERNATIONAL", "COUPA_SOFTWARE", "DATABRICKS", "EPICOR", "GOOGLE_BIGQUERY", "GREAT_PLAINS", "INFOR", "INFORMATICA", "KRONOS", "MICROSOFT_AZURE_SYNAPSE", "ONESTREAM", "PLANFUL", "SALESFORCE", "SAP_ARIBA", "SAP_FICO", "SAP_HANA", "SAP_S4_HANA_FINANCE", "SAP_SUCCESSFACTORS", "SNOWFLAKE_DATA_CLOUD", "TAGETIK", "WORKDAY_ADAPTIVE_PLANNING", "WORKDAY_HCM", "EXTERNAL_DATA_WAREHOUSE", "EXTERNAL_ETL_SYSTEM", "OTHER" ]
    External System Type
  • External System Type Label; used if externalSystemType is not specified
Nested Schema : dimensions
Type: array
Show Source
Nested Schema : permittedActions
Type: array
Unique Items Required: true
Show Source
  • Allowed Values: [ "CREATE_CONSTRAINT", "CREATE_NODETYPE", "CREATE_HIERARCHYSET", "CREATE_NODESET", "CREATE_VIEWPOINT", "CREATE_REQUEST", "CREATE_PROPERTY", "ASSIGN_REQUEST", "SUBMIT_REQUEST", "PUSHBACK_REQUEST", "REJECT_REQUEST", "APPROVE_REQUEST", "WITHDRAW_REQUEST", "COMMIT_REQUEST", "ADD_REQUEST_COMMENT", "ADD_REQUEST_ATTACHMENT", "EDIT_REQUEST_HEADER", "VALIDATE", "EDIT_METADATA", "REINDEX", "EDIT", "COPY_VIEWPOINT", "LOAD_VIEWPOINT", "ARCHIVE", "DELETE", "CLOSE", "IMPORT", "EXPORT", "MANAGE_GRANTS", "DELETE_NODE", "ADD_NODE", "INSERT_NODE", "REORDER_NODE", "REMOVE_NODE", "MOVE_NODE", "RECALL_REQUEST", "COPY_EXTRACT", "COPY_LOAD_PROFILE", "UPDATE_VISIBILITY", "COPY", "QUERY", "RUN_EXTRACT_PACKAGE", "CREATE_EXTRACT_PACKAGE" ]
Nested Schema : ApplicationType
Type: object
Show Source
Nested Schema : upgradeTargets
Type: array
Show Source
Nested Schema : WorkflowDisabledOption
Type: object
Show Source
Nested Schema : submittedBy
Type: array
Unique Items Required: true
Show Source
Nested Schema : HierarchySetNodeTypeAssignment
Type: object
Show Source
Nested Schema : allowedChildNodeTypes
Type: array
Read Only: true
Show Source
Nested Schema : alternateQualifiers
Type: array
Show Source
Nested Schema : compatibleBoundHierarchySets
Type: array
Unique Items Required: true
Show Source
Nested Schema : compatibleBoundNodeSets
Type: array
Unique Items Required: true
Show Source
Nested Schema : converters
Type: array
Show Source
Nested Schema : permittedActions
Type: array
Unique Items Required: true
Show Source
  • Allowed Values: [ "CREATE_CONSTRAINT", "CREATE_NODETYPE", "CREATE_HIERARCHYSET", "CREATE_NODESET", "CREATE_VIEWPOINT", "CREATE_REQUEST", "CREATE_PROPERTY", "ASSIGN_REQUEST", "SUBMIT_REQUEST", "PUSHBACK_REQUEST", "REJECT_REQUEST", "APPROVE_REQUEST", "WITHDRAW_REQUEST", "COMMIT_REQUEST", "ADD_REQUEST_COMMENT", "ADD_REQUEST_ATTACHMENT", "EDIT_REQUEST_HEADER", "VALIDATE", "EDIT_METADATA", "REINDEX", "EDIT", "COPY_VIEWPOINT", "LOAD_VIEWPOINT", "ARCHIVE", "DELETE", "CLOSE", "IMPORT", "EXPORT", "MANAGE_GRANTS", "DELETE_NODE", "ADD_NODE", "INSERT_NODE", "REORDER_NODE", "REMOVE_NODE", "MOVE_NODE", "RECALL_REQUEST", "COPY_EXTRACT", "COPY_LOAD_PROFILE", "UPDATE_VISIBILITY", "COPY", "QUERY", "RUN_EXTRACT_PACKAGE", "CREATE_EXTRACT_PACKAGE" ]
Nested Schema : propertyDefinitions
Type: array
Show Source
Nested Schema : Converter
Type: object
Show Source
Nested Schema : conversion
Type: array
Show Source
Nested Schema : SimpleNodeType
Type: object
Show Source
Nested Schema : PropertyConversion
Type: object
Show Source
Nested Schema : properties
Type: array
Show Source
Nested Schema : NodeTypeProperty
Type: object
Show Source
Nested Schema : NodeSet
Type: object
Node Set model that would be returned as response
Show Source
Nested Schema : nodeTypes
Type: array
Show Source
Nested Schema : permittedActions
Type: array
Unique Items Required: true
Show Source
  • Allowed Values: [ "CREATE_CONSTRAINT", "CREATE_NODETYPE", "CREATE_HIERARCHYSET", "CREATE_NODESET", "CREATE_VIEWPOINT", "CREATE_REQUEST", "CREATE_PROPERTY", "ASSIGN_REQUEST", "SUBMIT_REQUEST", "PUSHBACK_REQUEST", "REJECT_REQUEST", "APPROVE_REQUEST", "WITHDRAW_REQUEST", "COMMIT_REQUEST", "ADD_REQUEST_COMMENT", "ADD_REQUEST_ATTACHMENT", "EDIT_REQUEST_HEADER", "VALIDATE", "EDIT_METADATA", "REINDEX", "EDIT", "COPY_VIEWPOINT", "LOAD_VIEWPOINT", "ARCHIVE", "DELETE", "CLOSE", "IMPORT", "EXPORT", "MANAGE_GRANTS", "DELETE_NODE", "ADD_NODE", "INSERT_NODE", "REORDER_NODE", "REMOVE_NODE", "MOVE_NODE", "RECALL_REQUEST", "COPY_EXTRACT", "COPY_LOAD_PROFILE", "UPDATE_VISIBILITY", "COPY", "QUERY", "RUN_EXTRACT_PACKAGE", "CREATE_EXTRACT_PACKAGE" ]
Nested Schema : topNodes
Type: array
Show Source
Nested Schema : NodeType
Type: object
Show Source
Nested Schema : alternateQualifiers
Type: array
Show Source
Nested Schema : compatibleBoundHierarchySets
Type: array
Unique Items Required: true
Show Source
Nested Schema : compatibleBoundNodeSets
Type: array
Unique Items Required: true
Show Source
Nested Schema : converters
Type: array
Show Source
Nested Schema : permittedActions
Type: array
Unique Items Required: true
Show Source
  • Allowed Values: [ "CREATE_CONSTRAINT", "CREATE_NODETYPE", "CREATE_HIERARCHYSET", "CREATE_NODESET", "CREATE_VIEWPOINT", "CREATE_REQUEST", "CREATE_PROPERTY", "ASSIGN_REQUEST", "SUBMIT_REQUEST", "PUSHBACK_REQUEST", "REJECT_REQUEST", "APPROVE_REQUEST", "WITHDRAW_REQUEST", "COMMIT_REQUEST", "ADD_REQUEST_COMMENT", "ADD_REQUEST_ATTACHMENT", "EDIT_REQUEST_HEADER", "VALIDATE", "EDIT_METADATA", "REINDEX", "EDIT", "COPY_VIEWPOINT", "LOAD_VIEWPOINT", "ARCHIVE", "DELETE", "CLOSE", "IMPORT", "EXPORT", "MANAGE_GRANTS", "DELETE_NODE", "ADD_NODE", "INSERT_NODE", "REORDER_NODE", "REMOVE_NODE", "MOVE_NODE", "RECALL_REQUEST", "COPY_EXTRACT", "COPY_LOAD_PROFILE", "UPDATE_VISIBILITY", "COPY", "QUERY", "RUN_EXTRACT_PACKAGE", "CREATE_EXTRACT_PACKAGE" ]
Nested Schema : propertyDefinitions
Type: array
Show Source
Nested Schema : Node
Type: object
Show Source
Nested Schema : path
Type: array
Show Source
Nested Schema : RequestItem
Type: object
A Request Item is a collection of actions to apply to a particular node as part of aRequest
Show Source
Nested Schema : actions
Type: array
Show Source
Nested Schema : mergeResults
Type: array
Show Source
Nested Schema : policies
Type: array
Show Source
Nested Schema : validations
Type: array
Show Source
Nested Schema : Action
Type: object
Show Source
Nested Schema : layoutOptions
Type: object
Additional Properties Allowed
Show Source
Nested Schema : MergeResultInfo
Type: object
Show Source
Nested Schema : PolicyInfo
Type: object
Show Source
Nested Schema : ValidationResult
Type: object
The result of validation
Show Source
Back to Top

Examples

The following example shows how to update an extract's connection by submitting a GET request on the REST resource using cURL.

cURL Command

curl --user epm_cloud_user -X GET -H 'Content-Type: application/json' -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/epm/rest/v1/extracts/?q=view::71ad7f6b-d313-4a82-956c-ecdbbc7b0ce0

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "id": "791de1e6-4a1a-4ead-93b5-c5492f608fde",
            "name": "AHC Account - non cash",
            "description": "AHC_ACCOUNT_NON_CASH Map natural account by line type and loan type",
            "extractConnection": {
                "connectionSummary": {
                    "id": "b3ee4f46-9b49-4422-b8b5-7113038e7015",
                    "name": "Fusion",
                    "description": "Fusion",
                    "connectionType": "UCM",
                    "links": [
                        {
                            "rel": "self",
                            "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/b3ee4f46-9b49-4422-b8b5-7113038e7015"
                        },
                        {
                            "rel": "delete",
                            "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/b3ee4f46-9b49-4422-b8b5-7113038e7015",
                            "method": "DELETE"
                        }
                    ]
                },
                "connectionOptions": {
                    "defaultDocumentAccount": "fin/fusionAccountingHub/import"
                }
            },
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe/extracts/791de1e6-4a1a-4ead-93b5-c5492f608fde"
                },
                {
                    "rel": "runExtract",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe/extracts/791de1e6-4a1a-4ead-93b5-c5492f608fde/run",
                    "method": "POST"
                },
                {
                    "rel": "extractHistory",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe/extracts/791de1e6-4a1a-4ead-93b5-c5492f608fde/extractHistory?q=limit%3A%3A5",
                    "templated": true
                },
                {
                    "rel": "edit",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe/extracts/791de1e6-4a1a-4ead-93b5-c5492f608fde",
                    "method": "PUT"
                },
                {
                    "rel": "delete",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe/extracts/791de1e6-4a1a-4ead-93b5-c5492f608fde",
                    "method": "DELETE"
                },
                {
                    "rel": "copy",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe/extracts/791de1e6-4a1a-4ead-93b5-c5492f608fde/copy",
                    "method": "POST"
                }
            ],
            "viewpoint": {
                "id": "a7556e2e-2c76-47b4-a18a-db576de1e92c",
                "name": "AHC Loans Non Cash",
                "description": "AHC Loans: Non Cash Mapping Sets",
                "hasHierarchy": true,
                "sortOrder": 3,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/71ad7f6b-d313-4a82-956c-ecdbbc7b0ce0/viewpoints/a7556e2e-2c76-47b4-a18a-db576de1e92c"
                    }
                ],
                "usesCustomSortOrder": false,
                "isBound": false
            },
            "view": {
                "id": "71ad7f6b-d313-4a82-956c-ecdbbc7b0ce0",
                "name": "Mapping Sets",
                "description": "Mapping Sets",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/71ad7f6b-d313-4a82-956c-ecdbbc7b0ce0"
                    }
                ]
            },
            "application": {
                "id": "a3d7a580-17f1-4b0f-9549-cc9c16232f9e",
                "name": "Financials Cloud",
                "description": "Financials Cloud GL",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/applications/a3d7a580-17f1-4b0f-9549-cc9c16232f9e"
                    }
                ]
            },
            "dimension": {
                "id": "14b18bb1-945d-41d2-85c2-30bf3209ccbe",
                "name": "Mapping Sets",
                "description": "Mapping Sets",
                "dimensionType": "Unbound",
                "connected": false,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe"
                    }
                ],
                "isBound": false,
                "canAddBinding": false,
                "supportsMapping": false,
                "supportsMappingExport": false,
                "supportsTemplateExport": true,
                "supportsExtracts": true
            },
            "extractType": "DEFAULT",
            "fileName": "AHC-MapImport.csv",
            "createdByUser": {
                "id": "d93d33f8-f24e-4eaa-8c14-df45501d949a",
                "userName": "Casey.Brown",
                "fullName": "Casey.Brown",
                "firstName": "",
                "lastName": "",
                "emailAddresses": [],
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/d93d33f8-f24e-4eaa-8c14-df45501d949a"
                    }
                ],
                "nameInitials": "",
                "dataManagerOnAny": false
            },
            "timeCreated": "2021-06-16T08:58:59.079Z",
            "modifiedByUser": {
                "id": "d93d33f8-f24e-4eaa-8c14-df45501d949a",
                "userName": "Casey.Brown",
                "fullName": "Casey.Brown",
                "firstName": "",
                "lastName": "",
                "emailAddresses": [],
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/d93d33f8-f24e-4eaa-8c14-df45501d949a"
                    }
                ],
                "nameInitials": "",
                "dataManagerOnAny": false
            },
            "timeModified": "2021-10-26T23:39:45.293Z",
            "lastExtractInfo": {
                "ranBy": "Kerry.Lane",
                "startTime": "2021-07-17T01:52:48.772Z",
                "endTime": "2021-07-17T01:52:49.494Z",
                "success": true,
                "status": "PENDING",
                "connectionName": "Fusion",
                "messages": [
                    "0 records extracted."
                ],
                "extractType": "DEFAULT",
                "publicApiFlag": false
            },
            "profileOwner": {
                "id": "83ed6845-5299-4dce-ad3f-81a92bcc0853",
                "userName": "@@sysadmin",
                "fullName": "System User",
                "firstName": "",
                "lastName": "",
                "emailAddresses": [],
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/83ed6845-5299-4dce-ad3f-81a92bcc0853"
                    }
                ],
                "nameInitials": "",
                "dataManagerOnAny": false
            },
            "public": true
        },
        {
            "id": "9beb7ffb-3779-4bb4-b8b9-6fe5b3f347a6",
            "name": "Cost Management Expense",
            "description": "CST_EXPENSE Mapping set created for account rule: Expense",
            "extractConnection": {
                "connectionSummary": {
                    "id": "b3ee4f46-9b49-4422-b8b5-7113038e7015",
                    "name": "Fusion",
                    "description": "Fusion",
                    "connectionType": "UCM",
                    "links": [
                        {
                            "rel": "self",
                            "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/b3ee4f46-9b49-4422-b8b5-7113038e7015"
                        },
                        {
                            "rel": "delete",
                            "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/b3ee4f46-9b49-4422-b8b5-7113038e7015",
                            "method": "DELETE"
                        }
                    ]
                },
                "connectionOptions": {
                    "defaultDocumentAccount": "fin/fusionAccountingHub/import"
                }
            },
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe/extracts/9beb7ffb-3779-4bb4-b8b9-6fe5b3f347a6"
                },
                {
                    "rel": "runExtract",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe/extracts/9beb7ffb-3779-4bb4-b8b9-6fe5b3f347a6/run",
                    "method": "POST"
                },
                {
                    "rel": "extractHistory",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe/extracts/9beb7ffb-3779-4bb4-b8b9-6fe5b3f347a6/extractHistory?q=limit%3A%3A5",
                    "templated": true
                },
                {
                    "rel": "edit",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe/extracts/9beb7ffb-3779-4bb4-b8b9-6fe5b3f347a6",
                    "method": "PUT"
                },
                {
                    "rel": "delete",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe/extracts/9beb7ffb-3779-4bb4-b8b9-6fe5b3f347a6",
                    "method": "DELETE"
                },
                {
                    "rel": "copy",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe/extracts/9beb7ffb-3779-4bb4-b8b9-6fe5b3f347a6/copy",
                    "method": "POST"
                }
            ],
            "viewpoint": {
                "id": "58ef4757-c3c0-452e-873e-38d926a4b8c8",
                "name": "Cost Mgmt Expenses",
                "description": "Cost Management: Expenses Mapping Set",
                "hasHierarchy": true,
                "sortOrder": 5,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/71ad7f6b-d313-4a82-956c-ecdbbc7b0ce0/viewpoints/58ef4757-c3c0-452e-873e-38d926a4b8c8"
                    }
                ],
                "usesCustomSortOrder": false,
                "isBound": false
            },
            "view": {
                "id": "71ad7f6b-d313-4a82-956c-ecdbbc7b0ce0",
                "name": "Mapping Sets",
                "description": "Mapping Sets",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/71ad7f6b-d313-4a82-956c-ecdbbc7b0ce0"
                    }
                ]
            },
            "application": {
                "id": "a3d7a580-17f1-4b0f-9549-cc9c16232f9e",
                "name": "Financials Cloud",
                "description": "Financials Cloud GL",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/applications/a3d7a580-17f1-4b0f-9549-cc9c16232f9e"
                    }
                ]
            },
            "dimension": {
                "id": "14b18bb1-945d-41d2-85c2-30bf3209ccbe",
                "name": "Mapping Sets",
                "description": "Mapping Sets",
                "dimensionType": "Unbound",
                "connected": false,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe"
                    }
                ],
                "isBound": false,
                "canAddBinding": false,
                "supportsMapping": false,
                "supportsMappingExport": false,
                "supportsTemplateExport": true,
                "supportsExtracts": true
            },
            "extractType": "DEFAULT",
            "fileName": "CMExp-MapImport.csv",
            "createdByUser": {
                "id": "d93d33f8-f24e-4eaa-8c14-df45501d949a",
                "userName": "Casey.Brown",
                "fullName": "Casey.Brown",
                "firstName": "",
                "lastName": "",
                "emailAddresses": [],
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/d93d33f8-f24e-4eaa-8c14-df45501d949a"
                    }
                ],
                "nameInitials": "",
                "dataManagerOnAny": false
            },
            "timeCreated": "2021-06-16T09:57:25.631Z",
            "modifiedByUser": {
                "id": "d93d33f8-f24e-4eaa-8c14-df45501d949a",
                "userName": "Casey.Brown",
                "fullName": "Casey.Brown",
                "firstName": "",
                "lastName": "",
                "emailAddresses": [],
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/d93d33f8-f24e-4eaa-8c14-df45501d949a"
                    }
                ],
                "nameInitials": "",
                "dataManagerOnAny": false
            },
            "timeModified": "2021-10-27T02:10:54.930Z",
            "lastExtractInfo": {
                "ranBy": "Casey.Brown",
                "startTime": "2021-06-16T21:28:34.831Z",
                "endTime": "2021-06-16T21:28:35.124Z",
                "success": true,
                "status": "PENDING",
                "messages": [
                    "55 records extracted."
                ],
                "extractType": "DEFAULT",
                "publicApiFlag": false
            },
            "profileOwner": {
                "id": "83ed6845-5299-4dce-ad3f-81a92bcc0853",
                "userName": "@@sysadmin",
                "fullName": "System User",
                "firstName": "",
                "lastName": "",
                "emailAddresses": [],
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/83ed6845-5299-4dce-ad3f-81a92bcc0853"
                    }
                ],
                "nameInitials": "",
                "dataManagerOnAny": false
            },
            "public": true
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/extracts"
        }
    ],
    "hasMore": false,
    "totalResults": 2,
    "limit": 0,
    "count": 2
}
Back to Top