REST API for Oracle Enterprise Data Management Cloud Service

Update a global connection

put

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

Request

Supported Media Types

application/json

Path Parameters

globalConnectionId: string(uuid)

Root Schema : UpdateGlobalConnectionCommandJson

Type: object

Show Source

connectionDetails: object Update 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 "bucketName", the updated name of the default target bucket and "subfolder", an optional parameter for the sub folder in the target bucket.
description: string

The updated description of the connection
name: string

The updated name of the connection
supportedAppUris: array supportedAppUris

Unique Items Required: true

The set of application uris this connection supports. An empty set implies all applications are supported.

{
    "type":"object",
    "required":[
        "connectionDetails",
        "description",
        "name",
        "supportedAppUris"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The updated name of the connection"
        },
        "description":{
            "type":"string",
            "description":"The updated description of the connection"
        },
        "connectionDetails":{
            "description":"The details specific to this connection type",
            "$ref":"#/definitions/Update Global Connection Details"
        },
        "supportedAppUris":{
            "type":"array",
            "description":"The set of application uris this connection supports. An empty set implies all applications are supported.",
            "uniqueItems":true,
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    }
}

Nested Schema : Update 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 "bucketName", the updated name of the default target bucket and "subfolder", an optional parameter for the sub folder in the target bucket.

Show Source

type: string

Read Only: true

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

Type should be 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 should be 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\"bucketName\", the updated name of the default target bucket and \n\"subfolder\", an optional parameter for the sub folder in the target bucket."
}

Nested Schema : supportedAppUris

Type: array

Unique Items Required: true

The set of application uris this connection supports. An empty set implies all applications are supported.

Show Source

Array of: string(uuid)

{
    "type":"array",
    "description":"The set of application uris this connection supports. An empty set implies all applications are supported.",
    "uniqueItems":true,
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Response

Supported Media Types

application/json

200 Response

Global Connection updated

Root Schema : GlobalConnection

Type: object

Show Source

connectionDetails(optional): 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 "bucketName", the updated name of the default target bucket and "subfolder", an optional parameter for the sub folder in the target bucket.
connectionType(optional): string

Read Only: true

Allowed Values: [ "ORACLE_OBJECT_STORE", "UCM", "EPM" ]
createdByUser(optional): object User
description(optional): string

Read Only: true
id(optional): string(uuid)

Read Only: true
links(optional): array links

Read Only: true
modifiedByUser(optional): object User
name(optional): string

Read Only: true
supportedApplications(optional): array supportedApplications

Read Only: true
timeCreated(optional): integer(int64)

Read Only: true
timeModified(optional): 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

Show Source

type: 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\"bucketName\", the updated name of the default target bucket and \n\"subfolder\", an optional parameter for the sub folder in the target bucket."
}

Nested Schema : User

Type: object

Show Source

artifactAssignments(optional): array artifactAssignments
associatedRoles(optional): array associatedRoles
dataManagerOnAny(optional): boolean
emailAddresses(optional): array emailAddresses
epmIdleSessionTimeout(optional): integer(int32)
firstName(optional): string
fullName(optional): string
grantPermission(optional): string

Allowed Values: [ "OWNER", "DATAMANAGER", "PARTICIPANT", "APPROVER", "NOTIFIED", "COMMITTER", "NONE", "METADATAMANAGER" ]
homePageLayoutName(optional): string
id(optional): string(uuid)
lastName(optional): string
links(optional): array links
nameInitials(optional): string
preferences(optional): object Preferences
ssoToken(optional): string
userName(optional): string

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

languageTag(optional): string
links(optional): array links
outOfOffice(optional): boolean
profilePictureId(optional): string(uuid)
timeZone(optional): object TimeZone

{
    "type":"object",
    "properties":{
        "profilePictureId":{
            "type":"string",
            "format":"uuid"
        },
        "timeZone":{
            "$ref":"#/definitions/TimeZone"
        },
        "languageTag":{
            "type":"string"
        },
        "outOfOffice":{
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : ArtifactAssignment

Type: object

Show Source

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

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

Nested Schema : Artifact

Type: object

Show Source

id(optional): string(uuid)
name(optional): string
type(optional): 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(optional): string
name(optional): string

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

Nested Schema : Link

Type: object

Show Source

href(optional): string
method(optional): string
rel(optional): string
templated(optional): 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(optional): string
dstsavings(optional): integer(int32)
id(optional): string
rawOffset(optional): 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(optional): string

Read Only: true
id(optional): string(uuid)
links(optional): array links
name(optional): 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"
    }
}

400 Response

Error in body

404 Response

Global Connection not found

412 Response

Conflicting update error

Examples

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

cURL Command

curl --user epm_cloud_user -X PUT -H 'Content-Type: application/json' @example_request_payload.json https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/b3ee4f46-9b49-4422-b8b5-7113038e7015

Example of Request Body

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

        {
            "name": "Fusion",
            "description": "Fusion",
            "connectionDetails": {
                "url": "http[s]://hostname[:port]",
                "username": "User1",
                "password": "daa64d99-9c88-4109-a75b-c9756b7d0796",
                "type": "UCM"
            },
            "supportedApplications": []
    }

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