Jump to

• Request
• Response
• Examples

Get all global connections

get

/epm/rest/v1/globalConnections

Request

Query Parameters

• q: string
  Filters Global Connections

  Allowed Values: [ "supportedApplication::{id of the supported application}" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Global Connections found

Body ()

Root Schema : ItemsGlobalConnections

Type: object

Show Source

• count: integer(int32)
• hasMore: boolean
• items: array items
  Read Only: true
• limit: integer(int32)
• links: array links
  Read Only: true
• offset: integer(int32)
• totalResults: integer(int32)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/GlobalConnection"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "hasMore":{
            "type":"boolean"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "offset":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : items

Type: array

Read Only: true

Show Source

• Array of: object GlobalConnection

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/GlobalConnection"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : GlobalConnection

Type: object

Show Source

• connectionDetails: object Global Connection Details
  Discriminator: type

  The details specific to this connection type. All connection types include "type", the type of the connection, see the 'type' object for allowed values, "url", the updated url for the connection, "username", the updated username for the connection, and "password", the updated password for the connection. EPM connections also include "identityDomain", the updated identity domain for the connection, and "folder", the updated epm folder. UCM connections also include "identityDomain", the updated identity domain for the connection, and "defaultDocumentAccount", the updated default document account. Oracle Object Store connections also include "defaultBucket", the updated name of the default target bucket and "defaultBucket", an optional parameter for the sub folder in the target bucket.
• connectionType: string
  Read Only: true

  Allowed Values: [ "ORACLE_OBJECT_STORE", "UCM", "EPM" ]
• createdByUser: object User
• description: string
  Read Only: true
• id: string(uuid)
  Read Only: true
• links: array links
  Read Only: true
• modifiedByUser: object User
• name: string
  Read Only: true
• supportedApplications: array supportedApplications
  Read Only: true
• timeCreated: integer(int64)
  Read Only: true
• timeModified: integer(int64)
  Read Only: true

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "readOnly":true
        },
        "connectionDetails":{
            "readOnly":true,
            "$ref":"#/definitions/Global Connection Details"
        },
        "connectionType":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "ORACLE_OBJECT_STORE",
                "UCM",
                "EPM"
            ]
        },
        "timeCreated":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "timeModified":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "supportedApplications":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/IdNameLink"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "createdByUser":{
            "readOnly":true,
            "$ref":"#/definitions/User"
        },
        "modifiedByUser":{
            "readOnly":true,
            "$ref":"#/definitions/User"
        }
    }
}

Nested Schema : Global Connection Details

Type: object

Discriminator: type

The details specific to this connection type. All connection types include "type", the type of the connection, see the 'type' object for allowed values, "url", the updated url for the connection, "username", the updated username for the connection, and "password", the updated password for the connection. EPM connections also include "identityDomain", the updated identity domain for the connection, and "folder", the updated epm folder. UCM connections also include "identityDomain", the updated identity domain for the connection, and "defaultDocumentAccount", the updated default document account. Oracle Object Store connections also include "defaultBucket", the updated name of the default target bucket and "defaultBucket", an optional parameter for the sub folder in the target bucket.

Show Source

• type(required): string
  Read Only: true

  Allowed Values: [ "ORACLE_OBJECT_STORE", "EPM", "UCM" ]

  Type is set to "EPM" for Oracle EPM Cloud connections, "UCM" for Oracle ERP Cloud connections and "ORACLE_OBJECT_STORE" for Oracle Object Store connections.

{
    "type":"object",
    "required":[
        "type"
    ],
    "discriminator":"type",
    "properties":{
        "type":{
            "type":"string",
            "description":"Type is set to \"EPM\" for Oracle EPM Cloud connections, \"UCM\" for Oracle ERP Cloud connections and \"ORACLE_OBJECT_STORE\" for Oracle Object Store connections.",
            "readOnly":true,
            "enum":[
                "ORACLE_OBJECT_STORE",
                "EPM",
                "UCM"
            ]
        }
    },
    "description":"The details specific to this connection type. All connection types include \n\"type\", the type of the connection, see the 'type' object for allowed values, \n\"url\", the updated url for the connection, \n\"username\", the updated username for the connection, and \n\"password\", the updated password for the connection. \n\nEPM connections also include \n\"identityDomain\", the updated identity domain for the connection, and \n\"folder\", the updated epm folder. \n\nUCM connections also include \n\"identityDomain\", the updated identity domain for the connection, and \n\"defaultDocumentAccount\", the updated default document account. \n\nOracle Object Store connections also include \n\"defaultBucket\", the updated name of the default target bucket and \n\"defaultBucket\", an optional parameter for the sub folder in the target bucket."
}

Nested Schema : User

Type: object

Show Source

• artifactAssignments: array artifactAssignments
• associatedRoles: array associatedRoles
• dataManagerOnAny: boolean
• emailAddresses: array emailAddresses
• epmIdleSessionTimeout: integer(int32)
• firstName: string
• fullName: string
• grantPermission: string
  Allowed Values: [ "OWNER", "DATAMANAGER", "PARTICIPANT", "APPROVER", "NOTIFIED", "COMMITTER", "NONE", "METADATAMANAGER" ]
• homePageLayoutName: string
• id: string(uuid)
• lastName: string
• links: array links
• nameInitials: string
• preferences: object Preferences
• ssoToken: string
• userName: string
• userServiceAdministrator: boolean

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "userName":{
            "type":"string"
        },
        "fullName":{
            "type":"string"
        },
        "firstName":{
            "type":"string"
        },
        "lastName":{
            "type":"string"
        },
        "ssoToken":{
            "type":"string"
        },
        "emailAddresses":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "associatedRoles":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Role"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "preferences":{
            "$ref":"#/definitions/Preferences"
        },
        "nameInitials":{
            "type":"string"
        },
        "grantPermission":{
            "type":"string",
            "enum":[
                "OWNER",
                "DATAMANAGER",
                "PARTICIPANT",
                "APPROVER",
                "NOTIFIED",
                "COMMITTER",
                "NONE",
                "METADATAMANAGER"
            ]
        },
        "dataManagerOnAny":{
            "type":"boolean"
        },
        "userServiceAdministrator":{
            "type":"boolean"
        },
        "epmIdleSessionTimeout":{
            "type":"integer",
            "format":"int32"
        },
        "homePageLayoutName":{
            "type":"string"
        },
        "artifactAssignments":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ArtifactAssignment"
            }
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : supportedApplications

Type: array

Read Only: true

Show Source

• Array of: object IdNameLink

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/IdNameLink"
    }
}

Nested Schema : artifactAssignments

Type: array

Show Source

• Array of: object ArtifactAssignment

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ArtifactAssignment"
    }
}

Nested Schema : associatedRoles

Type: array

Show Source

• Array of: object Role

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Role"
    }
}

Nested Schema : emailAddresses

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Preferences

Type: object

Show Source

• actAsThisRole: string
  Allowed Values: [ "USER", "SERVICE_ADMINISTRATOR" ]
• delegateToUserId: string(uuid)
• languageTag: string
• links: array links
• outOfOffice: boolean
• profilePictureId: string(uuid)
• timeZone: object TimeZone

{
    "type":"object",
    "properties":{
        "profilePictureId":{
            "type":"string",
            "format":"uuid"
        },
        "timeZone":{
            "$ref":"#/definitions/TimeZone"
        },
        "languageTag":{
            "type":"string"
        },
        "outOfOffice":{
            "type":"boolean"
        },
        "delegateToUserId":{
            "type":"string",
            "format":"uuid"
        },
        "actAsThisRole":{
            "type":"string",
            "enum":[
                "USER",
                "SERVICE_ADMINISTRATOR"
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : ArtifactAssignment

Type: object

Show Source

• artifact: object Artifact
• sortOrder: integer(int32)
• visible: boolean

{
    "type":"object",
    "properties":{
        "artifact":{
            "$ref":"#/definitions/Artifact"
        },
        "sortOrder":{
            "type":"integer",
            "format":"int32"
        },
        "visible":{
            "type":"boolean"
        }
    }
}

Nested Schema : Artifact

Type: object

Show Source

• id: string(uuid)
• name: string
• type: string
  Allowed Values: [ "CLUSTER", "CARD" ]

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "CLUSTER",
                "CARD"
            ]
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : Role

Type: object

Show Source

• id: string
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• method: string
• rel: string
• templated: boolean

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "templated":{
            "type":"boolean"
        },
        "method":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : TimeZone

Type: object

Show Source

• displayName: string
• dstsavings: integer(int32)
• id: string
• rawOffset: integer(int32)

{
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "rawOffset":{
            "type":"integer",
            "format":"int32"
        },
        "dstsavings":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : IdNameLink

Type: object

Show Source

• description: string
  Read Only: true
• id: string(uuid)
• links: array links
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

404 Response

Global Connections not found

Back to Top

Examples

The following example shows how to retrieve all the global connections by submitting a GET request on the REST resource using cURL.

curl --user edmcs_cloud_user -X GET https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
    "items": [
        {
            "id": "b3ee4f46-9b49-4422-b8b5-7113038e7015",
            "name": "Fusion",
            "description": "Fusion",
            "connectionDetails": {
                "url": "http[s]://hostname[:port]",
                "username": "User1",
                "password": "daa64d99-9c88-4109-a75b-c9756b7d0796",
                "type": "UCM"
            },
            "connectionType": "UCM",
            "timeCreated": "2021-06-16T08:57:04.163Z",
            "timeModified": "2022-01-05T03:22:07.488Z",
            "supportedApplications": [],
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/b3ee4f46-9b49-4422-b8b5-7113038e7015"
                },
                {
                    "rel": "edit",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/b3ee4f46-9b49-4422-b8b5-7113038e7015",
                    "method": "PUT"
                },
                {
                    "rel": "delete",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/b3ee4f46-9b49-4422-b8b5-7113038e7015",
                    "method": "DELETE"
                },
                {
                    "rel": "testConnection",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/b3ee4f46-9b49-4422-b8b5-7113038e7015/test",
                    "method": "POST"
                }
            ],
            "createdByUser": {
                "id": "d93d33f8-f24e-4eaa-8c14-df45501d949a",
                "userName": "Casey.Brown",
                "fullName": "Casey Brown",
                "firstName": "Casey",
                "lastName": "Brown",
                "emailAddresses": [],
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/d93d33f8-f24e-4eaa-8c14-df45501d949a"
                    }
                ],
                "nameInitials": ""
            },
            "modifiedByUser": {
                "id": "d93d33f8-f24e-4eaa-8c14-df45501d949a",
                "userName": "Casey.Brown",
                "fullName": "Casey Brown",
                "firstName": "Casey",
                "lastName": "Brown",
                "emailAddresses": [],
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/d93d33f8-f24e-4eaa-8c14-df45501d949a"
                    }
                ],
                "nameInitials": ""
            }
        },
        {
            "id": "779366dc-b0d4-45d2-9018-afdbcf4ff748",
            "name": "Account Reconciliation",
            "description": "Account Reconciliation Production",
            "connectionDetails": {
                "url": "http[s]://hostname[:port]",
                "username": "User1",
                "password": "daa64d99-9c88-4109-a75b-c9756b7d0796",
                "type": "EPM"
            },
            "connectionType": "EPM",
            "timeCreated": "2021-04-02T23:44:55.840Z",
            "timeModified": "2022-01-05T03:21:41.171Z",
            "supportedApplications": [],
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/779366dc-b0d4-45d2-9018-afdbcf4ff748"
                },
                {
                    "rel": "edit",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/779366dc-b0d4-45d2-9018-afdbcf4ff748",
                    "method": "PUT"
                },
                {
                    "rel": "delete",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/779366dc-b0d4-45d2-9018-afdbcf4ff748",
                    "method": "DELETE"
                },
                {
                    "rel": "testConnection",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/779366dc-b0d4-45d2-9018-afdbcf4ff748/test",
                    "method": "POST"
                }
            ],
            "createdByUser": {
                "id": "d93d33f8-f24e-4eaa-8c14-df45501d949a",
                "userName": "Casey.Brown",
                "fullName": "Casey Brown",
                "firstName": "Casey",
                "lastName": "Brown",
                "emailAddresses": [],
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/d93d33f8-f24e-4eaa-8c14-df45501d949a"
                    }
                ],
                "nameInitials": ""
            },
            "modifiedByUser": {
                "id": "d93d33f8-f24e-4eaa-8c14-df45501d949a",
                "userName": "Casey.Brown",
                "fullName": "Casey Brown",
                "firstName": "Casey",
                "lastName": "Brown",
                "emailAddresses": [],
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/d93d33f8-f24e-4eaa-8c14-df45501d949a"
                    }
                ],
                "nameInitials": ""
            }
        },
        {
            "id": "81ed9bc5-0a59-437b-8715-3c769aadfd4e",
            "name": "Financial Consolidation and Close",
            "description": "Financial Consolidation and Close Extracts",
            "connectionDetails": {
                "url": "http[s]://hostname[:port]",
                "username": "User1",
                "password": "daa64d99-9c88-4109-a75b-c9756b7d0796",
                "folder": "inbox",
                "type": "EPM"
            },
            "connectionType": "EPM",
            "timeCreated": "2021-08-05T00:26:06.258Z",
            "timeModified": "2022-01-05T03:21:52.760Z",
            "supportedApplications": [],
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/81ed9bc5-0a59-437b-8715-3c769aadfd4e"
                },
                {
                    "rel": "edit",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/81ed9bc5-0a59-437b-8715-3c769aadfd4e",
                    "method": "PUT"
                },
                {
                    "rel": "delete",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/81ed9bc5-0a59-437b-8715-3c769aadfd4e",
                    "method": "DELETE"
                },
                {
                    "rel": "testConnection",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/81ed9bc5-0a59-437b-8715-3c769aadfd4e/test",
                    "method": "POST"
                }
            ],
            "createdByUser": {
                "id": "d93d33f8-f24e-4eaa-8c14-df45501d949a",
                "userName": "Casey.Brown",
                "fullName": "Casey Brown",
                "firstName": "Casey",
                "lastName": "Brown",
                "emailAddresses": [],
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/d93d33f8-f24e-4eaa-8c14-df45501d949a"
                    }
                ],
                "nameInitials": ""
            },
            "modifiedByUser": {
                "id": "d93d33f8-f24e-4eaa-8c14-df45501d949a",
                "userName": "Casey.Brown",
                "fullName": "Casey Brown",
                "firstName": "Casey",
                "lastName": "Brown",
                "emailAddresses": [],
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/d93d33f8-f24e-4eaa-8c14-df45501d949a"
                    }
                ],
                "nameInitials": ""
            }
        },
        {
            "id": "3172e803-eb66-49b8-9721-6918cb6c629a",
            "name": "VisPCM",
            "description": "Profitability and Cost Management VisPCM",
            "connectionDetails": {
                "url": "http[s]://hostname[:port]",
                "username": "user1",
                "password": "daa64d99-9c88-4109-a75b-c9756b7d0796",
                "folder": "profitinbox",
                "type": "EPM"
            },
            "connectionType": "EPM",
            "timeCreated": "2021-07-02T19:38:34.180Z",
            "timeModified": "2022-01-05T03:22:18.943Z",
            "supportedApplications": [],
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/3172e803-eb66-49b8-9721-6918cb6c629a"
                },
                {
                    "rel": "edit",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/3172e803-eb66-49b8-9721-6918cb6c629a",
                    "method": "PUT"
                },
                {
                    "rel": "delete",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/3172e803-eb66-49b8-9721-6918cb6c629a",
                    "method": "DELETE"
                },
                {
                    "rel": "testConnection",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/3172e803-eb66-49b8-9721-6918cb6c629a/test",
                    "method": "POST"
                }
            ],
            "createdByUser": {
                "id": "d93d33f8-f24e-4eaa-8c14-df45501d949a",
                "userName": "Casey.Brown",
                "fullName": "Casey Brown",
                "firstName": "Casey",
                "lastName": "Brown",
                "emailAddresses": [],
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/d93d33f8-f24e-4eaa-8c14-df45501d949a"
                    }
                ],
                "nameInitials": ""
            },
            "modifiedByUser": {
                "id": "d93d33f8-f24e-4eaa-8c14-df45501d949a",
                "userName": "Casey.Brown",
                "fullName": "Casey Brown",
                "firstName": "Casey",
                "lastName": "Brown",
                "emailAddresses": [],
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/d93d33f8-f24e-4eaa-8c14-df45501d949a"
                    }
                ],
                "nameInitials": ""
            }
        }
    ],
    "links": [
        {
            "rel": "create",
            "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections",
            "method": "POST"
        }
    ],
    "hasMore": false,
    "totalResults": 4,
    "limit": 0,
    "count": 4
}

Back to Top