Jump to

• Request
• Response
• Examples

Update a global connection

put

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

Request

Supported Media Types

• application/json

Path Parameters

• globalConnectionId(required): string(uuid)

Body ()

Root Schema : UpdateGlobalConnectionCommandJson

Type: object

Show Source

• connectionDetails(required): object Update 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 updated URL for the connection, "identityDomain", the updated identity domain for the connection, "username", the updated username for the connection, "password", the updated password for the connection, "folder", the updated default folder in the EPM inbox EPM OAuth connections also include: "url", the updated URL for the connection, "clientId", the updated client Id for the connection, "accessToken", the updated access token for the connection, "refreshToken", the updated refresh token for the connection, "authType", the authentication type for the connection. Use OAuth. "folder", the updated folder in the EPM inbox Oracle Object Store connections also include: "url", the updated URL for the connection, "username", the updated username for the connection, "password", the updated password for the connection, "defaultBucket", the updated default Object Storage bucket, "defaultSubFolder", the updated Object Storage subfolder UCM connections also include: "url", the updated URL for the connection, "username", the updated username for the connection, "password", the updated password for the connection, "identityDomain", the updated identity domain for the connection, "defaultDocumentAccount", the updated default UCM document account
• description(required): string
  The updated description of the connection
• name(required): string
  The updated name of the connection
• supportedAppUris(required): 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 a "type", the type of the connection. See the "type" object for allowed values. EPM connections also include: "url", the updated URL for the connection, "identityDomain", the updated identity domain for the connection, "username", the updated username for the connection, "password", the updated password for the connection, "folder", the updated default folder in the EPM inbox EPM OAuth connections also include: "url", the updated URL for the connection, "clientId", the updated client Id for the connection, "accessToken", the updated access token for the connection, "refreshToken", the updated refresh token for the connection, "authType", the authentication type for the connection. Use OAuth. "folder", the updated folder in the EPM inbox Oracle Object Store connections also include: "url", the updated URL for the connection, "username", the updated username for the connection, "password", the updated password for the connection, "defaultBucket", the updated default Object Storage bucket, "defaultSubFolder", the updated Object Storage subfolder UCM connections also include: "url", the updated URL for the connection, "username", the updated username for the connection, "password", the updated password for the connection, "identityDomain", the updated identity domain for the connection, "defaultDocumentAccount", the updated default UCM document account

Show Source

• type(required): string
  Read Only: true

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

  Type should be set to "EPM" for Oracle Cloud EPM connections, "EPM_OAUTH" Oracle Cloud EPM OAUTH connections, "UCM" for Oracle Cloud ERP 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 Cloud EPM connections, \"EPM_OAUTH\" Oracle Cloud EPM OAUTH connections, \"UCM\" for Oracle Cloud ERP connections and \"ORACLE_OBJECT_STORE\" for Oracle Object Store connections.",
            "readOnly":true,
            "enum":[
                "ORACLE_OBJECT_STORE",
                "EPM",
                "EPM_OAUTH",
                "UCM"
            ]
        }
    },
    "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 updated URL for the connection,\n\"identityDomain\", the updated identity domain for the connection,\n\"username\", the updated username for the connection,\n\"password\", the updated password for the connection,\n\"folder\", the updated default folder in the EPM inbox \n\nEPM OAuth connections also include:\n\"url\", the updated URL for the connection,\n\"clientId\", the updated client Id for the connection,\n\"accessToken\", the updated access token for the connection,\n\"refreshToken\", the updated refresh token for the connection,\n\"authType\", the authentication type for the connection. Use OAuth.\n\"folder\", the updated folder in the EPM inbox \n\nOracle Object Store connections also include:\n\"url\", the updated URL for the connection,\n\"username\", the updated username for the connection,\n\"password\", the updated password for the connection,\n\"defaultBucket\", the updated default Object Storage bucket,\n\"defaultSubFolder\", the updated Object Storage subfolder \n\nUCM connections also include:\n\"url\", the updated URL for the connection,\n\"username\", the updated username for the connection,\n\"password\", the updated password for the connection,\n\"identityDomain\", the updated identity domain for the connection,\n\"defaultDocumentAccount\", the updated default UCM document account\n"
}

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Global Connection updated

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 UCM connections 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
• 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 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 UCM connections 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

Show Source

• type(required): string
  Read Only: true

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

  Type is set to "EPM" for Oracle Cloud EPM connections, "EPM_OAUTH" for Oracle Cloud EPM OAUTH connections, "UCM" for Oracle Cloud ERP 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 Cloud EPM connections, \"EPM_OAUTH\" for Oracle Cloud EPM OAUTH connections, \"UCM\" for Oracle Cloud ERP connections and \"ORACLE_OBJECT_STORE\" for Oracle Object Store connections.",
            "readOnly":true,
            "enum":[
                "ORACLE_OBJECT_STORE",
                "EPM",
                "EPM_OAUTH",
                "UCM"
            ]
        }
    },
    "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\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\nUCM 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\"identityDomain\", the identity domain for the connection,\n\"defaultDocumentAccount\", the default UCM document account\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":{
        "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"
    }
}

400 Response

Error in body

404 Response

Global Connection not found

412 Response

Conflicting update error

Back to Top

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

Back to Top