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.
...
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.
...
| Expand |
|---|
| title | Example Message for PresentationStyle |
|---|
|
| 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: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> |
| 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">
<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> |
|
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.
...
| Expand |
|---|
|
| 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> |
| 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> |
|
GetUseElementsForGlobalElement
The server will return a dependency for each element that is used by the specified element.
...
| Expand |
|---|
|
| Code Block |
|---|
| <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<soapenv:Header/>
<soapenv:Body>
<ns: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> |
| 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">
<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> |
|
The server will return a dependency for each element that is used by the specified element.
...
| Expand |
|---|
|
| Code Block |
|---|
| <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<soapenv:Header/>
<soapenv:Body>
<ns: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> |
| 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="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.
...
| Expand |
|---|
|
| Code Block |
|---|
| <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<soapenv:Header/>
<soapenv:Body>
<ns: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> |
| 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. The server will return the bytes of a ZIP file containing the project export.
...
| Expand |
|---|
|
| Code Block |
|---|
| <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<soapenv:Header/>
<soapenv:Body>
<ns: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> |
| 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> |
|
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.
...
| Expand |
|---|
|
| 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> |
| 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
The server will return a list of module elements which matches the specified type within the chosen project.
...
| Expand |
|---|
|
| Code Block |
|---|
| <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<soapenv:Header/>
<soapenv:Body>
<ns: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> |
| 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">
<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.
...
| Expand |
|---|
|
| Code Block |
|---|
| <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<soapenv:Header/>
<soapenv:Body>
<ns: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> |
| 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
GetPackages
GetProject
GetProjects
ReadLibraryMetadata
UnitTests
ExecuteAllUnitTests
Returns the result of all unit tests that are defined within a specific module scope.
...
| Expand |
|---|
|
| Code Block |
|---|
| <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<soapenv:Header/>
<soapenv:Body>
<ns:ExecuteAllUnitTests>
<ns:repository>Kinderbijslag</ns:repository>
<ns:branch>Trunk</ns:branch>
<ns:project>Kinderbijslag</ns:project>
<ns:module Name="Top" ModuleType="Interaction"/>
</ns:ExecuteAllUnitTests>
</soapenv:Body>
</soapenv:Envelope> |
| Code Block |
|---|
| <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ExecuteAllUnitTestsResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<ExecuteAllUnitTestsResult>
<Succeeded>true</Succeeded>
<Results>
<UnitTestReport>
<UnitTestName>SoortKind_AangehuwdKind</UnitTestName>
<ProfileResults>
<ProfileResult>
<ProfileId>0</ProfileId>
<UnitTestResult>
<ExpectedValue>
<string>AangehuwdKind</string>
</ExpectedValue>
<SourcedValue>
<string>AangehuwdKind</string>
</SourcedValue>
<Succeeded>true</Succeeded>
</UnitTestResult>
</ProfileResult>
</ProfileResults>
</UnitTestReport>
<UnitTestReport>
<UnitTestName>SoortKind</UnitTestName>
<ProfileResults>
<ProfileResult>
<ProfileId>0</ProfileId>
<UnitTestResult>
<ExpectedValue>
<string>Pleegkind</string>
</ExpectedValue>
<SourcedValue>
<string>PleegKind</string>
</SourcedValue>
<Succeeded>true</Succeeded>
</UnitTestResult>
</ProfileResult>
</ProfileResults>
</UnitTestReport>
</Results>
</ExecuteAllUnitTestsResult>
</ExecuteAllUnitTestsResponse>
</s:Body>
</s:Envelope> |
|
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.
...
| Expand |
|---|
|
| Code Block |
|---|
| <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<soapenv:Header/>
<soapenv:Body>
<ns:ExecuteUnitTests>
<ns:repository>Kinderbijslag</ns:repository>
<ns:branch>Trunk</ns:branch>
<ns:project>Kinderbijslag</ns:project>
<ns:module Name="Top" ModuleType="Interaction"/>
<ns:unittests>
<ns:string>SoortKind_AangehuwdKind</ns:string>
<ns:string>SoortKind_PleegKind</ns:string>
</ns:unittests>
</ns:ExecuteUnitTests>
</soapenv:Body>
</soapenv:Envelope> |
| Code Block |
|---|
| <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ExecuteUnitTestsResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<ExecuteUnitTestsResult>
<Succeeded>false</Succeeded>
<Results>
<UnitTestReport>
<UnitTestName>SoortKind_AangehuwdKind</UnitTestName>
<ProfileResults>
<ProfileResult>
<ProfileId>0</ProfileId>
<UnitTestResult>
<ExpectedValue>
<string>AangehuwdKind</string>
</ExpectedValue>
<SourcedValue>
<string>AangehuwdKind</string>
</SourcedValue>
<Succeeded>true</Succeeded>
</UnitTestResult>
</ProfileResult>
</ProfileResults>
</UnitTestReport>
<UnitTestReport>
<UnitTestName>SoortKind_PleegKind</UnitTestName>
<ProfileResults>
<ProfileResult>
<ProfileId>0</ProfileId>
<UnitTestResult>
<ExpectedValue>
<string>Pleegkin</string>
</ExpectedValue>
<SourcedValue>
<string>PleegKind</string>
</SourcedValue>
<Succeeded>false</Succeeded>
</UnitTestResult>
</ProfileResult>
</ProfileResults>
</UnitTestReport>
</Results>
</ExecuteUnitTestsResult>
</ExecuteUnitTestsResponse>
</s:Body>
</s:Envelope> |
|
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.
...
| Expand |
|---|
|
| Code Block |
|---|
| <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<soapenv:Header/>
<soapenv:Body>
<ns: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> |
| 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>
<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.
...
| Expand |
|---|
|
| Code Block |
|---|
| <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<soapenv:Header/>
<soapenv:Body>
<ns: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> |
| 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
...
| Expand |
|---|
|
| Code Block |
|---|
| <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<soapenv:Header/>
<soapenv:Body>
<ns: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> |
| 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">
<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 & 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.
...
| Expand |
|---|
|
| 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: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> |
| 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">
<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.
...
| Expand |
|---|
|
| 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:GetStatus>
<ns:repository>FunStuff</ns:repository>
<ns:branch>branch9</ns:branch>
</ns:GetStatus>
</x:Body>
</x:Envelope> |
| Code Block |
|---|
| <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<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.
...
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.
...
| Expand |
|---|
|
| Code Block |
|---|
| <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<soapenv:Header/>
<soapenv:Body>
<ns: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> |
| 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">
<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.
...
| Expand |
|---|
|
| Code Block |
|---|
| <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<soapenv:Header/>
<soapenv:Body>
<ns:StopAdvancedSearch>
<!--Optional:-->
<ns:searchId>
<!--Optional:-->
<ns:SearchId>304254f5-76fc-4bf5-b806-6bce78533a64</ns:SearchId>
</ns:searchId>
</ns:StopAdvancedSearch>
</soapenv:Body>
</soapenv:Envelope> |
| Code Block |
|---|
| <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<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.
...
| Expand |
|---|
|
| Code Block |
|---|
| <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<soapenv:Header/>
<soapenv:Body>
<ns:GetAdvancedSearchResults>
<!--Optional:-->
<ns:searchId>
<!--Optional:-->
<ns:SearchId>304254f5-76fc-4bf5-b806-6bce78533a64</ns:SearchId>
</ns:searchId>
</ns:GetAdvancedSearchResults>
</soapenv:Body>
</soapenv:Envelope> |
| Code Block |
|---|
| <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<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.
...