Update global connection for an extract
/epm/rest/v1/extracts/{extractId}/connectionInfo
Request
- application/json
object
-
connectionName(required):
string
Name of the global connection to use for the extract. The connection must be allowed for the application of the viewpoint extract.
-
connectionOptions(required):
object connectionOptions
Options for the global connection used by the extract. "Object" Storage expects 'bucket' with an optional 'subfolder' field. "EPM" Cloud expects 'folder' field. "UCM" expects 'defaultDocumentAccount'.
object
Response
- application/json
200 Response
400 Response
403 Response
404 Response
Examples
The following example shows how to update an extract's connection by submitting a PUT request on the REST resource using cURL.
cURL Command
curl --user epm_cloud_user -X PUT -H 'Content-Type: application/json' -d
@example_request_payload.json https://servername.fa.us2.oraclecloud.com/epm/rest/v1/extracts/248238ed-87de-4268-9e5e-d1d3272feec8/connectionInfo
Example of Request Body
The following shows an example of the request body in JSON format. Note that the connectionOption is dependent on the type of the Connection type.
{ "connectionName": "EPM Connection Type", "connectionOptions": { "folder": "inbox" } }
An Object Storage Connection Type requires bucketName as the connectionOptions
{ "connectionName": "Object Storage Connection Type", "connectionOptions": { "bucketName": "inbox" "subFolder": "extracts" } }
Example of Response Body
The following shows an example of the response body in JSON format.
{ "id": "248238ed-87de-4268-9e5e-d1d3272feec8", "name": "Profiles", "description": "Profiles Extract", "extractConnection": { "connectionSummary": { "id": "6ac90bfa-dca5-42c3-bbdd-5c801d6e4cfb", "name": "EPM Test", "connectionType": "EPM", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/6ac90bfa-dca5-42c3-bbdd-5c801d6e4cfb" }, { "rel": "delete", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/6ac90bfa-dca5-42c3-bbdd-5c801d6e4cfb", "method": "DELETE" } ] }, "connectionOptions": { "folder": "inbox" } }, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/a7d099fe-a85f-40f8-ad74-94f6115acf48/extracts/248238ed-87de-4268-9e5e-d1d3272feec8" }, { "rel": "runExtract", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/a7d099fe-a85f-40f8-ad74-94f6115acf48/extracts/248238ed-87de-4268-9e5e-d1d3272feec8/run", "method": "POST" }, { "rel": "extractHistory", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/a7d099fe-a85f-40f8-ad74-94f6115acf48/extracts/248238ed-87de-4268-9e5e-d1d3272feec8/extractHistory?q=limit%3A%3A5", "templated": true }, { "rel": "edit", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/a7d099fe-a85f-40f8-ad74-94f6115acf48/extracts/248238ed-87de-4268-9e5e-d1d3272feec8", "method": "PUT" }, { "rel": "delete", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/a7d099fe-a85f-40f8-ad74-94f6115acf48/extracts/248238ed-87de-4268-9e5e-d1d3272feec8", "method": "DELETE" }, { "rel": "copy", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/a7d099fe-a85f-40f8-ad74-94f6115acf48/extracts/248238ed-87de-4268-9e5e-d1d3272feec8/copy", "method": "POST" } ], "viewpoint": { "id": "aca3fbd7-4653-496e-b79b-25fb62b6355c", "name": "Profiles", "description": "Profiles", "hasHierarchy": false, "sortOrder": 1, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/2def5a63-14ba-4c08-a4f3-5f70865787fe/viewpoints/aca3fbd7-4653-496e-b79b-25fb62b6355c" } ], "usesCustomSortOrder": false, "isBound": true }, "view": { "id": "2def5a63-14ba-4c08-a4f3-5f70865787fe", "name": "Account Reconciliation", "description": "Account Reconciliation Default View", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/2def5a63-14ba-4c08-a4f3-5f70865787fe" } ] }, "application": { "id": "75afe171-e65f-48eb-b2c8-a101c42966b6", "name": "Account Reconciliation", "description": "Account Reconciliation", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/applications/75afe171-e65f-48eb-b2c8-a101c42966b6" } ] }, "dimension": { "id": "a7d099fe-a85f-40f8-ad74-94f6115acf48", "name": "Profiles", "description": "Profiles", "dimensionType": "User Defined", "connected": false, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/a7d099fe-a85f-40f8-ad74-94f6115acf48" } ], "isBound": true, "canAddBinding": false, "supportsMapping": true, "supportsMappingExport": false, "supportsTemplateExport": true, "supportsExtracts": true }, "extractType": "DEFAULT", "fileName": "Profiles.csv", "createdByUser": { "id": "d93d33f8-f24e-4eaa-8c14-df45501d949a", "userName": "Casey.Brown", "fullName": "Casey.Brown", "firstName": "", "lastName": "", "emailAddresses": [], "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/d93d33f8-f24e-4eaa-8c14-df45501d949a" } ], "nameInitials": "", "dataManagerOnAny": false }, "timeCreated": "2021-04-03T00:09:10.283Z", "modifiedByUser": { "id": "ed283658-5ecc-4ce7-a226-ed04705c6d2a", "userName": "dcosby", "fullName": "Doug Cosby", "firstName": "Doug", "lastName": "Cosby", "emailAddresses": [], "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/ed283658-5ecc-4ce7-a226-ed04705c6d2a" } ], "nameInitials": "DC", "dataManagerOnAny": false }, "timeModified": "2023-06-22T17:23:26.353Z", "profileOwner": { "id": "83ed6845-5299-4dce-ad3f-81a92bcc0853", "userName": "@@sysadmin", "fullName": "System User", "firstName": "", "lastName": "", "emailAddresses": [], "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/83ed6845-5299-4dce-ad3f-81a92bcc0853" } ], "nameInitials": "", "dataManagerOnAny": false }, "public": true }