The management service is a SOAP service that allows you to access and edit your studio repository without the use of studio. Everything that the studio does graphically can be done via methods in the management service. You could theoretically build your own studio that connects to the management service. This article describes how to authenticate and the different methods of the management service.
| Note |
|---|
| title | minOccurences in the XSD |
|---|
|
Although many parameters in the XSD have a minOccurence of zero, almost all parameters are required. We advise to ignore the <!--Optional:--> line some tools such as SoapUI generate based on the minOccurence. |
For authentication, you have to send your credentials with each request to the management service. Depending on your settings in studio, this might for example be Basic or NTLM.
| Expand |
|---|
| title | Examples of how to configure authentication in SOAPUI |
|---|
|
Basic  Image Modified
NTLM
|
We distinguish different categories of methods:
...
UnitTests
ExecuteAllUnitTests
Returns the result of all unit tests that are defined within a specific module scope.
| Expand |
|---|
|
| Parameter | Parameter description | Required/optional |
|---|
| repository | The name of the repository of which the the unit tests have to be executed | required | | branch | The name of the branch of which the the unit tests have to be executed | required | | project | The name of the project of which the the unit tests have to be executed | required | | module | The module scope of which the unit tests have to be executed. This includes tests and logic defined in the given module and all underlying modules. | required |
|
| Expand |
|---|
|
| Code Block |
|---|
| <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<soapenv:Header/>
<soapenv:Body>
<ns:ExecuteAllUnitTests>
<ns:repository>Kinderbijslag</ns:repository>
<ns:branch>Trunk</ns:branch>
<ns:project>Kinderbijslag</ns:project>
<ns:module Name="Top" ModuleType="Interaction"/>
</ns:ExecuteAllUnitTests>
</soapenv:Body>
</soapenv:Envelope> |
| Code Block |
|---|
| <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ExecuteAllUnitTestsResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<ExecuteAllUnitTestsResult>
<Succeeded>true</Succeeded>
<Results>
<UnitTestReport>
<UnitTestName>SoortKind_AangehuwdKind</UnitTestName>
<ProfileResults>
<ProfileResult>
<ProfileId>0</ProfileId>
<UnitTestResult>
<ExpectedValue>
<string>AangehuwdKind</string>
</ExpectedValue>
<SourcedValue>
<string>AangehuwdKind</string>
</SourcedValue>
<Succeeded>true</Succeeded>
</UnitTestResult>
</ProfileResult>
</ProfileResults>
</UnitTestReport>
<UnitTestReport>
<UnitTestName>SoortKind</UnitTestName>
<ProfileResults>
<ProfileResult>
<ProfileId>0</ProfileId>
<UnitTestResult>
<ExpectedValue>
<string>Pleegkind</string>
</ExpectedValue>
<SourcedValue>
<string>PleegKind</string>
</SourcedValue>
<Succeeded>true</Succeeded>
</UnitTestResult>
</ProfileResult>
</ProfileResults>
</UnitTestReport>
</Results>
</ExecuteAllUnitTestsResult>
</ExecuteAllUnitTestsResponse>
</s:Body>
</s:Envelope> |
|
ExecuteUnitTests
Returns the result of a list of specified unit tests, defined within a specific module scope.
| Expand |
|---|
|
| Parameter | Parameter description | Required/optional |
|---|
| repository | The name of the repository of which the the unit tests have to be executed | required | | branch | The name of the branch of which the the unit tests have to be executed | required | | project | The name of the project of which the the unit tests have to be executed | required | | module | The module scope of which the unit tests have to be executed. In contrast to the "ExecuteAllUnitTests" method, unlderlying modules are ignored here. | required | | unittests | A list of unit tests to be run. In case no unit tests are submitted, the result will be "succeed". | optional |
|
| Expand |
|---|
|
| Code Block |
|---|
| <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<soapenv:Header/>
<soapenv:Body>
<ns:ExecuteUnitTests>
<ns:repository>Kinderbijslag</ns:repository>
<ns:branch>Trunk</ns:branch>
<ns:project>Kinderbijslag</ns:project>
<ns:module Name="Top" ModuleType="Interaction"/>
<ns:unittests>
<ns:string>SoortKind_AangehuwdKind</ns:string>
<ns:string>SoortKind_PleegKind</ns:string>
</ns:unittests>
</ns:ExecuteUnitTests>
</soapenv:Body>
</soapenv:Envelope> |
| Code Block |
|---|
| <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ExecuteUnitTestsResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<ExecuteUnitTestsResult>
<Succeeded>false</Succeeded>
<Results>
<UnitTestReport>
<UnitTestName>SoortKind_AangehuwdKind</UnitTestName>
<ProfileResults>
<ProfileResult>
<ProfileId>0</ProfileId>
<UnitTestResult>
<ExpectedValue>
<string>AangehuwdKind</string>
</ExpectedValue>
<SourcedValue>
<string>AangehuwdKind</string>
</SourcedValue>
<Succeeded>true</Succeeded>
</UnitTestResult>
</ProfileResult>
</ProfileResults>
</UnitTestReport>
<UnitTestReport>
<UnitTestName>SoortKind_PleegKind</UnitTestName>
<ProfileResults>
<ProfileResult>
<ProfileId>0</ProfileId>
<UnitTestResult>
<ExpectedValue>
<string>Pleegkin</string>
</ExpectedValue>
<SourcedValue>
<string>PleegKind</string>
</SourcedValue>
<Succeeded>false</Succeeded>
</UnitTestResult>
</ProfileResult>
</ProfileResults>
</UnitTestReport>
</Results>
</ExecuteUnitTestsResult>
</ExecuteUnitTestsResponse>
</s:Body>
</s:Envelope> |
|
Version Management
Commit
CreateBranch
...