Jump to

• Request
• Response
• Examples

Test a global connection

post

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

Request

Supported Media Types

• application/json

Path Parameters

• globalConnectionId(required): string(uuid)

Body ()

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", the password for the connection. Leave blank to use the already stored password. EPM OAuth connections also include: "url", the URL for the connection, "clientId", the client Id for the connection. Leave blank to use the already client Id, "accessToken", the access token for the connection. Leave blank to use the already stored access token, "refreshToken", the refresh token for the connection. Leave blank to use the already refresh token, "authType", the authentication type for the connection. Use OAuth. Oracle Object Store connections also include: "url", the URL for the connection, "username", the username for the connection, "password", the password for the connection. Leave blank to use the already stored password, "defaultBucket", the updated default Object Storage bucket. 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, "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 also include: "url", the URL for the connection, "username", the username for the connection, "password", the password for the connection. Leave blank to use the already stored password, "identityDomain", the identity domain for the connection. 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. Leave blank to use the already stored client Id, "clientSecret", the client Secret for the connection. Leave blank to use the already stored client Secret. AZURE connections also include: "url", the URL 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 default container name, "defaultFolder", the default folder name. EXTERNAL_VALIDATION connections also include: "url", the URL for the connection, "username", the username for the connection, "password", the password for the connection. Leave blank to use the already stored password, "maxBatchSize", The maximum number of nodes that should be validated by the external system in a single batch, up to 10,000. The default is 1,000, "maxConcurrentProcesses", The maximum number of concurrent validation processes that should be run by the external system, up to 3. The default is 1.

Root Schema : Global Connection Test 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", the password for the connection. Leave blank to use the already stored password. EPM OAuth connections also include: "url", the URL for the connection, "clientId", the client Id for the connection. Leave blank to use the already client Id, "accessToken", the access token for the connection. Leave blank to use the already stored access token, "refreshToken", the refresh token for the connection. Leave blank to use the already refresh token, "authType", the authentication type for the connection. Use OAuth. Oracle Object Store connections also include: "url", the URL for the connection, "username", the username for the connection, "password", the password for the connection. Leave blank to use the already stored password, "defaultBucket", the updated default Object Storage bucket. 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, "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 also include: "url", the URL for the connection, "username", the username for the connection, "password", the password for the connection. Leave blank to use the already stored password, "identityDomain", the identity domain for the connection. 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. Leave blank to use the already stored client Id, "clientSecret", the client Secret for the connection. Leave blank to use the already stored client Secret. AZURE connections also include: "url", the URL 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 default container name, "defaultFolder", the default folder name. EXTERNAL_VALIDATION connections also include: "url", the URL for the connection, "username", the username for the connection, "password", the password for the connection. Leave blank to use the already stored password, "maxBatchSize", The maximum number of nodes that should be validated by the external system in a single batch, up to 10,000. The default is 1,000, "maxConcurrentProcesses", The maximum number of concurrent validation processes that should be run by the external system, up to 3. The default is 1.

Show Source

• type(required): string
  Read Only: true

  Allowed Values: [ "ORACLE_OBJECT_STORE", "ORACLE_OBJECT_STORE_REQ_SIGN", "EPM", "EPM_OAUTH", "UCM", "AZURE", "EXTERNAL_VALIDATION" ]

  Type should be set to "EPM" for Oracle Cloud EPM connections, "EPM_OAUTH" for Oracle EPM_OAUTH connections, "UCM" for Oracle Cloud ERP connections, "ORACLE_OBJECT_STORE" for Oracle Object Store connections, "AVCS" for Oracle Address, Email, and Phone Verification connections,"ORACLE_OBJECT_STORE_REQ_SIGN" for Oracle Object Store API Request Sign Authenticated connections, "AZURE" for Azure Connections and "EXTERNAL_VALIDATION" for External Validation 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, \"ORACLE_OBJECT_STORE\" for Oracle Object Store connections, \"AVCS\" for Oracle Address, Email, and Phone Verification connections,\"ORACLE_OBJECT_STORE_REQ_SIGN\" for Oracle Object Store API Request Sign Authenticated connections, \"AZURE\" for Azure Connections and \"EXTERNAL_VALIDATION\" for External Validation connections.",
            "readOnly":true,
            "enum":[
                "ORACLE_OBJECT_STORE",
                "ORACLE_OBJECT_STORE_REQ_SIGN",
                "EPM",
                "EPM_OAUTH",
                "UCM",
                "AZURE",
                "EXTERNAL_VALIDATION"
            ]
        }
    },
    "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.\n\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\", the password for the connection. Leave blank to use the already stored password.\n\nEPM OAuth connections also include:\n\"url\", the URL for the connection,\n\"clientId\", the client Id for the connection. Leave blank to use the already client Id,\n\"accessToken\", the access token for the connection. Leave blank to use the already stored access token,\n\"refreshToken\", the refresh token for the connection. Leave blank to use the already refresh token,\n\"authType\", the authentication type for the connection. Use OAuth.\n\nOracle Object Store connections also include:\n\"url\", the URL for the connection,\n\"username\", the username for the connection,\n\"password\", the password for the connection. Leave blank to use the already stored password,\n\"defaultBucket\", the updated default Object Storage bucket.\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\"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\nUCM connections also include:\n\"url\", the URL for the connection,\n\"username\", the username for the connection,\n\"password\", the password for the connection. Leave blank to use the already stored password,\n\"identityDomain\", the identity domain for the connection.\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\nAVCS connections also include:\n\"url\", the URL for the connection,\n\"clientId\", the client Id for the connection. Leave blank to use the already stored client Id,\n\"clientSecret\", the client Secret for the connection. Leave blank to use the already stored client Secret.\n\nAZURE connections also include:\n\"url\", the URL 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 default container name,\n\"defaultFolder\", the default folder name.\n\nEXTERNAL_VALIDATION connections also include:\n\"url\", the URL for the connection,\n\"username\", the username for the connection,\n\"password\", the password for the connection. Leave blank to use the already stored password,\n\"maxBatchSize\", The maximum number of nodes that should be validated by the external system in a single batch, up to 10,000. The default is 1,000,\n\"maxConcurrentProcesses\", The maximum number of concurrent validation processes that should be run by the external system, up to 3. The default is 1.\n\n"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : TestConnectionResult

Type: object

Show Source

• messages: string
• success: boolean

{
    "type":"object",
    "properties":{
        "success":{
            "type":"boolean"
        },
        "messages":{
            "type":"string"
        }
    }
}

400 Response

Error in body

404 Response

Connection not found

Back to Top

Examples

The following example shows how to test a global connection by using a POST request on the REST resource using cURL.

cURL Command

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

Example of Request Body

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

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

Example of Response Body

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

    {
        "success": true,
        "messages": null
    }

Back to Top