Purpose

Most non-relational data sources supported by Hybrid Data Pipeline maintain a map that defines how the non-relational object model is mapped to a set of relational tables with rows and columns. Issuing a POST request to the map resource allows this map to be refreshed or recreated. The map should be refreshed when a change has been made to the back end non-relational data model. The map should be recreated if the options used by the data source to generate the map are changed.

Important: This API only refreshes the relational map of non-relational data sources. See Create or refresh a data source OData model for details on refreshing an OData data model for a data source.

URL

https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}/map

Method

POST

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 {datasourceId} parameter must also be specified in the URL.

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

Request Definition

{
	"map": "setting"
}
Property Description Usage Valid Values
"map"

Specifies whether the relational map of the non-relational data store should be refreshed or recreated.

 Required "refresh" | "recreate"

If set to "refresh", the relational map of the non-relational data store is refreshed. The map should be refreshed when a change has been made to the back end data model.

If set to "recreate", the relational map of the non-relational data store is recreated. The map should be recreated if the options used by the data source to generate the map are changed. This call will also pick up any changes made to the back end data model.

Sample Request Payload 


{
  "map": "refresh"
}

Sample Server Response 


  Status code: 200
  Successful response
            

{
   "success":true
}

Sample Server Failure Response 


{
  "error":{
    "code":222207029,
    "message":{
      "lang":"en-US",
      "value":"Expected values for model: refresh / none. Your value was False. Please try again with proper value."
    }
  }
}

Authentication

Basic Authentication using Login ID and Password.

Authorization

The user must have the MgmtAPI (11) and ModifyDataSource (3) permissions.