Jump to

• Request
• Response
• Examples

Update a connection for an application

put

/epm/rest/v1/applications/{applicationId}/connections/{connectionId}

Request

Supported Media Types

• application/json

Path Parameters

• applicationId(required): string(uuid)
• connectionId(required): string(uuid)
  Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Body ()

The updated details of the connection

Root Schema : UpdateApplicationConnectionCommandJson

Type: object

Show Source

• connectionDetails(required): object UpdateApplicationConnectionDetailsCommandJson
  Updates an application connection. Prefer 'authDetails' with type BASIC, OAUTH, or JWT_OAUTH.Legacy fields are deprecated and retained for compatibility.
• description(required): string
  Description of the application connection.
• name(required): string
  Name of the application connection
• primary: boolean
  Boolean flag to specify if this connection is the primary connection for the application

{
    "type":"object",
    "required":[
        "connectionDetails",
        "description",
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the application connection"
        },
        "description":{
            "type":"string",
            "description":"Description of the application connection."
        },
        "connectionDetails":{
            "description":"Connection details",
            "$ref":"#/definitions/UpdateApplicationConnectionDetailsCommandJson"
        },
        "primary":{
            "type":"boolean",
            "description":"Boolean flag to specify if this connection is the primary connection for the application"
        }
    }
}

Nested Schema : UpdateApplicationConnectionDetailsCommandJson

Type: object

Updates an application connection. Prefer 'authDetails' with type BASIC, OAUTH, or JWT_OAUTH.Legacy fields are deprecated and retained for compatibility.

Show Source

• accessToken: string
  Deprecated: use authDetails.accessToken (OAUTH).
• authDetails(required): object ApplicationConnectionAuthDetails
  Discriminator: authType

  Authentication details for an application connection. Use 'authType' = BASIC or OAUTH or JWT_OAUTH. EPM connections using BASIC Authentication require: "authType", the authentication type for the connection, use BASIC "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. "folder", the default folder in the EPM inbox EPM connections using OAUTH Authentication require: "authType", the authentication type for the connection, use OAUTH "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. "folder", the folder in the EPM inbox FCGL Application connections using BASIC Authentication require: "authType", the authentication type for the connection, use BASIC "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, FCGL Application connections using OAUTH Authentication require: "authType", the authentication type for the connection, use JWT_OAUTH "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 temp file uploaded for the connection.
• clientId: string
  Deprecated: use authDetails.clientId (OAUTH).
• domain: string
  Deprecated: use authDetails.domain (BASIC).
• password: string
  Deprecated: use authDetails.password (BASIC).
• refreshToken: string
  Deprecated: use authDetails.refreshToken (OAUTH).
• url(required): string
  The updated target url of the connection.
• username: string
  Deprecated: use authDetails.username (BASIC).

{
    "type":"object",
    "required":[
        "authDetails",
        "url"
    ],
    "properties":{
        "url":{
            "type":"string",
            "description":"The updated target url of the connection."
        },
        "authDetails":{
            "description":"Preferred authentication details. Provide 'type' = BASIC, OAUTH, or JWT_OAUTH. If provided, legacy fields are ignored. \n\nEPM Application type supports BASIC or OAUTH Authentication. \nFCGL Application type supports BASIC or JWT_OAUTH Authentication.",
            "$ref":"#/definitions/ApplicationConnectionAuthDetails"
        },
        "username":{
            "type":"string",
            "description":"Deprecated: use authDetails.username (BASIC).",
            "x-deprecated":{
                "value":"true"
            }
        },
        "password":{
            "type":"string",
            "description":"Deprecated: use authDetails.password (BASIC).",
            "x-deprecated":{
                "value":"true"
            }
        },
        "domain":{
            "type":"string",
            "description":"Deprecated: use authDetails.domain (BASIC).",
            "x-deprecated":{
                "value":"true"
            }
        },
        "clientId":{
            "type":"string",
            "description":"Deprecated: use authDetails.clientId (OAUTH).",
            "x-deprecated":{
                "value":"true"
            }
        },
        "refreshToken":{
            "type":"string",
            "description":"Deprecated: use authDetails.refreshToken (OAUTH).",
            "x-deprecated":{
                "value":"true"
            }
        },
        "accessToken":{
            "type":"string",
            "description":"Deprecated: use authDetails.accessToken (OAUTH).",
            "x-deprecated":{
                "value":"true"
            }
        }
    },
    "description":"Updates an application connection. Prefer 'authDetails' with type BASIC, OAUTH, or JWT_OAUTH.Legacy fields are deprecated and retained for compatibility."
}

Nested Schema : ApplicationConnectionAuthDetails

Type: object

Discriminator: authType

Authentication details for an application connection. Use 'authType' = BASIC or OAUTH or JWT_OAUTH. EPM connections using BASIC Authentication require: "authType", the authentication type for the connection, use BASIC "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. "folder", the default folder in the EPM inbox EPM connections using OAUTH Authentication require: "authType", the authentication type for the connection, use OAUTH "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. "folder", the folder in the EPM inbox FCGL Application connections using BASIC Authentication require: "authType", the authentication type for the connection, use BASIC "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, FCGL Application connections using OAUTH Authentication require: "authType", the authentication type for the connection, use JWT_OAUTH "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 temp file uploaded for the connection.

Show Source

• authType: string
  Read Only: true

{
    "type":"object",
    "discriminator":"authType",
    "properties":{
        "authType":{
            "type":"string",
            "readOnly":true
        }
    },
    "description":"Authentication details for an application connection.  Use 'authType' = BASIC or OAUTH or JWT_OAUTH.  \n\nEPM connections using BASIC Authentication require:\n\"authType\", the authentication type for the connection, use BASIC\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\"folder\", the default folder in the EPM inbox \n\n\n\nEPM connections using OAUTH Authentication require:\n\"authType\", the authentication type for the connection, use OAUTH\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\"folder\", the folder in the EPM inbox \n\n\n\nFCGL Application connections using BASIC Authentication require:\n\"authType\", the authentication type for the connection, use BASIC\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\n\n\nFCGL Application connections using OAUTH Authentication require:\n\"authType\", the authentication type for the connection, use JWT_OAUTH\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 temp file uploaded for the connection.\n"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Application Connection updated

Body ()

Root Schema : Connection

Type: object

Show Source

• connectionDetails: string
  Read Only: true

  A string containing a json representation of the connection details
• connectionInfo: object ConnectionInfo
• description: string
  Read Only: true

  The description of the connection
• id: string(uuid)
  Read Only: true
• links: array links
  Read Only: true
• name: string
  Read Only: true

  The name of the connection
• primary: boolean
  A flag indicating if this is the primary connection for this application

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"The name of the connection",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "description":"The description of the connection",
            "readOnly":true
        },
        "connectionDetails":{
            "type":"string",
            "description":"A string containing a json representation of the connection details",
            "readOnly":true
        },
        "primary":{
            "type":"boolean",
            "description":"A flag indicating if this is the primary connection for this application"
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "connectionInfo":{
            "description":"The url and authentication information for the connection",
            "readOnly":true,
            "$ref":"#/definitions/ConnectionInfo"
        }
    }
}

Nested Schema : ConnectionInfo

Type: object

Show Source

• accessToken: string
  Read Only: true

  A placeholder value for the connection's access token
• certificateAlias: string
  Read Only: true

  A placeholder value for the connection's Certificate Alias
• clientId: string
  Read Only: true

  A placeholder value for the connection's clientId
• domain: string
  The identity domain for the connection
• idcsTokenUrl: string
  Read Only: true

  A placeholder value for the connection's IDCS Token Url
• password: string
  Read Only: true

  A placeholder value for the connection's password
• privateKeyFileId: string(uuid)
  Read Only: true

  A placeholder value for the connection's private key File Id
• refreshToken: string
  Read Only: true

  A placeholder value for the connection's refresh token
• scope: string
  Read Only: true

  A placeholder value for the connection's Scope
• url: string
  Read Only: true

  The target url of the connection
• username: string
  Read Only: true

  The user name to authenticate the connection

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "description":"The target url of the connection",
            "readOnly":true
        },
        "username":{
            "type":"string",
            "description":"The user name to authenticate the connection",
            "readOnly":true
        },
        "password":{
            "type":"string",
            "description":"A placeholder value for the connection's password",
            "readOnly":true
        },
        "clientId":{
            "type":"string",
            "description":"A placeholder value for the connection's clientId",
            "readOnly":true
        },
        "accessToken":{
            "type":"string",
            "description":"A placeholder value for the connection's access token",
            "readOnly":true
        },
        "refreshToken":{
            "type":"string",
            "description":"A placeholder value for the connection's refresh token",
            "readOnly":true
        },
        "idcsTokenUrl":{
            "type":"string",
            "description":"A placeholder value for the connection's IDCS Token Url",
            "readOnly":true
        },
        "scope":{
            "type":"string",
            "description":"A placeholder value for the connection's Scope",
            "readOnly":true
        },
        "certificateAlias":{
            "type":"string",
            "description":"A placeholder value for the connection's Certificate Alias",
            "readOnly":true
        },
        "privateKeyFileId":{
            "type":"string",
            "format":"uuid",
            "description":"A placeholder value for the connection's private key File Id",
            "readOnly":true
        },
        "domain":{
            "type":"string",
            "description":"The identity domain for the connection"
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

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

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

400 Response

Error in body

404 Response

Application Connection not found

Back to Top

Examples

The following example shows how to update the details of a specific application 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/applications/e63e92c4-4727-4999-97f2-50498cb40ec7/connections/ea2328ed-48d3-45dd-b033-fc447a5e2a77

Example of Request Body

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

        {
            "name": "Production",
            "description": "Production Pod",
            "primary": true,
            "connectionDetails": {
                "url": "https://servername.fa.us2.oraclecloud.com",
                "authDetails" : {
                    "authType" : "BASIC",
                    "username": "epm_default_cloud_admin",
                    "password": "password",
                    "domain": ""
                }
            }
        }
    
    

Example of Response Body

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

    {
        "id": "ea2328ed-48d3-45dd-b033-fc447a5e2a77",
        "name": "Production",
        "description": "Production Pod",
        "connectionDetails": "{\"url\":\"https://servername.fa.us2.oraclecloud.com\",\"domain\":\"\",\"authDetails\":{\"username\":\"epm_default_cloud_admin\",\"password\":\"daa64d99-9c88-4109-a75b-c9756b7d0796\",\"authType\":\"BASIC\"}}",
        "links": [
            {
                "rel": "self",
                "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/applications/e63e92c4-4727-4999-97f2-50498cb40ec7/connections/ea2328ed-48d3-45dd-b033-fc447a5e2a77"
            },
            {
                "rel": "edit",
                "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/applications/e63e92c4-4727-4999-97f2-50498cb40ec7/connections/ea2328ed-48d3-45dd-b033-fc447a5e2a77",
                "method": "PUT"
            },
            {
                "rel": "testConnection",
                "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/applications/e63e92c4-4727-4999-97f2-50498cb40ec7/connections/ea2328ed-48d3-45dd-b033-fc447a5e2a77/test",
                "method": "POST"
            },
            {
                "rel": "connectionResources",
                "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/applications/e63e92c4-4727-4999-97f2-50498cb40ec7/connections/ea2328ed-48d3-45dd-b033-fc447a5e2a77/resources",
                "templated": true,
                "method": "GET"
            }
        ],
        "connectionInfo": {
            "url": "https://servername.fa.us2.oraclecloud.com",
            "username": "epm_default_cloud_admin",
            "password": "daa64d99-9c88-4109-a75b-c9756b7d0796",
            "domain": ""
        },
        "primary": true
    }

Back to Top