ExecuteAllUnitTests

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.

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  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.

Basic

NTLM

We distinguish different categories of methods:

Dependencies

GetUsedByElementsForGlobalElement

The server will return a dependency for each element that uses the specified element. It will search through all projects and modules that are in scope for the specified element in the specified branch.

Parameter	Parameter description	Required/optional
repository	the repository to search in	required
branch	the branch to search in	required
project	the project in which the element is defined	required
globalElement	the element key of the element	required

Request

<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:GetUsedByElementsForGlobalElement>
         <ns:repository>TestRepository</ns:repository>
         <ns:branch>Trunk</ns:branch>
         <ns:project>TestProject</ns:project>
         <ns:globalElement Name="color1" GlobalElementType="PresentationStyle"/>
      </ns:GetUsedByElementsForGlobalElement>
   </soapenv:Body>
</soapenv:Envelope>

Response

<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">
      <GetUsedByElementsForGlobalElementResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
         <GetUsedByElementsForGlobalElementResult>
            <Dependency>
               <ReferenceType>Usage</ReferenceType>
               <From>
                  <ModuleElement>
                     <Project Name="TestProject"/>
                     <Module Name="main" ModuleType="Interaction"/>
                     <Key Name="testpage" ModuleElementType="Page"/>
                  </ModuleElement>
               </From>
               <To>
                  <Global>
                     <Project Name="Dashboard"/>
                     <Key Name="color1" GlobalElementType="PresentationStyle"/>
                  </Global>
               </To>
            </Dependency>
            <Dependency>
               <ReferenceType>Usage</ReferenceType>
               <From>
                  <ModuleElement>
                     <Project Name="TestProject"/>
                     <Module Name="main" ModuleType="Interaction"/>
                     <Key Name="testcontainer" ModuleElementType="Container"/>
                  </ModuleElement>
               </From>
               <To>
                  <Global>
                     <Project Name="Dashboard"/>
                     <Key Name="color1" GlobalElementType="PresentationStyle"/>
                  </Global>
               </To>
            </Dependency>
         </GetUsedByElementsForGlobalElementResult>
      </GetUsedByElementsForGlobalElementResponse>
   </s:Body>
</s:Envelope>

GetUsedByElementsForModuleElement

The server will return a dependency for each element that uses the specified element. It will search through all projects and modules that are in scope for the specified element in the specified branch.

Parameter	Parameter description	Required/optional
repository	the repository to search in	required
branch	the branch to search in	required
project	the project in which the element is defined	required
module	the module in which the element is defined	required
moduleElement	the element key of the element	required

If you use inheritance between modules, and specialization of elements, elements and dependencies you are looking for may react differently than expected.

Consider the following example for a module element:
For a repository named ExampleRepository with a branch named ExampleBranch, with in the branch the following project structure:

project SpecificProject references GenericProject
- GenericProject contains module GenericModule
  - GenericModule contains entity and attribute Person.Name
- SpecificProject contains module SpecificModule, which includes GenericModule
  - SpecificModule contains container PersonView which displays Person.Name
  - SpecificModule contains page Overview which contains PersonView
project UnrelatedProject references none
- UnrelatedProject contains module UnrelatedModule
  - UnrelatedModule contains entity and attribute Person.Name
  - UnrelatedModule contains container PersonView which displays Person.Name

If we use the GetUsedByElementsForModuleElement method with parameters:
repository = ExampleRepository
branch = ExampleBranch
project = GenericProject
module = GenericModule
element key = Attribute, Person.Name

It will return a dependency for

PersonView in SpecificModule because
- SpecificModule includes GenericModule
- PersonView has a direct reference to Person.Name

But not for

Overview in SpecificModule because
- Overview does not directly reference Person.Name
PersonView in UnrelatedModule because
- there is no include between UnrelatedModule and GenericModule

The returned dependency will contain:

ReferenceType: Usage
From: ElementKeyReference
- property ModuleElement will be a reference to PersonView in SpecificModule
- all other properties will be null
To: ElementKeyReference
- property ModuleElement will be reference Person.Name in GenericModule
- all other properties will be null

Note that if Person.Name is also specialized in SpecificModule, then the dependency from PersonView in SpecificModule will refer to Person.Name in SpecificModule instead. This means the search with the given parameters will give no results: the search should also be executed for Person.Name in SpecificModule.

Request

<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">
      <GetUsedByElementsForModuleElement xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
         <repository>TestRepository</repository>
         <branch>Trunk</branch>
         <project>TestProject</project>
         <module Name="main" ModuleType="Interaction"/>
         <moduleElement xsi:type="AttributeKey" Name="test" ModuleElementType="Attribute">
             <Entity xmlns="">test</Entity>
         </moduleElement>
      </GetUsedByElementsForModuleElement>
   </s:Body>
</s:Envelope>

Response

<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">
      <GetUsedByElementsForModuleElementResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
         <GetUsedByElementsForModuleElementResult>
            <Dependency>
               <ReferenceType>Usage</ReferenceType>
               <From>
                  <ModuleElement>
                     <Project Name="TestProject"/>
                     <Module Name="main" ModuleType="Interaction"/>
                     <Key Name="testpage" ModuleElementType="Page"/>
                  </ModuleElement>
               </From>
               <To>
                  <ModuleElement>
                     <Project Name="TestProject"/>
                     <Module Name="main" ModuleType="Interaction"/>
                     <Key xsi:type="AttributeKey" Name="test" ModuleElementType="Attribute">
                        <Entity xmlns="">test</Entity>
                     </Key>
                  </ModuleElement>
               </To>
            </Dependency>
            <Dependency>
               <ReferenceType>Usage</ReferenceType>
               <From>
                  <ModuleElement>
                     <Project Name="TestProject"/>
                     <Module Name="main" ModuleType="Interaction"/>
                     <Key Name="testcontainer" ModuleElementType="Container"/>
                  </ModuleElement>
               </From>
               <To>
                  <ModuleElement>
                     <Project Name="TestProject"/>
                     <Module Name="main" ModuleType="Interaction"/>
                     <Key xsi:type="AttributeKey" Name="test" ModuleElementType="Attribute">
                        <Entity xmlns="">test</Entity>
                     </Key>
                  </ModuleElement>
               </To>
            </Dependency>
         </GetUsedByElementsForModuleElementResult>
      </GetUsedByElementsForModuleElementResponse>
   </s:Body>
</s:Envelope>

GetUseElementsForGlobalElement

The server will return a dependency for each element that is used by the specified element.

Parameter	Parameter description	Required/optional
repository	the repository to search in	required
branch	the branch to search in	required
project	the project in which the element is defined	required
globalElement	the name and the global element type of the global element	required

Request

<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:GetUseElementsForGlobalElement>
         <ns:repository>DCM</ns:repository>
         <ns:branch>Trunk</ns:branch>
         <ns:project>Main_Dashboard</ns:project>
         <ns:globalElement Name="MyContentStyle" GlobalElementType="ContentStyle"/>
      </ns:GetUseElementsForGlobalElement>
   </soapenv:Body>
</soapenv:Envelope>

Response

<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">
      <GetUseElementsForGlobalElementResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
         <GetUseElementsForGlobalElementResult>
            <Dependency>
               <ReferenceType>Usage</ReferenceType>
               <From>
                  <Global>
                     <Project Name="Main_Dashboard"/>
                     <Key Name="MyContentStyle" GlobalElementType="ContentStyle"/>
                  </Global>
               </From>
               <To>
                  <Global>
                     <Project Name="AquimaTheme"/>
                     <Key Name="Anchor" GlobalElementType="ContentStyle"/>
                  </Global>
               </To>
            </Dependency>
         </GetUseElementsForGlobalElementResult>
      </GetUseElementsForGlobalElementResponse>
   </s:Body>
</s:Envelope>

GetUseElementsForModuleElement

The server will return a dependency for each element that is used by the specified element.

Parameter	Parameter description	Required/optional
repository	the repository to search in	required
branch	the branch to search in	required
project	the project in which the element is defined	required
module	the module name and module type in which the element is defined	required
moduleElement	the name and the module element type of the module element	required

Request

<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:GetUseElementsForModuleElement>
         <ns:repository>DCM</ns:repository>
         <ns:branch>Trunk</ns:branch>
         <ns:project>Main_Dashboard</ns:project>
         <ns:module Name="Dashboard" ModuleType="Interaction"/>
         <ns:moduleElement Name="MyExampleContainer" ModuleElementType="Container"/>
      </ns:GetUseElementsForModuleElement>
   </soapenv:Body>
</soapenv:Envelope>

Response

<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">
      <GetUseElementsForModuleElementResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
         <GetUseElementsForModuleElementResult>
            <Dependency>
               <ReferenceType>Usage</ReferenceType>
               <From>
                  <ModuleElement>
                     <Project Name="Main_Dashboard"/>
                     <Module Name="Dashboard" ModuleType="Interaction"/>
                     <Key Name="MyExampleContainer" ModuleElementType="Container"/>
                  </ModuleElement>
               </From>
               <To>
                  <ModuleElement>
                     <Project Name="Basis_Functionaliteit"/>
                     <Module Name="Basis_Functionaliteit" ModuleType="Interaction"/>
                     <Key Name="Document" ModuleElementType="Entity"/>
                  </ModuleElement>
               </To>
            </Dependency>
            <Dependency>
               <ReferenceType>Usage</ReferenceType>
               <From>
                  <ModuleElement>
                     <Project Name="Main_Dashboard"/>
                     <Module Name="Dashboard" ModuleType="Interaction"/>
                     <Key Name="MyExampleContainer" ModuleElementType="Container"/>
                  </ModuleElement>
               </From>
               <To>
                  <ModuleElement>
                     <Project Name="Basis_Functionaliteit"/>
                     <Module Name="Basis_Functionaliteit" ModuleType="Interaction"/>
                     <Key xsi:type="AttributeKey" Name="Id" ModuleElementType="Attribute">
                        <Entity xmlns="">Document</Entity>
                     </Key>
                  </ModuleElement>
               </To>
            </Dependency>
         </GetUseElementsForModuleElementResult>
      </GetUseElementsForModuleElementResponse>
   </s:Body>
</s:Envelope>

Exports

ExportBranch

ExportLibrary

ExportPackage

ExportProject

Exports the working revision of a project. The server will return the bytes of a ZIP file containing the project export.

Parameter	Parameter description	Required/optional
repository	the repository in which the project to be exported is located	required
branch	the branch in which the project to be exported is located	required
project	the project to be exported	required
encrypt	a boolean flag indicating whether the export should be encrypted	required

Request

<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:ExportProject>
         <ns:repository>TestRepository</ns:repository>
         <ns:branch>Trunk</ns:branch>
         <ns:project>TestProject</ns:project>
         <ns:encrypt>false</ns:encrypt>
      </ns:ExportProject>
   </soapenv:Body>
</soapenv:Envelope>

Response

<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">
      <ExportProjectResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
         <ExportProjectResult ContentType="application/zip">
            <Content>UEsDBBQACAA ... CxJwAAAAA=</Content>
         </ExportProjectResult>
      </ExportProjectResponse>
   </s:Body>
</s:Envelope>

ExportProjectRevision

Exports a project at a specific revision. The server will return the bytes of a ZIP file containing the project export.

Parameter	Parameter description	Required/optional
repository	the repository in which the project to be exported is located	required
branch	the branch in which the project to be exported is located	required
revisionId	the revision to be exported, required	required
project	the project to be exported	required
encrypt	a boolean flag indicating whether the export should be encrypted	required

Request

<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:ExportProjectRevision>
         <ns:repository>TestRepository</ns:repository>
         <ns:branch>Trunk</ns:branch>
         <ns:revisionId>b1372603-4705-4728-8ef4-198477f97e6e</ns:revisionId>
         <ns:project>TestProject</ns:project>
         <ns:encrypt>false</ns:encrypt>
      </ns:ExportProjectRevision>
   </soapenv:Body>
</soapenv:Envelope>

Response

<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">
      <ExportProjectRevisionResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
         <ExportProjectRevisionResult ContentType="application/zip">
            <Content>UEsDBBQ ... CeIQAAAAA=</Content>
         </ExportProjectRevisionResult>
      </ExportProjectRevisionResponse>
   </s:Body>
</s:Envelope>

ExportProjectWithMetadata

Elements

FindGlobalElementProject

FindGlobalElements

FindModuleProject

GetAllGlobalElements

GetAllModuleElements

GetGlobalElement

GetGlobalElements

GetModuleElement

The server will return a description of the element with all the settings which can be configured in studio.

For certain elements a special type is required to uniquely identify an element in studio. An example are attributes, as an attribute with the same name can be defined multiple times for different entities. To find all of these special cases, search the wsdl for elements which have base="tns:ModuleElementKey". If you expand the example below we show how to work with attributes.

Parameter	Parameter description	Required/optional
repository	the repository to search in	required
branch	the branch to search in	required
project	the revision to be exported	required
module	the project in which the element is defined	required
moduleElement	The Name and Type of the module element which should be returned	required

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:GetModuleElement>
         <ns:repository>TestRepository</ns:repository>
         <ns:branch>Trunk</ns:branch>
         <ns:project>TestProject</ns:project>
         <ns:module Name="Main" ModuleType="Interaction"/>
         <ns:moduleElement xsi:type="ns:AttributeKey" Name="DateOfBirth" ModuleElementType="Attribute">
                <Entity>Person</Entity>
         </ns:moduleElement>
      </ns:GetModuleElement>
   </soapenv:Body>
</soapenv:Envelope>

Response

<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">
      <GetModuleElementResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
         <GetModuleElementResult xsi:type="Attribute" Name="DateOfBirth" Entity="Person" DataType="Date" MultiValued="false" Askable="true" ActsAsReference="false">
            <Comments xmlns=""/>
            <Tags xmlns="">
               <Tag>
                  <Name>Person</Name>
               </Tag>
            </Tags>
            <QuestionText xmlns="">
               <Text Language="dutch">
                  <Value>Date of Birth</Value>
               </Text>
            </QuestionText>
            <ExplainText xmlns=""/>
            <ValidationRules xmlns=""/>
         </GetModuleElementResult>
      </GetModuleElementResponse>
   </s:Body>
</s:Envelope>

GetModuleElements

The server will return a list of module elements which matches the specified type within the chosen project.

Parameter	Parameter description	Required/optional
repository	the repository to search in	required
branch	the branch to search in	required
project	the project in which the element is defined	required
module	the module in which the element is defined	required
elementType	the type of element that you want to be returned	required

Request

<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:GetModuleElements>
         <ns:repository>TestRepository</ns:repository>
         <ns:branch>Trunk</ns:branch>
         <ns:project>TestProject</ns:project>
         <ns:module Name="main" ModuleType="Interaction"/>
         <ns:elementType>Attribute</ns:elementType>
      </ns:GetModuleElements>
   </soapenv:Body>
</soapenv:Envelope>

Response

<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">
      <GetModuleElementsResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
         <GetModuleElementsResult>
            <ModuleElementKey xsi:type="AttributeKey" Name="DateOfBirth" ModuleElementType="Attribute">
               <Entity xmlns="">Person</Entity>
            </ModuleElementKey>
            <ModuleElementKey xsi:type="AttributeKey" Name="Name" ModuleElementType="Attribute">
               <Entity xmlns="">Person</Entity>
            </ModuleElementKey>
         </GetModuleElementsResult>
      </GetModuleElementsResponse>
   </s:Body>
</s:Envelope>

GetMostSpecificModuleElement

Search

This method searches for an element in a given branch, project or module. It is equivalent to the search functionality present in studio.

Parameter	Parameter description	Possible Values	Required / Optional
SearchType	In what scope you would like to search	Branch, ProjectStructure, SingleProject, ModuleScope	required
Repository	the repository in which the search is performed		required
Branch	the branch in which the search is performed		required
Project	the projectin which the search is performed		optional
Module	the module in which the search is performed		optional
SearchString	the string to be searched for		required
SearchInNames	a boolean indicating whether to search in names of elements	true, false	required
SearchInDependencies	a boolean indicating whether to search in the dependencies of an element	true, false	required
IncludeGlobalElements	a boolean indicating whether to search in global elements	true, false	required
IncludeModuleElements	a boolean indicating whether to search in module elements	true, false	required
FullText	a boolean indicating if a full text search should be performed	true, false	required
CaseSensitive	a boolean indicating that the search should be performed in a case-sensitive manner	true, false	required

To make this method useful, the caller should make sure that:

at least one of IncludeGlobalElements or IncludeModuleElements should be true
at least one of SearchInNames, SearchInDependencies or FullText should be true

Request

<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:Search>
         <ns:parameters>
            <ns:SearchType>ModuleScope</ns:SearchType>
            <ns:Repository>HospitalDCM</ns:Repository>
            <ns:Branch>Trunk</ns:Branch>
            <ns:Project>HospitalDCM</ns:Project>
            <ns:Module Name="Dashboard" ModuleType="Interaction"/>
            <ns:SearchString>Menu</ns:SearchString>
            <ns:SearchInNames>1</ns:SearchInNames>
            <ns:SearchInDependencies>0</ns:SearchInDependencies>
            <ns:IncludeGlobalElements>0</ns:IncludeGlobalElements>
            <ns:IncludeModuleElements>1</ns:IncludeModuleElements>
            <ns:FullText>0</ns:FullText>
            <ns:CaseSensitive>0</ns:CaseSensitive>
         </ns:parameters>
      </ns:Search>
   </soapenv:Body>
</soapenv:Envelope>

Response

<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">
      <SearchResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
         <SearchResult>
            <SearchResultItem xsi:type="ElementSearchResultItem">
               <Element>
                  <ModuleElement>
                     <Project Name="HospitalDCM"/>
                     <Module Name="Dashboard" ModuleType="Interaction"/>
                     <Key Name="MenuBar" ModuleElementType="Container"/>
                  </ModuleElement>
               </Element>
            </SearchResultItem>
            <SearchResultItem xsi:type="ElementSearchResultItem">
               <Element>
                  <ModuleElement>
                     <Project Name="HospitalDCM"/>
                     <Module Name="Dashboard" ModuleType="Interaction"/>
                     <Key Name="Dashboard_Menu" ModuleElementType="Container"/>
                  </ModuleElement>
               </Element>
            </SearchResultItem>
            <SearchResultItem xsi:type="ElementSearchResultItem">
               <Element>
                  <ModuleElement>
                     <Project Name="HospitalDCM"/>
                     <Module Name="Dashboard" ModuleType="Interaction"/>
                     <Key Name="DashboardMenu" ModuleElementType="FlowEvent"/>
                  </ModuleElement>
               </Element>
            </SearchResultItem>
         </SearchResult>
      </SearchResponse>
   </s:Body>
</s:Envelope>

Imports

ImportBranch

The user can check a box to delete existing elements in the current branch that are not included in the imported branch. By checking this box, the imported branch will be identical to the exported branch.

ImportLibrary

ImportSpecification

Project Structure

GetModule

GetModules

GetPackage

GetPackages

GetProject

GetProjects

ReadLibraryMetadata

UnitTests

ExecuteAllUnitTests

Returns the result of all unit tests that are defined within a specific module scope.

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

Request

<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>

Response

<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>

ExecuteAllUnitTestsForRevision

Similar to ExecuteAllUnitTests above, but with the branch parameter replaced by a revisionId parameter to execute the tests of a particular revision. This operation is available since Blueriq 15.2.0.

ExecuteUnitTests

Returns the result of a list of specified unit tests, defined within a specific module scope.

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

Request

<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>

Response

<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>

ExecuteUnitTestsForRevision

Similar to ExecuteUnitTests above, but with the branch parameter replaced by a revisionId parameter to execute the tests of a particular revision. This operation is available since Blueriq 15.2.0.

Version Management

Commit

CreateBranch

CreateBranchType

CreateFeatureBranch

CreateFeatureBranchOnRevision

CreateRepository

DeleteRepository

DeleteBranch

DeleteBranchType

GetRepository

GetRepositories

GetBranch

GetBranches

GetBranchType

GetBranchTypes

GetProjectsForRevision

GetRevision

GetRevisionChanges

Returns the changes in a specific revision.

Parameter	Parameter description	Required/optional
repository	the repository to search in	required
branch	the branch to search in	required
revision	the revision whose changes are to be retrieved	required

Request

<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:GetRevisionChanges>
         <!--Optional:-->
         <ns:repository>TestRepository</ns:repository>
         <!--Optional:-->
         <ns:branch>Trunk</ns:branch>
         <!--Optional:-->
         <ns:revision>eadcb8e1-c306-4ea0-a983-162afa863473</ns:revision>
      </ns:GetRevisionChanges>
   </soapenv:Body>
</soapenv:Envelope>

Response

<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">
      <GetRevisionChangesResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
         <GetRevisionChangesResult>
            <ElementChange>
               <Type>Create</Type>
               <CurrentKey>
                  <ModuleElement>
                     <Project Name="TestProject"/>
                     <Module Name="TestModule" ModuleType="Interaction"/>
                     <Key Name="Address" ModuleElementType="Entity"/>
                  </ModuleElement>
               </CurrentKey>
               <Authors>admin</Authors> <!-- Since Blueriq 15.13 -->
               <Authors>ci</Authors> <!-- Since Blueriq 15.13 --> 
            </ElementChange>
            <ElementChange>
               <Type>Create</Type>
               <CurrentKey>
                  <ModuleElement>
                     <Project Name="TestProject"/>
                     <Module Name="TestModule" ModuleType="Interaction"/>
                     <Key xsi:type="AttributeKey" Name="Street" ModuleElementType="Attribute">
                        <Entity xmlns="">Address</Entity>
                     </Key>
                  </ModuleElement>
               </CurrentKey>
               <Authors>admin</Authors> <!-- Since Blueriq 15.13 --> 
            </ElementChange>
            <ElementChange>
               <Type>Create</Type>
               <CurrentKey>
                  <ModuleElement>
                     <Project Name="TestProject"/>
                     <Module Name="TestModule" ModuleType="Interaction"/>
                     <Key xsi:type="RelationKey" Name="hasAddress" ModuleElementType="Relation">
                        <Entity xmlns="">Person</Entity>
                     </Key>
                  </ModuleElement>
               </CurrentKey>
               <Authors>admin</Authors> <!-- Since Blueriq 15.13 --> 
            </ElementChange>
         </GetRevisionChangesResult>
      </GetRevisionChangesResponse>
   </s:Body>
</s:Envelope>

GetRevisionDescriptor

GetRevisions

Returns a list of revisions in a specified repository and branch.

Parameter	Parameter description	Required/optional
repository	the repository to search in	required
branch	the branch to search in	required
startIndex	the index of the first included revision	required
amount	the number of revisions to include; a negative amount includes all revisions	required
taggedOnly	boolean flag indicating whether to include only tagged revisions	required
includeMergeRevisions	boolean flag indicating whether to include merge revisions	required

Request

<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:GetRevisions>
         <ns:repository>TestRepository</ns:repository>
         <ns:branch>Trunk</ns:branch>
         <ns:startIndex>0</ns:startIndex>
         <ns:amount>-1</ns:amount>
         <ns:taggedOnly>false</ns:taggedOnly>
         <ns:includeMergeRevisions>true</ns:includeMergeRevisions>
      </ns:GetRevisions>
   </soapenv:Body>
</soapenv:Envelope>

Response

<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">
      <GetRevisionsResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
         <GetRevisionsResult>
            <Revision>
               <CommitTime>2015-02-21T22:07:36.857</CommitTime>
               <RevisionId>147513d0-558e-4562-8281-595a6471d1aa</RevisionId>
               <Message>created new entity</Message>
               <Committer>admin</Committer>
               <Branch>Trunk</Branch>
               <ParentRevisionIds>b1372603-4705-4728-8ef4-198477f97e6e</ParentRevisionIds>
               <Tags>tag1</Tags>
            </Revision>
            <Revision>
               <CommitTime>2015-02-17T15:05:14.213</CommitTime>
               <RevisionId>b1372603-4705-4728-8ef4-198477f97e6e</RevisionId>
               <Message>initial commit in Trunk</Message>
               <Committer>admin</Committer>
               <Branch>Trunk</Branch>
               <ParentRevisionIds>7371efb5-be0d-43fb-ba54-287836daedd6</ParentRevisionIds>
            </Revision>
            <Revision>
               <CommitTime>2015-02-13T13:14:39.353</CommitTime>
               <RevisionId>7371efb5-be0d-43fb-ba54-287836daedd6</RevisionId>
               <Message>Branch created</Message>
               <Committer>admin</Committer>
               <Branch>Trunk</Branch>
            </Revision>
         </GetRevisionsResult>
      </GetRevisionsResponse>
   </s:Body>
</s:Envelope>

GetRevisionsWithLeveledMergedRevisions

Returns a list of revisions in a specified repository and branch, with the option to request a certain level of merged revisions

Usage recommendation : this method can be used as a better performing variant of the GetRevisions operation (with the includeMergeRevisions flag set to true).

Parameter	Parameter description	Required/optional
repository	the repository to search in	required
branch	the branch to search in	required
startIndex	the index of the first included revision	required
amount	the number of revisions to include; a negative amount includes all revisions	required
taggedOnly	boolean flag indicating whether to include only tagged revisions	required
level	the level of merge revision to include; a negative amount includes all levels of merged revisions	required

Request

<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:GetRevisionsWithLeveledMergeRevisions>
         <ns:repository>TestRepository</ns:repository>
         <ns:branch>Trunk</ns:branch>
         <ns:startIndex>0</ns:startIndex>
         <ns:amount>10</ns:amount>
         <ns:taggedOnly>false</ns:taggedOnly>
         <ns:level>1</ns:level>
      </ns:GetRevisionsWithLeveledMergeRevisions>
   </soapenv:Body>
</soapenv:Envelope>

Response

<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">
      <GetRevisionsWithLeveledMergeRevisionsResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
         <GetRevisionsWithLeveledMergeRevisionsResult>
            <Revision>
               <CommitTime>2016-11-29T13:30:18.277</CommitTime>
               <RevisionId>99a878f4-5338-4910-974c-b5749303f7fe</RevisionId>
               <Message>update from A B C</Message>
               <Committer>admin</Committer>
               <Branch>Trunk</Branch>
               <ParentRevisionIds>64bac7d9-7140-4669-b3de-a8f0c98db5cf</ParentRevisionIds>
               <ParentRevisionIds>6fd443ee-9a20-431f-8d91-b7b1a85bc217</ParentRevisionIds>
               <MergeRevisions>
                  <CommitTime>2016-11-29T13:28:42.4</CommitTime>
                  <RevisionId>6fd443ee-9a20-431f-8d91-b7b1a85bc217</RevisionId>
                  <Message>update from Team b &amp; C</Message>
                  <Committer>admin</Committer>
                  <Branch>TeamA</Branch>
                  <ParentRevisionIds>300c5d5c-08a5-4184-8c47-db7eb2aa1466</ParentRevisionIds>
               </MergeRevisions>
               <MergeRevisions>
                  <CommitTime>2016-11-28T17:39:01.007</CommitTime>
                  <RevisionId>300c5d5c-08a5-4184-8c47-db7eb2aa1466</RevisionId>
                  <Message>update from Trunk</Message>
                  <Committer>admin</Committer>
                  <Branch>TeamA</Branch>
                  <ParentRevisionIds>c00795a2-2c4d-4d12-be7d-35e3ea8d636d</ParentRevisionIds>
               </MergeRevisions>
            </Revision>
            <Revision>
               <CommitTime>2016-11-28T17:38:00.823</CommitTime>
               <RevisionId>64bac7d9-7140-4669-b3de-a8f0c98db5cf</RevisionId>
               <Message>create entity C on Trunk</Message>
               <Committer>admin</Committer>
               <Branch>Trunk</Branch>
               <ParentRevisionIds>6f8c6390-dcb2-402d-b6bb-dc33bcdfce42</ParentRevisionIds>
            </Revision>
            <Revision>
               <CommitTime>2016-11-28T17:37:39.927</CommitTime>
               <RevisionId>6f8c6390-dcb2-402d-b6bb-dc33bcdfce42</RevisionId>
               <Message>merge with teamA</Message>
               <Committer>admin</Committer>
               <Branch>Trunk</Branch>
               <ParentRevisionIds>311d5dd3-8931-4e5c-99e5-0b3f22c47571</ParentRevisionIds>
               <ParentRevisionIds>c00795a2-2c4d-4d12-be7d-35e3ea8d636d</ParentRevisionIds>
               <MergeRevisions>
                  <CommitTime>2016-11-28T17:36:44.877</CommitTime>
                  <RevisionId>c00795a2-2c4d-4d12-be7d-35e3ea8d636d</RevisionId>
                  <Message>commit on TeamA branch</Message>
                  <Committer>admin</Committer>
                  <Branch>TeamA</Branch>
                  <ParentRevisionIds>311d5dd3-8931-4e5c-99e5-0b3f22c47571</ParentRevisionIds>
               </MergeRevisions>
            </Revision>
            <Revision>
               <CommitTime>2016-11-28T17:09:25.783</CommitTime>
               <RevisionId>311d5dd3-8931-4e5c-99e5-0b3f22c47571</RevisionId>
               <Message>initial commit on Trunk</Message>
               <Committer>admin</Committer>
               <Branch>Trunk</Branch>
               <ParentRevisionIds>f9db26db-ca13-4154-a8dc-2c05fa81eda1</ParentRevisionIds>
            </Revision>
            <Revision>
               <CommitTime>2016-11-28T17:08:58.74</CommitTime>
               <RevisionId>f9db26db-ca13-4154-a8dc-2c05fa81eda1</RevisionId>
               <Message>Created repository</Message>
               <Committer>admin</Committer>
               <Branch>Trunk</Branch>
            </Revision>
         </GetRevisionsWithLeveledMergeRevisionsResult>
      </GetRevisionsWithLeveledMergeRevisionsResponse>
   </s:Body>
</s:Envelope>

MergeBranch

MergeRevision

SetTags

UpdateRepository

UpdateBranch

UpdateBranchType

Other Methods

ApplyOperations

This operation allows for applying changes to the model in a particular branch. The list of operations is applied in the order in which they are provided (meaning that a creation operation of e.g. a module must precede the creation of module elements within it) and there can only be a single operation per element, otherwise this request will fail.

This request is executed atomically; either all operations succeed or the whole request is rejected.

Parameter	Parameter description	Required/optional
repository	the repository to search in	required
branch	the branch to search in	required
operations	the list of operations to apply.	required

The list of operations must contain OperationEntry elements with exactly one child element according to the type of element (ProjectOperation, PackageOperation, GlobalOperation, ModuleOperation, or ModuleElementOperation) that is being changed in that OperationEntry .

A ModuleElementOperation can either be a Create , Update , or Delete operation. In the case of Update , you need to be aware that the element is updated with the exact request data; optional elements that are omitted will be cleared instead of using their prior value as fallback. If the name of the OriginalKey and the name determined by the ModuleElement element differ then the element will be renamed, with "Update References" behavior enabled (this cannot be disabled).

The OriginalKey may take a specialized type depending on the type of element. In particular, all elements with a compound key require a dedicated type: attributes (AttributeKey), relations (RelationKey) and static instances (StaticInstanceKey). These types of key need an explicit xsi:type specification, where xsi is the XML Schema Instance namespace that needs to be declared in the SOAP envelope element (please refer to the example below).

Similarly, the ModuleElement element always needs an explicit xsi:type specification, as the ModuleElement element is of the abstract ModuleElement complex type. Hence, a concrete subtype needs to be given using xsi:type . Please be aware that the specified type name must include the namespace alias of the management service, which is ns in the example below (per the xmlns:ns declaration on the SOAP envelope element).

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
   xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:ApplyOperations>
         <ns:repository>TestRepository</ns:repository>
         <ns:branch>Trunk</ns:branch>
         <ns:operations>
            <ns:Operations>
               <ns:OperationEntry>
                  <ns:ModuleElementOperation Type="Create" GenerateLayout="false">
                     <ns:Project>ExampleProject</ns:Project>
                     <ns:Module Name="MainModule" ModuleType="Interaction"/>
                     <ns:OriginalKey xsi:type="ns:AttributeKey" Entity="MyEntity" Name="MyAttribute" ModuleElementType="Attribute"/>
                     <ns:ModuleElement xsi:type="ns:Attribute"
                        Entity="MyEntity" Name="MyAttribute"
                        DataType="String" MultiValued="false" Askable="false"
                        ActsAsReference="false"></ns:ModuleElement>
                  </ns:ModuleElementOperation>
               </ns:OperationEntry>
            </ns:Operations>
         </ns:operations>
      </ns:ApplyOperations>
   </soapenv:Body>
</soapenv:Envelope>

Response

<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">
      <ApplyOperationsResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0"/>
   </s:Body>
</s:Envelope>

EvaluateExpression

GetCurrentIdentity

GetDataSource

GetLicenseData

GetStatus

Returns the status of the branch.

Parameter	Parameter description	Required/optional
repository	the repository to search in	required
branch	the branch to search in	required

Request

<x:Envelope xmlns:x="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
    <x:Header/>
    <x:Body>
        <ns:GetStatus>
            <ns:repository>FunStuff</ns:repository>
            <ns:branch>branch9</ns:branch>
        </ns:GetStatus>
    </x:Body>
</x:Envelope>

Response

<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">
        <GetStatusResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
            <GetStatusResult>
                <TipRevision>2538eada-bb93-46a7-948c-c9e9f7f68cc1</TipRevision>
                <Commitable>true</Commitable>
                <Changes>
                    <Type>Create</Type>
                    <CurrentKey>
                        <Project>
                            <Key>branch4project</Key>
                        </Project>
                    </CurrentKey>
                    <Authors>admin</Authors> <!-- Since Blueriq 15.13 -->
                    <Authors>ci</Authors> <!-- Since Blueriq 15.13 -->
                </Changes>
                <Changes>
                    <Type>Create</Type>
                    <CurrentKey>
                        <Project>
                            <Key>brnach3project</Key>
                        </Project>
                    </CurrentKey>
                    <Authors>admin</Authors> <!-- Since Blueriq 15.13 -->
                </Changes>
                <Changes>
                    <Type>Create</Type>
                    <CurrentKey>
                        <Project>
                            <Key>branch2Project</Key>
                        </Project>
                    </CurrentKey>
                    <Authors>admin</Authors> <!-- Since Blueriq 15.13 -->
                </Changes>
                <MergeRevisions>
                    <CommitTime>2017-03-15T13:56:23.793</CommitTime>
                    <RevisionId>9796f7eb-060e-42dd-bef2-927078e94609</RevisionId>
                    <Message>aaa</Message>
                    <Committer>admin</Committer>
                    <Parent>55a73f9d-3b31-4852-bcc0-08558bb1ed62</Parent>
                    <MergeParent>014c231e-9381-47f5-96b8-8a2692ad9b54</MergeParent>
                </MergeRevisions>
                <MergeRevisions>
                    <CommitTime>2017-03-15T13:55:53.077</CommitTime>
                    <RevisionId>55a73f9d-3b31-4852-bcc0-08558bb1ed62</RevisionId>
                    <Message>a44</Message>
                    <Committer>admin</Committer>
                    <Parent>ac9ce6f0-d814-4a69-b0cc-5205509d4a65</Parent>
                </MergeRevisions>              
            </GetStatusResult>
        </GetStatusResponse>
    </s:Body>
</s:Envelope>

GetStatusMaxDepth

Identical in behavior to GetStatus. The maxMergedRevisionsDepth is no longer relevant since Blueriq 13.0.

HasModuleWriteAccess

IsInRole

Logout

RetrieveLog

RetrieveServerInformation

RetrieveSubscriptionStatus

SendMessage

SetDataSource

ValidateProject

Advanced Search Methods

These methods provide a way to start an async search for elements in Studio.

Search results are temporarily stored in an expiring cache. The timeout for the cache can be configured from app.config file :

app.config

<!--Advanced Search Configuration-->
<advancedsearch timeout-in-minutes="30"/>

If no interaction occurs with a started search entry (e.g. results are not pulled via the GetAdvancedSearchResults method) for the configured timeout, the search is stopped and results are removed.

StartAdvancedSearch

This method starts a new search according to the input parameters and returns a GUID that can be further used to get the results or stop the search.

The server returns a SearchID: GUID associated with the newly started search .

Parameter	Parameter description	Required/optional
ElementName	name of the element to be searched	required
ElementTypes	array of element types that can be searched. Currently, the following global or module element types are supported : Container, Attribute, Presentation Style, Content Style, Text Item, Service Call, Flow	optional
IsInExposedFlow	boolean indicating whether the search should return information about elements in exposed flows true: the advanced search will check if the searched element is reachable through an exposed flow and will return the information accordingly in the `<IsInExposedFlow>` element from the response. false: the advanced search will not check if the searched element is reachable through an exposed flow and will return a null value in the `<IsInExposedFlow>` element from the response.	optional
IsSpecialized	boolean indicating whether the search should return information about specialized elements true : the advanced search will check if the search element is specialized and return the information accordingly in the `<IsSpecialized>` element from the response. false: the advanced search will not check if the search element is specialized and will return a null value in the `<IsSpecialized>` element from the response.	required
FullText	boolean indicating whether full-text search is enabled	optional
SearchDepth	parameter of type int, indicating the level of dependencies on which to search	optional, default value = 5
SearchIn	Array of objects composed of the name of the repository, branch and project which specifies the search location Valid combinations are : repository + branch + project , repository + branch , repository Invalid combinations are ignored (search is done in all repositories, branches, projects)	optional

For more details about how the input parameters influence the search result, see the Reponse Example of the GetAdvancedSearchResults method.

Request

<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:StartAdvancedSearch>
         <ns:parameters>
            <ns:ElementName>Age</ns:ElementName>
            <ns:ElementTypes>Attribute</ns:ElementTypes>
            <ns:IsInExposedFlow>true</ns:IsInExposedFlow>
            <ns:IsSpecialized>false</ns:IsSpecialized>
            <ns:IsFullTextEnabled>false</ns:IsFullTextEnabled>
            <ns:SearchDepth>5</ns:SearchDepth>
            <ns:SearchIn>
               <ns:Repository>CoffeeAdvisor</ns:Repository>
               <ns:Branch>Trunk</ns:Branch>
               <ns:Project>CoffeeAdvisor</ns:Project>
            </ns:SearchIn>
         </ns:parameters>
      </ns:StartAdvancedSearch>
   </soapenv:Body>
</soapenv:Envelope>

Response

<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">
      <StartAdvancedSearchResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
         <StartAdvancedSearchResult>
            <SearchId>72852a96-3bea-4786-a2d5-17d98bd8d430</SearchId>
         </StartAdvancedSearchResult>
      </StartAdvancedSearchResponse>
   </s:Body>
</s:Envelope>

StopAdvancedSearch

This method stops the search for the specified Search Id, and also clears the results that are stored in the search cache in Studio. If the provided search id does not exist anymore, an error will be returned.

Parameter	Parameter description	Required/optional
SearchId	the GUID obtained after calling the StartAdvancedSearch method	required

Request

<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:StopAdvancedSearch>
         <!--Optional:-->
         <ns:searchId>
            <!--Optional:-->
            <ns:SearchId>304254f5-76fc-4bf5-b806-6bce78533a64</ns:SearchId>
         </ns:searchId>
      </ns:StopAdvancedSearch>
   </soapenv:Body>
</soapenv:Envelope>

Response

<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">
      <StopAdvancedSearchResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0"/>
   </s:Body>
</s:Envelope>

GetAdvancedSearchResults

This method returns the results associated with the input search id. The results could be partial or complete. The state of the search is indicated by the "IsSearchFinished" parameter.

Parameter	Parameter description	Required/optional
SearchId	the GUID obtained after calling the StartAdvancedSearch method	required

Request

<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:GetAdvancedSearchResults>
         <!--Optional:-->
         <ns:searchId>
            <!--Optional:-->
            <ns:SearchId>304254f5-76fc-4bf5-b806-6bce78533a64</ns:SearchId>
         </ns:searchId>
      </ns:GetAdvancedSearchResults>
   </soapenv:Body>
</soapenv:Envelope>

Response

<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">
      <GetAdvancedSearchResultsResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
         <GetAdvancedSearchResultsResult>
            <ResultEntries>
               <ResultEntry>
                  <Repository>CoffeeAdvisor</Repository>
                  <Branch>Trunk</Branch>
                  <Project>CoffeeAdvisor</Project>
                  <Elements>
                     <ElementDetails>
                        <ElementName>Age</ElementName>
                        <ElementType>Attribute</ElementType>
                        <Module>CoffeeAdvisor</Module>
                        <IsInExposedFlow>true</IsInExposedFlow>
                        <IsSpecialized>null</IsSpecialized>
                     </ElementDetails>
                  </Elements>
               </ResultEntry>
            </ResultEntries>
            <IsSearchFinished>true</IsSearchFinished>
         </GetAdvancedSearchResultsResult>
      </GetAdvancedSearchResultsResponse>
   </s:Body>
</s:Envelope>

GetLibraries

This method returns libraries that are present in a branch.

Parameter	Parameter description	Required/optional
repository	string parameter representing the name of the repository where the search is made	required
branch	string parameter representing the name of the branch where the search is made	required

Request

<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:GetLibraries>
         <!--Optional:-->
         <ns:repository>Repository2</ns:repository>
         <!--Optional:-->
         <ns:branch>Trunk</ns:branch>
      </ns:GetLibraries>
   </soapenv:Body>
</soapenv:Envelope>

Response

<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">
      <GetLibrariesResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
         <GetLibrariesResult>
            <LibrarySearchResult>
               <Name>Aggregate</Name>
               <IsExternal>true</IsExternal>
            </LibrarySearchResult>
            <LibrarySearchResult>
               <Name>AquimaLibrary</Name>
               <IsExternal>true</IsExternal>
            </LibrarySearchResult>
            <LibrarySearchResult>
               <Name>AquimaPresentationStyles</Name>
               <IsExternal>true</IsExternal>
            </LibrarySearchResult>
            <LibrarySearchResult>
               <Name>Dashboard</Name>
               <IsExternal>true</IsExternal>
            </LibrarySearchResult>
            <LibrarySearchResult>
               <Name>Internal</Name>
               <IsExternal>false</IsExternal>
            </LibrarySearchResult>
         </GetLibrariesResult>
      </GetLibrariesResponse>
   </s:Body>
</s:Envelope>

Space shortcuts

Page tree

Studio API: Management Service

ExecuteAllUnitTests

Dependencies

GetUsedByElementsForGlobalElement

GetUsedByElementsForModuleElement

GetUseElementsForGlobalElement

GetUseElementsForModuleElement

Exports

ExportBranch

ExportLibrary

ExportPackage

ExportProject

ExportProjectRevision

ExportProjectWithMetadata

Elements

FindGlobalElementProject

FindGlobalElements

FindModuleProject

GetAllGlobalElements

GetAllModuleElements

GetGlobalElement

GetGlobalElements

GetModuleElement

GetModuleElements

GetMostSpecificModuleElement

Search

Imports

ImportBranch

ImportLibrary

ImportSpecification

Project Structure

GetModule

GetModules

GetPackage

GetPackages

GetProject

GetProjects

ReadLibraryMetadata

UnitTests

ExecuteAllUnitTests

ExecuteAllUnitTestsForRevision

ExecuteUnitTests

ExecuteUnitTestsForRevision

Version Management

Commit

CreateBranch

CreateBranchType

CreateFeatureBranch

CreateFeatureBranchOnRevision

CreateRepository

DeleteRepository

DeleteBranch

DeleteBranchType

GetRepository

GetRepositories

GetBranch

GetBranches

GetBranchType

GetBranchTypes

GetProjectsForRevision

GetRevision

GetRevisionChanges

GetRevisionDescriptor

GetRevisions

GetRevisionsWithLeveledMergedRevisions

MergeBranch

MergeRevision

SetTags

UpdateRepository

UpdateBranch

UpdateBranchType

Other Methods

ApplyOperations

EvaluateExpression

GetCurrentIdentity

GetDataSource

GetLicenseData

GetStatus