Table of Contents

maxLevel	1

Dependencies

GetUsedByElementsForGlobalElement

Parameters

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

...

Expand

title	Example Message for Attribute

Request

Code Block

<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:GetUseElementsForModuleElement>
         <ns:repository>MyRepo</ns:repository>
         <ns:branch>Trunk</ns:branch>
         <ns:project>MyProject</ns:project>
         <ns:module Name="MyModule" ModuleType="Interaction"/>
         <ns:moduleElement xsi:type="ns:AttributeKey" Name="Name" ModuleElementType="Attribute">
         	<Entity>Person</Entity>
         </ns:moduleElement>
      </ns:GetUseElementsForModuleElement>
   </soapenv:Body>
</soapenv:Envelope>

Response

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

GetUsedByElementsForModuleElement

Parameters :

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

...

Expand

title	Example Messages

Request

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

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

Response:

Something to consider

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

...

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.

GetUseElementsForGlobalElement

Parameters

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

...

Expand

title	Example Messages

Example Request Message

Code Block

language	xml
title	Example 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>

Example Response Message

Code Block

language	xml
title	Example 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

Parameters:

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

...

Expand

title	Example Messages

Example Request Message

Code Block

language	xml
title	Example 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>

Example Response Message

Code Block

language	xml
title	Example 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.

...

Expand

title	Example Messages

Request:

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

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

...

Expand

title	Example Messages

Request:

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

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

Elements

FindGlobalElementProject

FindglobalElements

...

GetGlobalElement

GetGlobalElements

GetModuleElement

Parameters

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 element key of the element, required
moduleElement: The Name and Type of the module element which should be returned.

...

Expand

Request:

Code Block

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

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

Parameters

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 element key of the element, required
elementType: The type of element that you want to be returned, for example 'Attribute'. For a complete list, search the wsdl for 'ModuleElementType'.

...

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.

...

Expand

title	Example Messages

Request:

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

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

...

GetProjects

ReadLibraryMetadata

UnitTests

ExecuteAllUnitTests

ExecuteUnitTests

Version Management

Commit

CreateBranch

CreateBranchType

...

GetProjectsForRevision

GetRevision

GetRevisionChanges

Returns the changes in a specific revision.

...

Expand

title	Example Messages

Request:

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

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">
      <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>
            </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>
            </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>
            </ElementChange>
         </GetRevisionChangesResult>
      </GetRevisionChangesResponse>
   </s:Body>
</s:Envelope>

GetRevisionDescriptor

GetRevisions

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

...

Expand

title	Example Messages

Request:

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

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

...

UpdateBranch

UpdateBranchType

Other Methods

ApplyOperation

EvaluateExpression

...

SetDataSource

ValidateProject

GetStatusMaxDepth

Returns a list of revisions which are the pending revisions to be commited(accepted in the branch). Same as GetStatus

...

Expand

title	Example Messages

Request:

Code Block

<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:GetStatusMaxDepth>
            <ns:repository>FunStuff</ns:repository>
            <ns:branch>branch9</ns:branch>
            <ns:maxMergedRevisionsDepth>3</ns:maxMergedRevisionsDepth>
        </ns:GetStatusMaxDepth>
    </x:Body>
</x:Envelope>

Response:

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">
        <GetStatusMaxDepthResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
            <GetStatusMaxDepthResult>
                <TipRevision>2538eada-bb93-46a7-948c-c9e9f7f68cc1</TipRevision>
                <WorkingRevision>cbde6cb1-b3ff-44b0-91b2-73afbeee423b</WorkingRevision>
                <Commitable>true</Commitable>             
                <Changes>
                    <Type>Create</Type>
                    <CurrentKey>
                        <Project>
                            <Key>branch4project</Key>
                        </Project>
                    </CurrentKey>
                </Changes>
                <Changes>
                    <Type>Create</Type>
                    <CurrentKey>
                        <Project>
                            <Key>brnach3project</Key>
                        </Project>
                    </CurrentKey>
                </Changes>
                <Changes>
                    <Type>Create</Type>
                    <CurrentKey>
                        <Project>
                            <Key>branch2Project</Key>
                        </Project>
                    </CurrentKey>
                </Changes>
                <MergeRevisions>
                    <CommitTime>2017-03-15T13:56:23.793</CommitTime>
                    <RevisionId>9796f7eb-060e-42dd-bef2-927078e94609</RevisionId>
                    <Message>aaa</Message>
                    <Committer>admin</Committer>
                    <Branch>branch6</Branch>
                    <ParentRevisionIds>55a73f9d-3b31-4852-bcc0-08558bb1ed62</ParentRevisionIds>
                    <ParentRevisionIds>014c231e-9381-47f5-96b8-8a2692ad9b54</ParentRevisionIds>
                    <MergeRevisions>
                        <CommitTime>2017-03-15T13:52:31.093</CommitTime>
                        <RevisionId>014c231e-9381-47f5-96b8-8a2692ad9b54</RevisionId>
                        <Message>aaa</Message>
                        <Committer>admin</Committer>
                        <Branch>branch7</Branch>
                        <ParentRevisionIds>26138c8c-28ce-4f1c-9939-5bbdfd8e96b5</ParentRevisionIds>
                        <ParentRevisionIds>250332f3-8b42-4eb3-ab4b-6e793898cf93</ParentRevisionIds>
                        <MergeRevisions>
                            <CommitTime>2017-03-15T13:45:44.017</CommitTime>
                            <RevisionId>250332f3-8b42-4eb3-ab4b-6e793898cf93</RevisionId>
                            <Message>q1</Message>
                            <Committer>admin</Committer>
                            <Branch>branch4</Branch>
                            <ParentRevisionIds>17d4af9d-bce7-4ca2-a35d-bf48a88644ec</ParentRevisionIds>
                            <ParentRevisionIds>5fe5fd12-4610-422c-9496-e18130dc822b</ParentRevisionIds>
                        </MergeRevisions>
                        <MergeRevisions>
                            <CommitTime>2017-03-15T13:33:13.96</CommitTime>
                            <RevisionId>17d4af9d-bce7-4ca2-a35d-bf48a88644ec</RevisionId>
                            <Message>a1</Message>
                            <Committer>admin</Committer>
                            <Branch>branch4</Branch>
                            <ParentRevisionIds>cd2ba04a-93c1-4db8-bf94-4d8a4f991994</ParentRevisionIds>
                            <ParentRevisionIds>e1418147-b136-4515-814e-8dd44cfd6aa4</ParentRevisionIds>
                        </MergeRevisions>
                        <MergeRevisions>
                            <CommitTime>2017-03-15T13:31:55.617</CommitTime>
                            <RevisionId>cd2ba04a-93c1-4db8-bf94-4d8a4f991994</RevisionId>
                            <Message>a1</Message>
                            <Committer>admin</Committer>
                            <Branch>branch4</Branch>
                            <ParentRevisionIds>2538eada-bb93-46a7-948c-c9e9f7f68cc1</ParentRevisionIds>
                        </MergeRevisions>
                    </MergeRevisions>
                    <MergeRevisions>
                        <CommitTime>2017-03-15T13:52:10.137</CommitTime>
                        <RevisionId>26138c8c-28ce-4f1c-9939-5bbdfd8e96b5</RevisionId>
                        <Message>a5</Message>
                        <Committer>admin</Committer>
                        <Branch>branch7</Branch>
                        <ParentRevisionIds>971d60ba-b70b-42d2-b6b2-3c08ca383282</ParentRevisionIds>
                        <ParentRevisionIds>95615b39-ad82-4932-bc5e-94234183f103</ParentRevisionIds>
                        <MergeRevisions>
                            <CommitTime>2017-03-15T13:47:20.46</CommitTime>
                            <RevisionId>95615b39-ad82-4932-bc5e-94234183f103</RevisionId>
                            <Message>a1</Message>
                            <Committer>admin</Committer>
                            <Branch>Branch5</Branch>
                            <ParentRevisionIds>8b6fb392-bb40-4274-b8f8-635f6049fdf7</ParentRevisionIds>
                            <ParentRevisionIds>4c57d9c4-8a4c-4a84-a535-c5b5cdb926f0</ParentRevisionIds>
                        </MergeRevisions>
                    </MergeRevisions>
                </MergeRevisions>
                <MergeRevisions>
                    <CommitTime>2017-03-15T13:55:53.077</CommitTime>
                    <RevisionId>55a73f9d-3b31-4852-bcc0-08558bb1ed62</RevisionId>
                    <Message>a44</Message>
                    <Committer>admin</Committer>
                    <Branch>branch6</Branch>
                    <ParentRevisionIds>ac9ce6f0-d814-4a69-b0cc-5205509d4a65</ParentRevisionIds>
                    <ParentRevisionIds>abeedd37-9c04-4783-8850-1dd2f1ded126</ParentRevisionIds>
                    <MergeRevisions>
                        <CommitTime>2017-03-15T13:46:42.007</CommitTime>
                        <RevisionId>abeedd37-9c04-4783-8850-1dd2f1ded126</RevisionId>
                        <Message>save</Message>
                        <Committer>admin</Committer>
                        <Branch>branch4</Branch>
                        <ParentRevisionIds>f81a0556-3891-49f4-ade8-3d6abe3dcbfe</ParentRevisionIds>
                        <ParentRevisionIds>4c57d9c4-8a4c-4a84-a535-c5b5cdb926f0</ParentRevisionIds>
                        <MergeRevisions>
                            <CommitTime>2017-03-15T13:45:16.333</CommitTime>
                            <RevisionId>4c57d9c4-8a4c-4a84-a535-c5b5cdb926f0</RevisionId>
                            <Message>merge</Message>
                            <Committer>admin</Committer>
                            <Branch>Trunk</Branch>
                            <ParentRevisionIds>d137f43d-fce9-4d08-8f51-aca31e7dc720</ParentRevisionIds>
                            <ParentRevisionIds>17d4af9d-bce7-4ca2-a35d-bf48a88644ec</ParentRevisionIds>
                        </MergeRevisions>
                        <MergeRevisions>
                            <CommitTime>2017-03-15T13:44:44.5</CommitTime>
                            <RevisionId>d137f43d-fce9-4d08-8f51-aca31e7dc720</RevisionId>
                            <Message>merge</Message>
                            <Committer>admin</Committer>
                            <Branch>Trunk</Branch>
                            <ParentRevisionIds>8b6fb392-bb40-4274-b8f8-635f6049fdf7</ParentRevisionIds>
                            <ParentRevisionIds>233e802d-7392-459e-a5a4-32baf676c344</ParentRevisionIds>
                        </MergeRevisions>
                        <MergeRevisions>
                            <CommitTime>2017-03-15T13:43:40.307</CommitTime>
                            <RevisionId>8b6fb392-bb40-4274-b8f8-635f6049fdf7</RevisionId>
                            <Message>mergeIntoMaster</Message>
                            <Committer>admin</Committer>
                            <Branch>Trunk</Branch>
                            <ParentRevisionIds>53ec7bf3-0d47-4763-9f9d-d7e733f5c802</ParentRevisionIds>
                            <ParentRevisionIds>5fe5fd12-4610-422c-9496-e18130dc822b</ParentRevisionIds>
                        </MergeRevisions>
                        <MergeRevisions>
                            <CommitTime>2017-03-15T13:37:29.477</CommitTime>
                            <RevisionId>53ec7bf3-0d47-4763-9f9d-d7e733f5c802</RevisionId>
                            <Message>a1</Message>
                            <Committer>admin</Committer>
                            <Branch>Trunk</Branch>
                            <ParentRevisionIds>2538eada-bb93-46a7-948c-c9e9f7f68cc1</ParentRevisionIds>
                        </MergeRevisions>
                    </MergeRevisions>
                </MergeRevisions>              
            </GetStatusMaxDepthResult>
        </GetStatusMaxDepthResponse>
    </s:Body>
</s:Envelope>

Advanced Search Methods

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

...

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.

...

Code Block

language	xml
title	Start Advanced Search Response Example
collapse	true

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

...

Code Block

language	xml
title	Stop Advanced Search Example Response
collapse	true

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

...

Code Block

language	xml
title	Get Advanced Search Results Example Response
collapse	true

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

...

Space shortcuts

Page tree

Versions Compared

Old Version 11

New Version 12

Key

Dependencies

GetUsedByElementsForGlobalElement

GetUsedByElementsForModuleElement

Something to consider

GetUseElementsForGlobalElement

GetUseElementsForModuleElement

Exports

ExportProject

ExportProjectRevision

Elements

GetModuleElement

GetModuleElements

Search

Imports

Project Structure

UnitTests

Version Management

GetRevisionChanges

GetRevisions

GetRevisionsWithLeveledMergedRevisions

Other Methods

GetStatusMaxDepth

Advanced Search Methods

StartAdvancedSearch

StopAdvancedSearch

GetAdvancedSearchResults

GetLibraries

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 11

New Version 12

Key

Dependencies

GetUsedByElementsForGlobalElement

GetUsedByElementsForModuleElement

Something to consider

GetUseElementsForGlobalElement

GetUseElementsForModuleElement

Exports

ExportProject

ExportProjectRevision

Elements

GetModuleElement

GetModuleElements

Search

Imports

Project Structure

UnitTests

Version Management

GetRevisionChanges

GetRevisions

GetRevisionsWithLeveledMergedRevisions

Other Methods

GetStatusMaxDepth

Advanced Search Methods

StartAdvancedSearch

StopAdvancedSearch

GetAdvancedSearchResults

GetLibraries