Data Provision REST API | Description |
---|---|
GET provision/connections | Lists the connections configured in an Informatica Intelligent Cloud Services organization |
GET provision/connections/{id} | Lists the connections configured in an Informatica Intelligent Cloud Services organization for a connection ID |
POST provision/connections/{id}/test | Creates a test connection |
GET provision/connections/config | Lists the connection configuration option for all the supported types |
GET provision/connections/config/{type} | Lists the connection configuration options for a supported type |
GET provision/info | Lists whether data provisioning is available to user |
GET provision/preview | Lists the preview data of a data object |
GET provision/provisionableResources | Lists the resources that support data provisioning |
GET provision/resources | Lists all the resources with connection details |
GET provision/resources/{resourceName} | Lists the connections configured for a resource |
PUT provision/resources/{resourceName} | Creates or updates the connection configuration for a resource |
DELETE provision/resources/{resourceName} | Deletes the connection for a resource |
GET provision/task | Lists all provisioning tasks |
POST provision/task | Submits a provisioning task |
GET provision/task/{id} | Lists the provisioning tasks for a task ID |
DELETE provision/task/{id} | Deletes a provisioning task |
GET provision/users | Lists the list of configured Informatica Intelligent Cloud Services users in the enterprise |
PUT provision/users | Configures or updates the credentials of all the Informatica Intelligent Cloud Services users |
PUT provision/users/{id} | Configures or updates the credentials of an Informatica Intelligent Cloud Services user |
DELETE provision/users/{id} | Deletes an Informatica Intelligent Cloud Services user |
POST provision/users/validate | Validates and returns the Informatica Intelligent Cloud Services user details |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/provision/connections |
HTTP Method Type | GET |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
icsUsername | Required | The user name to log in to Informatica Intelligent Cloud Services. | Query | String |
runTimeEnvId | Optional | The runtime environment ID to filter the connections. | Query | String |
connType | Optional | Choose one of the following supported Informatica Intelligent Cloud Services connection types to filter the connections:
| Query | String |
Code | Reason |
---|---|
200 | Listed Informatica Intelligent Cloud Service connections. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog//provision/connections/{id} |
HTTP Method Type | GET |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
icsUsername | Required | The user name to log in to Informatica Intelligent Cloud Services. | Query | String |
id | Required | The ID of the connection. | Path | String |
Code | Reason |
---|---|
200 | Listed Informatica Intelligent Cloud Services connections. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/provision/connections/{id}/test |
HTTP Method Type | POST |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
id | Required | The ID of the connection. | Path | String |
testRequest | Required | Enter the connection attributes. | Body | - |
Parameter | Required or Optional | Description | Data Type | Values |
---|---|---|---|---|
configOptions | Optional | Configuration options for a connection. | - | Enter the following configuration options:
|
href | Optional | The link to the resource. | String | - |
id | Required | The connection ID. | ||
isAppendable | Optional | Allowed to create append target. Default is false. | Boolean | |
isCreatable | Optional | Allowed to create a target. Default is false. | Boolean | |
name | Optional | The name of the connection. | String | - |
orgId | Optional | The ID of the organization. | String | - |
runtimeEnvironmentId | Optional | The runtime environment used by the connection. | String | - |
type | Optional | Enter one of the following connection types:
| String | - |
icsUsername | Required | The user name to log in to Informatica Intelligent Cloud Services. | String |
Code | Reason |
---|---|
200 | Created the test connection. |
201 | Created the test connection. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/provision/connections/config |
HTTP Method Type | GET |
Code | Reason |
---|---|
200 | Listed the connection configuration options for the supported resource types. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/provision/connections/config/{type} |
HTTP Method Type | GET |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
type | Required | Enter one of the following connection types:
| Path | String |
Code | Reason |
---|---|
200 | Listed the configured connections for the supported type. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/provision/info |
HTTP Method Type | GET |
Code | Reason |
---|---|
200 | Provided the data provisioning information. |
400 | Missing or invalid parameter |
401 | Missing credentials |
403 | User does not have the required access permissions |
404 | Requested object not found |
429 | Rate limit for requests encountered |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/provision/preview |
HTTP Method Type | GET |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
icsUsername | Required | The user name to log in to Informatica Intelligent Cloud Services. | Query | String |
objectId | Required | The ID of the data object in Enterprise Data Catalog. | Query | String |
connectionId | Required | The ID of the connection for the data object in Informatica Intelligent Cloud Services. | Query | String |
configOpt | Required | Enter one or more user names and its associated passwords as key-value pairs in the following format: <key>:<value> For example, username:test1 password:test1 | Query | Array [String] |
Code | Reason |
---|---|
200 | Listed the preview of data for the data object. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/provision/provisionableResources |
HTTP Method Type | GET |
Code | Reason |
---|---|
200 | Listed the resources that support data provisioning. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/provision/resources |
HTTP Method Type | GET |
Code | Reason |
---|---|
200 | Listed the resources with the connection details. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/provision/resources/{resourceName} |
HTTP Method Type | GET |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
resourceName | Required | The name of the resource | Path | String |
Code | Reason |
---|---|
200 | Listed the resource with connection details. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/provision/resources/{resourceName} |
HTTP Method Type | PUT |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
resourceName | Required | The name of the resource. | Path | String |
connConf | Required | Enter the attribute parameters. | Body | - |
If-Match | Optional | Enter a value to display the results that match the value. Do not update if the entity tag or Etag for the resource has changed. | Header | String |
Parameter | Required or Optional | Description | Data Type | Values |
---|---|---|---|---|
connectionId | Required | The ID of the Informatica Intelligent Cloud Services connection. | String | - |
href | Optional | Link to resource configuration. | String | - |
icsUsername | Required | The user name to log in to Informatica Intelligent Cloud Services. | String | - |
orgId | Required | The ID of the organization that the icsUsername belongs to. | String | |
orgName | Required | The name of the organization. | String | - |
resourceName | Required | The name of the resource | String | - |
Code | Reason |
---|---|
200 | Updated the connection configuration for a resource. |
201 | Created the connection configuration for a resource. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
412 | Conflicting edit detected. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/provision/resources/{resourceName} |
HTTP Method Type | DELETE |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
resourceName | Required | The name of the resource. | Path | String |
Code | Reason |
---|---|
200 | Deleted the connection to the resource. |
204 | No content. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/provision/task |
HTTP Method Type | GET |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
objectId | Optional | Enter one or more data object IDs. | Query | Array [String] |
resourceName | Optional | Enter one or more resource names. Enterprise Data Catalog ignores this parameter if you enter an objectId. | Query | Array [String] |
Code | Reason |
---|---|
200 | Listed the provisioning tasks. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/provision/task |
HTTP Method Type | POST |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
provisionTask | Required | Enter the provisioning task attributes. | Body | - |
Parameter | Required or Optional | Description | Data Type | Values |
---|---|---|---|---|
createTarget | Required | Enter true to create a target. Enter false to append rows to an existing table. | Boolean | Enter one of the following values:
|
icsUsername | Required | The user name to log in to Informatica Intelligent Cloud Services. | String | - |
objectId | Required | The ID of the source object. | String | - |
orgId | Required | The ID of the organization that the icsUsername belongs to. | String | |
srcDetails | Required | Enter the source configuration options. | - | Enter the following values:
Choose Oracle or SQLServer for the type parameter. |
targetName | Required | Name of the target object. You do not need a target name if you want to append rows to an existing table, To create a table, enter a target name. | String | - |
tgtDetails | Required | Enter the target configuration options. | - | Enter the following values:
Choose Oracle, Amazon S3, SQLServer, or Tableau Online for the type parameter. |
truncateTarget | Required | Enter false to create a new asset or overwrite existing data. Enter true to append the data to an existing asset or create a new asset. | Boolean | Enter one of the following values:
|
Code | Reason |
---|---|
201 | Submitted the provisioning task in Enterprise Data Catalog. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
412 | Conflicting edit detected. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/provision/task/{id} |
HTTP Method Type | GET |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
id | Required | The ID of the task | Path | String |
Code | Reason |
---|---|
200 | Listed the provisioning task for the specified task. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/provision/task/{id} |
HTTP Method Type | DELETE |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
id | Required | The ID of the provisioning task | Path | String |
Code | Reason |
---|---|
200 | Deleted the provisioning task entry. |
204 | No content. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/provision/users |
HTTP Method Type | GET |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
orgId | Optional | Enter one or more organization ID to filter the users. | Query | Array [String] |
username | Optional | Enter one or more Informatica Intelligent Cloud Services user names to filter the users. Enterprise Data Catalog ignores this option if you enter an orgId. | Query | Array [String] |
Code | Reason |
---|---|
200 | Listed the Informatica Intelligent Cloud Services users in your enterprise. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/provision/users |
HTTP Method Type | PUT |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
users | Required | Enter the attribute parameters. | Body | - |
Parameter | Required or Optional | Description | Data Type |
---|---|---|---|
href | Optional | The URL to access the secure agent. | String |
icsUsername | Required | The username to log in to Informatica Intelligent Cloud Services. | String |
orgId | Optional | The name of the orgID of the Informatica Intelligent Cloud Services user. | String |
orgName | Optional | The name of the organization that the Informatica Intelligent Cloud Services user belongs to. | String |
password | Required | The password of the Informatica Intelligent Cloud Services user. | String |
Code | Reason |
---|---|
200 | Created or updated the user details. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
412 | Conflicting edit detected. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/provision/users/{id} |
HTTP Method Type | PUT |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
id | Required | The user name of the Informatica Intelligent Cloud Services user. | Path | String |
user | Required | Enter the attribute parameters. | Body | - |
If-Match | Optional | Enter a value to display the results that match the value. Do not update if the entity tag or Etag for the resource has changed. | Header | String |
Parameter | Required or Optional | Description | Data Type |
---|---|---|---|
href | Optional | The URL to access the secure agent. | String |
icsUsername | Required | The username to log in to Informatica Intelligent Cloud Services. | String |
orgId | Optional | The name of the orgID of the Informatica Intelligent Cloud Services user. | String |
orgName | Optional | The name of the organization that the Informatica Intelligent Cloud Services user belongs to. | String |
password | Required | The password of the Informatica Intelligent Cloud Services user. | String |
Code | Reason |
---|---|
200 | Created or updated the user details. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
412 | Conflicting edit detected. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/provision/users/{id} |
HTTP Method Type | DELETE |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
id | Required | The ID of the Enterprise Data Catalog user. | Path | String |
Code | Reason |
---|---|
200 | Deleted the specified Enterprise Data Catalog user. |
204 | No content. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/provision/users/validate |
HTTP Method Type | POST |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
users | Required | Enter the required user attributes. | Body | - |
Parameter | Required or Optional | Description | Data Type |
---|---|---|---|
href | Optional | The URL to access the secure agent. | String |
icsUsername | Required | The user name to log in to Informatica Intelligent Cloud Services. | String |
orgId | Optional | The name of the orgID of the Informatica Intelligent Cloud Services user. | String |
orgName | Optional | The name of the organization that the Informatica Intelligent Cloud Services user belongs to. | String |
password | Required | The password of the Informatica Intelligent Cloud Services user. | String |
nextCursorMark | Optional | When the request supports cursor pagination this parameter is populated. Deep pagination using cursors can be more efficient. | String |
partialResults | Optional | Choose true if the response must not contain results from all the appropriate shards. | Boolean |
totalCount | Optional | Total number of results. | Integer |
Code | Reason |
---|---|
200 | Validated and returned the Informatica Intelligent Cloud Services user details. |
201 | Created. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
412 | Conflicting edit detected. |
429 | Rate limit for requests encountered. |