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

Show Source

• accessToken: string
  The updated access token for the connection. Required for the OAuth authentication type
• clientId: string
  The updated client ID for the connection. Required for the OAuth authentication type.
• domain: string
  The updated identity domain for non-OAuth connection.
• password: string
  The updated password for the connection. Required for the Basic authentication type.
• refreshToken: string
  The updated refresh token for the connection. Required for the OAuth authentication type.
• url(required): string
  The updated target url of the connection.
• username: string
  The updated username for the connection. Required for the Basic authentication type.

{
    "type":"object",
    "required":[
        "url"
    ],
    "properties":{
        "url":{
            "type":"string",
            "description":"The updated target url of the connection."
        },
        "domain":{
            "type":"string",
            "description":"The updated identity domain for non-OAuth connection."
        },
        "username":{
            "type":"string",
            "description":"The updated username for the connection.  Required for the Basic authentication type."
        },
        "password":{
            "type":"string",
            "description":"The updated password for the connection.  Required for the Basic authentication type."
        },
        "clientId":{
            "type":"string",
            "description":"The updated client ID for the connection.  Required for the OAuth authentication type."
        },
        "refreshToken":{
            "type":"string",
            "description":"The updated refresh token for the connection.  Required for the OAuth authentication type."
        },
        "accessToken":{
            "type":"string",
            "description":"The updated access token for the connection.  Required for the OAuth authentication type"
        }
    }
}

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
• clientId: string
  Read Only: true

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

  A placeholder value for the connection's password
• refreshToken: string
  Read Only: true

  A placeholder value for the connection's refresh token
• 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
        },
        "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",
                "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\":\"\",\"username\":\"epm_default_cloud_admin\",\"password\":\"daa64d99-9c88-4109-a75b-c9756b7d0796\"}",
        "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