Purpose

Returns the member data sources for the group data source.

Note: An administrator can execute this operation on behalf of a user by appending the user query parameter to the request and specifying a user name. See also Managing resources on behalf of users.

URL

https://<myserver>:<port>/api/mgmt/datasources/{groupDatasourceId}/members

Method

GET

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a non-load balancer deployment, or the machine hosting the load balancer for a load balancer deployment. For a non-load balancer deployment, <port> is the port number specified as the Server Access Port during deployment. For a load balancer deployment, <port> must be either 80 for http or 443 for https. Whenever port 80 or 443 are used, it is not necessary to include the port number in the URL.

The {groupDatasourceId} parameter must also be specified in the URL.

Parameter Description Valid Values
{groupDatasourceId} The ID of the group data source. The ID is auto-generated when the group data source is created and cannot be changed.

Response Definition

The request takes the following format. The properties of the request are described in the table that follows.

Note: The members object is an array that contains one or more member data sources. Each data source must have an ID and an entity prefix.
{
   "members": [
      {
        "id": idnum1,
        "entityPrefix": "prefix1"
      },
      {
        "id": idnum2,
        "entityPrefix": "prefix2"
       }
    ]
}

If the group data source has no members, the response is an empty list.

{
   "members": []
}
Parameter Description Valid Values
"id" The ID of the member data source that belongs to the group data source The ID is auto-generated when the data source is created and cannot be changed.

A member data source cannot itself be a group data source.
"entityPrefix" A user-defined prefix associated with a specific data source to resolve naming conflicts.

This prefix is added to all tables that come from the specified data source. For example, suppose a member data source is specified with the prefix acct and the data source has a table named customers. This table is identified by the name acct_customers in the group data source.

 The prefix must be 1 to 64 characters in length and must be unique.

Sample Server Response


  Status code: 200
  Successful response
            

{
   "members": [
      {
        "id": 3,
        "entityPrefix": "fin"
      },
      {
        "id": 6,
        "entityPrefix": "mkt"
       }     
    ]
}

Authentication

Basic Authentication using Login ID and Password.

Authorization

The user must have the MgmtAPI (11) and ViewDataSource (2) permissions.