REST API Reference

Back Next

Managing Secure Agent group selections

You can use the runtimeEnvironment resource to enable or disable

Informatica Intelligent Cloud Services

and connectors for a Secure Agent group. You can also get details about the selections.

Use a GET request to get the details about a Secure Agent group's enabled and disabled selections. Use a PUT request to assign a Secure Agent group to services and connectors.

GET request

You can request information about the selections that are enabled for a Secure Agent group. You can also request information about all of the selections that are available for a Secure Agent group based on the organization's license. The response includes the names and IDs of the available services and connectors.

To get information about enabled selections, use the following URI:

/api/v2/runtimeEnvironment/<id>/selections

To get information about all of the selections that are available to a Secure Agent group, use the following URI:

/api/v2/runtimeEnvironment/<id>/selections/details

GET response

Returns the Secure Agent group selections. If successful, returns the following fields:

Field	Type	Description
services		Contains selection information for services.
selections		Contains information for enabled services. If the request is to include details, also contains selection information for disabled services.
id	String	Included in the selections object. Service ID.
name	String	Included in the selections object. Service name.
enabled	Boolean	Included in the selections object. Whether the service is enabled for the Secure Agent group.
connectors		Contains selection information for connectors.
selections		Contains information for enabled connectors. If the request is to include details, also contains selection information for disabled connectors.
id	String	Included in the selections object. Connector ID.
name	String	Included in the selections object. Connector name.
enabled	Boolean	Included in the selections object. Whether the connector is enabled for the Secure Agent group.
Additional services		Contains selection information for additional services, for example, Git.
selections		Contains information for additional services that are enabled. If the request is to include details, also contains selection information for additional services that are disabled.
id	String	Included in the selections object. Service ID.
name	String	Included in the selections object. Service name.
enabled	Boolean	Included in the selections object. Whether the service is enabled for the Secure Agent group.

GET request example

The following example shows a request to get information about enabled selections:

POST <serverUrl>/api/v2/runtimeEnvironment/00000425000000000004/selections
Accept:application/json
icSessionId: <icSessionId>

The following example shows a request to get information about enabled and disabled selections:

POST <serverUrl>/api/v2/runtimeEnvironment/00000425000000000004/selections/details
Accept:application/json
icSessionId: <icSessionId>

GET response example

If the request is for enabled and disabled selections, you might receive a response similar to the following example:

{
  "services": {
    "selections": [
      {
        "id": "00000047000000000002",
        "name": "Data Integration",
        "enabled": true
      }
    ]
  },
  "connectors": {
    "selections": [
      {
        "id": "01000000000005L",
        "name": "Amazon Redshift v2",
        "enabled": true
      },

     {
        "id": "01000000000005Q",
        "name": "Amazon S3",
        "enabled": false
      }
    ]
  },
  "additionalServices": {
    "selections": [
      {
        "id": "00000048000000000002",
        "name": "Git",
        "enabled": false
      }
    ]
  }
}

PUT request

To enable services and connectors for a Secure Agent group, include the agent group ID as shown in the following URI:

/api/v2/runtimeEnvironment/<id>/selections

To see a list of all of the services and connectors that are available and find the selection IDs, use a GET request to obtain information about enabled and disabled selections.

Include the following fields in the request:

Field	Type	Required	Description
id	String	Yes	The selection object ID.
name	String	-	The selection object name.
enabled	Boolean	-	Whether to enable or disable the selection.

PUT request example

If you want to select the Data Integration service, the Amazon Redshift v2 connector, and the Git service for a Secure Agent group, the request might be similar to the following example:

The IDs shown in the example are examples only. Use a GET request to find the selection IDs and names that are available to the Secure Agent group.

PUT <serverUrl>/api/v2/runtimeEnvironment/00000425000000000004/selections
Accept:application/json
icSessionId: <icSessionId>
{
  "services": {
    "selections": [
      {
        "id": "00000047000000000002",
        "name": "Data Integration",
        "enabled": true
      }
    ]
  },
  "connectors": {
    "selections": [
      {
        "id": "01000000000005L",
        "name": "Amazon Redshift v2",
        "enabled": false
      },
      {
        "id": "01000000000005M",
        "name": "Amazon S3 v2",
        "enabled": false
      }
    ]
  },
  "additionalServices": {
    "selections": [
      {
        "id": "00000047000000000013",
        "name": "Self-hosted Git Repo",
        "enabled": true
      }
    ]
  }
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Managing Secure Agent group selections

Managing Secure Agent group selections

GET request

GET response

GET request example

GET response example

PUT request

PUT request example