Jump to

• Request
• Response
• Examples

Get a global connection

get

/epm/rest/v1/globalConnections/{globalConnectionId}

Request

Path Parameters

• globalConnectionId(required): string(uuid)

Back to Top

Response

Supported Media Types

• application/json

200 Response

GlobalConnection found

Body ()

Root Schema : GlobalConnection

Type: object

Show Source

• connectionDetails: object 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
• connectionType: string
  Read Only: true

  Allowed Values: [ "ORACLE_OBJECT_STORE", "UCM", "EPM", "AVCS", "AZURE" ]
• 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",
                "AVCS",
                "AZURE"
            ]
        },
        "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 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

• type(required): string
  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.

{
    "type":"object",
    "required":[
        "type"
    ],
    "discriminator":"type",
    "properties":{
        "type":{
            "type":"string",
            "description":"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.",
            "readOnly":true,
            "enum":[
                "ORACLE_OBJECT_STORE",
                "ORACLE_OBJECT_STORE_REQ_SIGN",
                "EPM",
                "EPM_OAUTH",
                "UCM",
                "UCM_OAUTH",
                "AVCS",
                "AZURE"
            ]
        }
    },
    "description":"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. \nEPM connections also include:\n\"url\", the URL for the connection,\n\"identityDomain\", the identity domain for the connection,\n\"username\", the username for the connection,\n\"password\", a placeholder value for the connection's password,\n\"folder\", the default folder in the EPM inbox \n\nEPM OAuth connections also include:\n\"url\", the URL for the connection,\n\"clientId\", a placeholder value for the connection's client id,\n\"accessToken\", a placeholder value for the connection's access token,\n\"refreshToken\", a placeholder value for the connection's refresh token,\n\"authType\", the authentication type for the connection,\n\"folder\", the folder in the EPM inbox \n\n\n\nOracle Object Store connections also include:\n\"url\", the URL for the connection,\n\"username\", the username for the connection,\n\"password\", a placeholder value for the connection's password,\n\"defaultBucket\", the default Object Storage bucket,\n\"defaultSubFolder\", the default Object Storage subfolder \n\n \n\nOracle Object Store API Request Sign authenticated connections also include: \n\"tenancyOciId\", the OCI Tenancy Id for the connection,\n\"userOciId\", the OCI user Id for the connection,\n\"authType\", the authentication type for the connection,\n\"publicKeyFingerprint\", the Fingerprint of the public key for the connection,\n\"privateKeyFileId\", the file Id of the private key that was uploaded to temp for the connection,\n\n\n\nUCM connections using Basic Authentication also include:\n\"url\", the URL for the connection,\n\"username\", the username for the connection,\n\"password\", a placeholder value for the connection's password,\n\"identityDomain\", the identity domain for the connection,\n\"defaultDocumentAccount\", the default UCM document account\n\n\n\nUCM connections using OAuth authentication also include:\n\"url\", the ERP Application URL for the connection,\n\"idcsTokenUrl\", Provider authentication server used to exchange an authorization code for an access token, \n\"clientId\", Client ID for the connection,\n\"scope\", provides a method to govern the amount of access that is granted to a JSON Web Token,\n\"certificateAlias\", Alias name that an EDM user provides while creating the client in ERP IDCS,\n\"privateKeyFileId\", the file Id of the private key that was uploaded to temp for the connection,\n\"authType\", the authentication type for the connection,\n\"defaultDocumentAccount\", the default UCM document account\n\n\n\nAVCS connections also include:\n\"url\", the URL for the connection,\n\"clientId\", the client Id for the connection,\n\"clientSecret\", the client Secret for the connection\n\n\n\nAZURE connections also include:\n\"url\", the URL for the connection,\n\"authType\", the authentication type for the connection,\n\"tenantId\", the tenant Id for the connection,\n\"clientId\", the client Id for the connection,\n\"clientSecret\", the client Secret for the connection,\n\"defaultContainerName\", the name of the default container\n\"defaultFolder\", the name of the default folder\n"
}

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":{
        "id":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "dstsavings":{
            "type":"integer",
            "format":"int32"
        },
        "rawOffset":{
            "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

GlobalConnection not found

Back to Top

Examples

The following example shows how to get the details of a specific global connection by using a get request on the REST resource using cURL.

cURL Command

curl --user epm_cloud_user -X GET https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/b3ee4f46-9b49-4422-b8b5-7113038e7015

Example of Response Body

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

    {
        "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": ""
        }
    }

Back to Top