HOPEX Power Studio (EN) : Using APIs : HOPEX Web Service API : Requesting connexion information
   
Requesting connexion information
 
Environment list request
Repository list request
Repository URL
Environment list request
± http GET {WEBSERVICEURL}/environments
 
Result example:
HTTP/1.1 202 Accepted
 
<Environments>
<Environment>
<Id>W7AHcK4gNb76</Id>
<Name>C:\Users\Public\Documents\HOPEX V2\SQLSrv2014</Name>
</Environment>
</Environments>
Repository list request
± http GET {WEBSERVICEURL}/environments/{env_id}/repositories
 
Where:
o {env_id}: environment identifier that can be retrieved from the result of the environment list request
Result example:
HTTP/1.1 202 Accepted
 
<EnvironmentDatabases Name="W7AHcK4gNb76">
<Base>
<Id>MIwdE)9gNz9I</Id>
<Name>Demo</Name>
</Base>
<Base>
<Id>97AHhW5gNLSd</Id>
<Name>New</Name>
</Base>
</EnvironmentDatabases>
 
Repository URL
All endpoints accessing repository features or data must conform the following:
• Prefix endpoint specific URL elements by the {REPOSITORYBASEURL}
{REPOSITORYBASEURL} = {WEBSERVICEURL}/environments/{env_id}/repositories/{rep_id}/profiles/{prof_id}
Where:
o {env_id}: environment identifier
o {rep_id}: repository identifier
o {prof_id}: profile identifier
• Authentication
All requests executing in the context of a repository workspace must contain authentication information in the headers part of the http request.
The authorization header must respect the following format:
 
Authorization: HOPEXBASIC <user>:<password>
 
Example:
 
± http GET {REPOSITORYBASEURL}/export?{parameters}
Authorization: HOPEXBASIC mylogin:xyx123