Sign in

v1

latestOpenAPI 3.1.02026-07-26474165.4 KB
Cache

Generate Cache Connection URL

Generates a URL for users to create or update their cache connection. Returns a string containing the URL to redirect the user to. Users can then add their PostgreSQL connection information to this page.

post/job/cacheConnection/formLink

Request body

redirectURLstring required

The URL to redirect the customer once the customer has edited the connection through the Connect AI UI. This URL maps to the Return to button on the Edit Connection page in the Connect AI UI.

namestring nullable

(Optional) If provided, the connection name. By default, this is a suggested default that the end user can change on the Edit Connection form. Set editableName to false to lock the field and enforce the supplied value server-side.

editableNameboolean

(Optional) The default value is true. When true, any name you supply is shown as a suggested default value, and the end user can change it. When false, the Connection Name field is rendered read-only, and the server enforces the supplied name on submit. Has no effect when name is omitted.

Response

A string containing the URL to redirect the user to. Users can then add their PostgreSQL connection information to this page.

redirectURLstring required

A string containing the CData-hosted connection URL to redirect the user to.