ExecuteAllUnitTests
The management service is a SOAP service that allows you to access and edit your studio repository without the use of studioBlueriq Encore. Everything that the studio Encore does graphically can be done via methods in the management service. You could theoretically build your own studio Encore that connects to the management service. This article describes how to authenticate and the different methods of the management service.
| Note |
|---|
| title | minOccurences in the XSD |
|---|
|
Although many parameters in the XSD have a minOccurence of zero, almost all parameters are required. We advise to ignore the <!--Optional:--> line some tools such as SoapUI generate based on the minOccurence. |
For authentication, you have to send your credentials with each request to the management service . Depending on your settings in studio, this might for example be Basic or NTLM. Here is an example using Basic authentication.
| Expand |
|---|
| title | Example of how to configure |
|---|
|
...
...
...
 Image Added
|
We distinguish different categories of methods:
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
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 | Parameters |
|---|
|
| 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 |
|
| Expand |
|---|
| title | Example Message for PresentationStyle |
|---|
|
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: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 |
|---|
| | 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> |
|
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.
| Expand |
|---|
| title | Example Message for Attribute | Parameters |
|---|
|
| 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 |
|
| Expand |
|---|
| title | 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. 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 GenericProjectGenericProject contains module GenericModuleGenericModule contains entity and attribute Person.Name
SpecificProject contains module SpecificModule, which includes GenericModuleSpecificModule contains container PersonView which displays Person.NameSpecificModule contains page Overview which contains PersonView
- project
UnrelatedProject references noneUnrelatedProject contains module UnrelatedModuleUnrelatedModule contains entity and attribute Person.NameUnrelatedModule 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 becauseSpecificModule includes GenericModulePersonView has a direct reference to Person.Name
But not for Overview in SpecificModule becauseOverview 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. |
| 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" |
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<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="ns:AttributeKey" Name="Nametest" ModuleElementType="Attribute">
<Entity>Person< <Entity xmlns="">test</Entity>
</ns:moduleElement>
</ns:GetUseElementsForModuleElement>GetUsedByElementsForModuleElement>
</soapenvs:Body>
</soapenvs:Envelope> |
| Code Block |
|---|
| | 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<GetUsedByElementsForModuleElementResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<GetUseElementsForModuleElementResult><GetUsedByElementsForModuleElementResult>
<Dependency>
<ReferenceType>Usage</ReferenceType>
<From>
<ModuleElement>
<Project Name="MyProjectTestProject"/>
<Module Name="MyModulemain" ModuleType="Interaction"/>
<Key xsi:typeName="AttributeKeytestpage" NameModuleElementType="Name" ModuleElementType="Attribute"Page"/>
</ModuleElement>
<Entity xmlns="">Person</Entity>
</From>
</Key><To>
</ModuleElement><ModuleElement>
</From>
<Project Name="TestProject"/>
<To>
<Module Name="main" ModuleType="Interaction"/>
<ModuleElement>
<Key xsi:type="AttributeKey" <Project NameName="test" ModuleElementType="MyProjectAttribute"/>
<Module Name="MyModule" ModuleType <Entity xmlns="Interaction">test</>Entity>
<Key Name="Person" ModuleElementType="Entity"/></Key>
</ModuleElement>
</To>
</Dependency>
</GetUseElementsForModuleElementResult> <Dependency>
</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
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 |
|---|
|
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">
<ReferenceType>Usage</ReferenceType>
<From>
<GetUsedByElementsForModuleElement xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0"> <ModuleElement>
<repository>TestRepository</repository>
<Project <branch>Trunk</branch>Name="TestProject"/>
<project>TestProject</project>
<module<Module Name="main" ModuleType="Interaction"/>
<moduleElement xsi:type="AttributeKey" <Key Name="testtestcontainer" ModuleElementType="AttributeContainer"/>
<Entity xmlns="">test</Entity> </ModuleElement>
</moduleElement>
</GetUsedByElementsForModuleElement>From>
</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"> <To>
<GetUsedByElementsForModuleElementResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<GetUsedByElementsForModuleElementResult>
<ModuleElement>
<Dependency>
<ReferenceType>Usage</ReferenceType><Project Name="TestProject"/>
<From>
<Module Name="main" ModuleType="Interaction"/>
<ModuleElement>
<Project Name="TestProject"/<Key xsi:type="AttributeKey" Name="test" ModuleElementType="Attribute">
<Module Name="main" ModuleType <Entity xmlns="Interaction">test</>Entity>
<Key Name="testpage" ModuleElementType="Page"/></Key>
</ModuleElement>
</From>To>
<To></Dependency>
<ModuleElement></GetUsedByElementsForModuleElementResult>
<Project Name="TestProject"/></GetUsedByElementsForModuleElementResponse>
<Module Name="main" ModuleType="Interaction"/>
<Key xsi:type="AttributeKey" Name="test" ModuleElementType="Attribute">
</s:Body>
</s:Envelope> |
|
GetUseElementsForGlobalElement
The server will return a dependency for each element that is used by the specified element.
| Expand |
|---|
|
| 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 |
|
| 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>
<Entity xmlns="">test</Entity><ns:repository>DCM</ns:repository>
<ns:branch>Trunk</ns:branch>
</Key><ns:project>Main_Dashboard</ns:project>
<ns:globalElement Name="MyContentStyle" GlobalElementType="ContentStyle"/>
</ModuleElement>
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">
To>
</Dependency> <GetUseElementsForGlobalElementResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<Dependency><GetUseElementsForGlobalElementResult>
<ReferenceType>Usage</ReferenceType><Dependency>
<From><ReferenceType>Usage</ReferenceType>
<ModuleElement><From>
<Project Name="TestProject"/><Global>
<Module<Project Name="main" ModuleType="Interaction"Main_Dashboard"/>
<Key Name="testcontainerMyContentStyle" ModuleElementTypeGlobalElementType="ContainerContentStyle"/>
</ModuleElement>Global>
</From>
<To>
<ModuleElement><Global>
<Project Name="TestProjectAquimaTheme"/>
<Module<Key Name="mainAnchor" ModuleTypeGlobalElementType="InteractionContentStyle"/>
</Global>
<Key xsi:type="AttributeKey" Name="test" ModuleElementType="Attribute">
<Entity xmlns="">test</Entity>
</Key>
</ModuleElement>
</To>
</Dependency>
</GetUsedByElementsForModuleElementResult>GetUseElementsForGlobalElementResult>
</GetUsedByElementsForModuleElementResponse>GetUseElementsForGlobalElementResponse>
</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.
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 GenericProjectGenericProject contains module GenericModuleGenericModule contains entity and attribute Person.Name
SpecificProject contains module SpecificModule, which includes GenericModuleSpecificModule contains container PersonView which displays Person.NameSpecificModule contains page Overview which contains PersonView
- project
UnrelatedProject references noneUnrelatedProject contains module UnrelatedModuleUnrelatedModule contains entity and attribute Person.NameUnrelatedModule 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 becauseSpecificModule includes GenericModulePersonView has a direct reference to Person.Name
But not for
Overview in SpecificModule becauseOverview 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.
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
The server will return a dependency for each element that is used by the specified element.
GetUseElementsForModuleElement
The server will return a dependency for each element that is used by the specified element.
| Expand |
|---|
|
| 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 |
|
| 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> |
|
| Expand |
|---|
|
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<project>Main_Dashboard</ns:repository>project>
<ns:branch>Trunk</ns:branch>
<ns:project>Main_Dashboard</ns:project>module Name="Dashboard" ModuleType="Interaction"/>
<ns:globalElementmoduleElement Name="MyContentStyleMyExampleContainer" GlobalElementTypeModuleElementType="ContentStyleContainer"/>
</ns:GetUseElementsForGlobalElement>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">
<GetUseElementsForGlobalElementResponse<GetUseElementsForModuleElementResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<GetUseElementsForGlobalElementResult><GetUseElementsForModuleElementResult>
<Dependency>
<ReferenceType>Usage</ReferenceType>
<From>
<Global><ModuleElement>
<Project Name="Main_Dashboard"/>
<Module Name="Dashboard" ModuleType="Interaction"/>
<Key Name="MyContentStyleMyExampleContainer" GlobalElementTypeModuleElementType="ContentStyleContainer"/>
</Global>ModuleElement>
</From>
<To>
<Global><ModuleElement>
<Project Name="AquimaThemeBasis_Functionaliteit"/>
<Key<Module Name="AnchorBasis_Functionaliteit" GlobalElementTypeModuleType="ContentStyleInteraction"/>
</Global> <Key Name="Document" ModuleElementType="Entity"/>
</To>ModuleElement>
</Dependency>To>
</GetUseElementsForGlobalElementResult>Dependency>
</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
The server will return a dependency for each element that is used by the specified element.
| Expand |
|---|
|
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>
<Dependency>
<ReferenceType>Usage</ReferenceType>
<From>
<ns:GetUseElementsForModuleElement>
<ns:repository>DCM</ns:repository><ModuleElement>
<ns:branch>Trunk</ns:branch>
<ns:project>Main_Dashboard</ns:project>
<Project Name="Main_Dashboard"/>
<ns:module <Module Name="Dashboard" ModuleType="Interaction"/>
<ns:moduleElement <Key Name="MyExampleContainer" ModuleElementType="Container"/>
</ns:GetUseElementsForModuleElement>ModuleElement>
</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"> </From>
<GetUseElementsForModuleElementResult>
<To>
<Dependency>
<ReferenceType>Usage</ReferenceType><ModuleElement>
<From>
<Project Name="Basis_Functionaliteit"/>
<ModuleElement>
<Project <Module Name="Main_Dashboard"/>
<Module Name="Dashboard"Basis_Functionaliteit" ModuleType="Interaction"/>
<Key xsi:type="AttributeKey" Name="MyExampleContainerId" ModuleElementType="ContainerAttribute"/>
</ModuleElement>
<Entity xmlns="">Document</Entity>
</From>
<To></Key>
<ModuleElement></ModuleElement>
<Project Name="Basis_Functionaliteit"/></To>
</Dependency>
<Module Name="Basis_Functionaliteit" ModuleType="Interaction"/></GetUseElementsForModuleElementResult>
<Key Name="Document" ModuleElementType="Entity"/>
</ModuleElement></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 |
|---|
|
| 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 |
|
| 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>
</To><ns:repository>TestRepository</ns:repository>
</Dependency><ns:branch>Trunk</ns:branch>
<Dependency><ns:project>TestProject</ns:project>
<ns:encrypt>false</ns:encrypt>
<ReferenceType>Usage<</ReferenceType>ns:ExportProject>
</soapenv:Body>
</soapenv:Envelope> |
| Code Block |
|---|
| <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<From><s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ModuleElement><ExportProjectResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<Project Name="Main_Dashboard"/<ExportProjectResult ContentType="application/zip">
<Content>UEsDBBQACAA <Module Name="Dashboard" ModuleType="Interaction"/>... CxJwAAAAA=</Content>
</ExportProjectResult>
<Key Name="MyExampleContainer" ModuleElementType="Container"/>
</ModuleElement>
</From>
<To></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 |
|---|
|
| 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 |
|
| 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>
<ModuleElement><ns:branch>Trunk</ns:branch>
<ns:revisionId>b1372603-4705-4728-8ef4-198477f97e6e</ns:revisionId>
<Project Name="Basis_Functionaliteit"/><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/">
<Module Name="Basis_Functionaliteit" ModuleType="Interaction"/<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">
<Key xsi:type="AttributeKey" Name="Id" ModuleElementType="Attribute"<ExportProjectRevisionResult ContentType="application/zip">
<Content>UEsDBBQ <Entity xmlns="">Document</Entity>
</Key>
... CeIQAAAAA=</Content>
</ModuleElement>
ExportProjectRevisionResult>
</To>ExportProjectRevisionResponse>
</Dependency>
</GetUseElementsForModuleElementResult>
</GetUseElementsForModuleElementResponse>
</s:Body>
</s:Envelope> |
|
Exports
ExportBranch
ExportLibrary
ExportPackage
ExportProject
Exports the working revision of a project.
Parameters:
- 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
...
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.
| Info |
|---|
For certain elements a special type is required to uniquely identify an element. 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. |
| Expand |
|---|
|
| 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 |
|
| 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:ExportProject>GetModuleElement>
<ns:repository>TestRepository</ns:repository>
<ns:branch>Trunk</ns:branch>
<ns:project>TestProject</ns:project>
<ns:encrypt>false<module Name="Main" ModuleType="Interaction"/>
<ns:moduleElement xsi:type="ns:AttributeKey" Name="DateOfBirth" ModuleElementType="Attribute">
<Entity>Person</Entity>
</ns:encrypt>moduleElement>
</ns:ExportProject>GetModuleElement>
</soapenv:Body>
</soapenv:Envelope> |
Response: | | Code Block |
|---|
| <s:<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<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">
<ExportProjectResult ContentType <Comments xmlns="application/zip"/>
<Tags xmlns="">
<Content>UEsDBBQACAA ... CxJwAAAAA=</Content> <Tag>
</ExportProjectResult>
<Name>Person</Name>
</ExportProjectResponse>Tag>
</s:Body>
</s:Envelope> |
|
ExportProjectRevision
Exports a project at a specific revision
Parameters:
- 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
- project: the project to be exported, required
- encrypt: a boolean flag indicating whether the export should be encrypted, required
The server will return the bytes of a ZIP file containing the project export.
| Expand |
|---|
|
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>Tags>
<QuestionText xmlns="">
<Text Language="dutch">
<Value>Date of Birth</Value>
<ns:ExportProjectRevision>
<ns:repository>TestRepository</ns:repository></Text>
<ns:branch>Trunk</ns:branch>
</QuestionText>
<ns:revisionId>b1372603-4705-4728-8ef4-198477f97e6e</ns:revisionId> <ExplainText xmlns=""/>
<ns:project>TestProject</ns:project> <ValidationRules xmlns=""/>
<ns:encrypt>false</ns:encrypt></GetModuleElementResult>
</ns:ExportProjectRevision>GetModuleElementResponse>
</soapenvs:Body>
</soapenvs:Envelope> |
|
GetModuleElements
The server will return a list of module elements which matches the specified type within the chosen project.
| Expand |
|---|
|
| 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 |
|
| Expand |
|---|
|
| Code Block |
|---|
| <soapenv:Envelope xmlns:soapenv |
Response: | Code Block |
|---|
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsins="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">everest.nl/aquima/studio/ManagementService/1.0">
<soapenv:Header/>
<soapenv:Body>
<ns:GetModuleElements>
<ExportProjectRevisionResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0"> <ns:repository>TestRepository</ns:repository>
<ExportProjectRevisionResult ContentType="application/zip"><ns:branch>Trunk</ns:branch>
<ns:project>TestProject</ns:project>
<Content>UEsDBBQ ... CeIQAAAAA=</Content> <ns:module Name="main" ModuleType="Interaction"/>
</ExportProjectRevisionResult><ns:elementType>Attribute</ns:elementType>
</ExportProjectRevisionResponse>ns:GetModuleElements>
</ssoapenv:Body>
</ssoapenv:Envelope> |
|
...
...
...
...
GetAllGlobalElements
GetAllModuleElements
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.
| UI Text Box |
|---|
|
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. |
The server will return a description of the element with all the settings which can be configured in studio.
| <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd |
|
| Expand |
|---|
Request: | Code Block |
|---|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<GetModuleElementsResponse xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<soapenv:Header/>
<soapenv:Body>
<GetModuleElementsResult>
<ns:GetModuleElement>
<ModuleElementKey <ns:repository>TestRepository</ns:repository>
xsi:type="AttributeKey" Name="DateOfBirth" ModuleElementType="Attribute">
<ns:branch>Trunk</ns:branch>
<ns:project>TestProject</ns:project><Entity xmlns="">Person</Entity>
<ns:module Name="Main" ModuleType="Interaction"/> </ModuleElementKey>
<ns:moduleElement <ModuleElementKey xsi:type="ns:AttributeKey" Name="DateOfBirthName" ModuleElementType="Attribute">
<Entity <Entity>Person</Entity>xmlns="">Person</Entity>
</ModuleElementKey>
</ns:moduleElement>GetModuleElementsResult>
</ns:GetModuleElement>GetModuleElementsResponse>
</soapenvs:Body>
</soapenvs:Envelope> |
Response: |
GetMostSpecificModuleElement
Search
This method searches for an element in a given branch, project or module. It is equivalent to the search functionality present in Blueriq Encore.
| Expand |
|---|
|
| 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
|
| 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>
| | 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><ns:SearchType>ModuleScope</ns:SearchType>
</Tag><ns:Repository>HospitalDCM</ns:Repository>
</Tags><ns:Branch>Trunk</ns:Branch>
<QuestionText xmlns=""><ns:Project>HospitalDCM</ns:Project>
<ns:Module <Text LanguageName="Dashboard" ModuleType="dutchInteraction"/>
<ns:SearchString>Menu</ns:SearchString>
<Value>Date of Birth</Value>
<ns:SearchInNames>1</ns:SearchInNames>
</Text><ns:SearchInDependencies>0</ns:SearchInDependencies>
</QuestionText><ns:IncludeGlobalElements>0</ns:IncludeGlobalElements>
<ExplainText xmlns=""/><ns:IncludeModuleElements>1</ns:IncludeModuleElements>
<ValidationRules xmlns=""/>
<ns:FullText>0</ns:FullText>
</GetModuleElementResult>
</GetModuleElementResponse><ns:CaseSensitive>0</ns:CaseSensitive>
</ns:parameters>
</ns:Search>
</ssoapenv:Body>
</ssoapenv:Envelope> |
|
...
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'.
The server will return a list of module elements which matches the specified type within the chosen project.
|
| Expand |
|---|
Request: | Code Block |
|---|
<soapenv:Envelope xmlns:soapenvs="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns>
<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>
<soapenv:Header/ <SearchResultItem xsi:type="ElementSearchResultItem">
<soapenv:Body>
<ns:GetModuleElements><Element>
<ns:repository>TestRepository</ns:repository>
<ns:branch>Trunk</ns:branch>
<ModuleElement>
<ns:project>TestProject</ns:project>
<ns:module<Project Name="main" ModuleType="Interaction"HospitalDCM"/>
<ns:elementType>Attribute</ns:elementType>
</ns:GetModuleElements>
</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">
<GetModuleElementsResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0" <Module Name="Dashboard" ModuleType="Interaction"/>
<GetModuleElementsResult>
<ModuleElementKey xsi:type="AttributeKey" <Key Name="DateOfBirthMenuBar" ModuleElementType="AttributeContainer"/>
<Entity xmlns="">Person</Entity>
</ModuleElement>
</Element>
</ModuleElementKey>SearchResultItem>
<ModuleElementKey<SearchResultItem xsi:type="AttributeKey" Name="Name" ModuleElementType="Attribute">
ElementSearchResultItem">
<Element>
<ModuleElement>
<Project Name="HospitalDCM"/>
<Entity xmlns <Module Name="Dashboard" ModuleType="Interaction">Person</Entity>>
</ModuleElementKey>
</GetModuleElementsResult>
<Key Name="Dashboard_Menu" ModuleElementType="Container"/>
</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.
Parameters:
SearchType: In what scope you would like to search. Values: Branch, ProjectStructure, SingleProject, ModuleScopeRepository: the repository in which the search is performedBranch: the branch in which the search is performedProject: Optional, the projectin which the search is performedModule: Optional, the modulein which the search is performedSearchString: the string to be searched forSearchInNames: a boolean indicating whether to search in names of elementsSearchInDependencies: a boolean indicating whether to search in the dependencies of an elementIncludeGlobalElements: a boolean indicating whether to search in global elementsIncludeModuleElements: a boolean indicating whether to search in global elementsFullText: a boolean indicating if a full text search should be performedCaseSensitive: a boolean indicating that the search should be performed in a case-sensitive manner
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
</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 |
|---|
|
| Parameter | Parameter description | Required/optional |
|---|
| repository | The name of the repository of which the the unit tests have to be executed | required | | branch | The name of the branch of which the the unit tests have to be executed | required | | project | The name of the project of which the the unit tests have to be executed | required | | module | The module scope of which the unit tests have to be executed. This includes tests and logic defined in the given module and all underlying modules. | required |
|
| Expand |
|---|
|
|
| Expand |
|---|
|
Request: code | <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>ExecuteAllUnitTests>
<ns:parameters>repository>Kinderbijslag</ns:repository>
<ns:SearchType>ModuleScope<branch>Trunk</ns:SearchType>branch>
<ns:Repository>HospitalDCM<project>Kinderbijslag</ns:Repository>project>
<ns:Branch>Trunk</ns:Branch><ns:module Name="Top" ModuleType="Interaction"/>
<ns:Project>HospitalDCM<</ns:Project>ExecuteAllUnitTests>
</soapenv:Body>
</soapenv:Envelope> | | Code Block |
|---|
| <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<ns:Module Name="Dashboard" ModuleType="Interaction"/<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">
<ns:SearchString>Menu</ns:SearchString> <ExecuteAllUnitTestsResult>
<ns:SearchInNames>1</ns:SearchInNames><Succeeded>true</Succeeded>
<ns:SearchInDependencies>0</ns:SearchInDependencies>
<Results>
<ns:IncludeGlobalElements>0</ns:IncludeGlobalElements>
<UnitTestReport>
<ns:IncludeModuleElements>1</ns:IncludeModuleElements>
<UnitTestName>SoortKind_AangehuwdKind</UnitTestName>
<ns:FullText>0</ns:FullText><ProfileResults>
<ns:CaseSensitive>0</ns:CaseSensitive> <ProfileResult>
</ns:parameters>
<<ProfileId>0</ns:Search>ProfileId>
</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"> <UnitTestResult>
<SearchResult>
<SearchResultItem xsi:type="ElementSearchResultItem">
<ExpectedValue>
<Element>
<ModuleElement>
<string>AangehuwdKind</string>
<Project Name="HospitalDCM"/>
</ExpectedValue>
<Module Name="Dashboard" ModuleType="Interaction"/>
<SourcedValue>
<Key Name="MenuBar" ModuleElementType="Container"/>
<<string>AangehuwdKind</ModuleElement>string>
</Element>
</SearchResultItem>SourcedValue>
<SearchResultItem xsi:type="ElementSearchResultItem">
<Succeeded>true</Succeeded>
<Element>
<ModuleElement></UnitTestResult>
<Project Name="HospitalDCM"/></ProfileResult>
</ProfileResults>
<Module Name="Dashboard" ModuleType="Interaction"/>
</UnitTestReport>
<Key Name="Dashboard_Menu" ModuleElementType="Container"/> <UnitTestReport>
<<UnitTestName>SoortKind</ModuleElement>UnitTestName>
</Element> <ProfileResults>
</SearchResultItem>
<ProfileResult>
<SearchResultItem xsi:type="ElementSearchResultItem">
<Element>
<ProfileId>0</ProfileId>
<ModuleElement>
<UnitTestResult>
<Project Name="HospitalDCM"/>
<ExpectedValue>
<Module Name="Dashboard" ModuleType="Interaction"/>
<Key Name="DashboardMenu" ModuleElementType="FlowEvent"/>
<string>Pleegkind</string>
</ModuleElement>
</ExpectedValue>
<SourcedValue>
</Element>
<string>PleegKind</string>
</SearchResultItem>SourcedValue>
</SearchResult>
<Succeeded>true</Succeeded>
</SearchResponse>UnitTestResult>
</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
ExecuteUnitTests
Version Management
Commit
CreateBranch
CreateBranchType
CreateFeatureBranch
CreateFeatureBranchOnRevision
DeleteRepository
DeleteBranch
DeleteBranchType
GetRepository
GetRepositories
GetBranch
GetBranches
GetBranchType
GetBranchTypes
GetProjectsForRevision
GetRevision
GetRevisionChanges
Returns the changes in a specific revision.
Parameters:
- repository: the repository to search in, required.
- branch: the branch to search in, required.
- revision: the revision whose changes are to be retrieved, required
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.
ExecuteUnitTests
Returns the result of a list of specified unit tests, defined within a specific module scope.
| Expand |
|---|
|
| Parameter | Parameter description | Required/optional |
|---|
| repository | The name of the repository of which the the unit tests have to be executed | required | | branch | The name of the branch of which the the unit tests have to be executed | required | | project | The name of the project of which the the unit tests have to be executed | required | | module | The module scope of which the unit tests have to be executed. In contrast to the "ExecuteAllUnitTests" method, unlderlying modules are ignored here. | required | | unittests | A list of unit tests to be run. In case no unit tests are submitted, the result will be "succeed". | optional |
|
| Expand |
|---|
|
|
| Expand |
|---|
|
Request: code | <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>ExecuteUnitTests>
<!--Optional:--><ns:repository>Kinderbijslag</ns:repository>
<ns:repository>TestRepository<branch>Trunk</ns:repository>branch>
<!--Optional:--><ns:project>Kinderbijslag</ns:project>
<ns:branch>Trunk</ns:branch>module Name="Top" ModuleType="Interaction"/>
<!--Optional:--><ns:unittests>
<ns:revision>eadcb8e1-c306-4ea0-a983-162afa863473</ns:revision> <ns:string>SoortKind_AangehuwdKind</ns:string>
<ns:string>SoortKind_PleegKind</ns:string>
</ns:unittests>
</ns:GetRevisionChanges>ExecuteUnitTests>
</soapenv:Body>
</soapenv:Envelope> | Response: | Code Block |
|---|
| code | <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<ExecuteUnitTestsResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<GetRevisionChangesResult><ExecuteUnitTestsResult>
<ElementChange><Succeeded>false</Succeeded>
<Type>Create</Type><Results>
<CurrentKey><UnitTestReport>
<ModuleElement><UnitTestName>SoortKind_AangehuwdKind</UnitTestName>
<ProfileResults>
<Project Name="TestProject"/>
<ProfileResult>
<Module Name="TestModule" ModuleType="Interaction"/>
<ProfileId>0</ProfileId>
<Key Name="Address" ModuleElementType="Entity"/>
</ModuleElement><UnitTestResult>
</CurrentKey>
</ElementChange>
<ExpectedValue>
<ElementChange>
<Type>Create<<string>AangehuwdKind</Type>string>
<CurrentKey>
</ExpectedValue>
<ModuleElement>
<SourcedValue>
<Project Name="TestProject"/>
<Module Name="TestModule" ModuleType="Interaction"/>
<string>AangehuwdKind</string>
<Key xsi:type="AttributeKey" Name="Street" ModuleElementType="Attribute">
</SourcedValue>
<Entity xmlns="">Address</Entity>
<Succeeded>true</Succeeded>
</Key>UnitTestResult>
</ModuleElement>ProfileResult>
</CurrentKey>ProfileResults>
</ElementChange>UnitTestReport>
<ElementChange><UnitTestReport>
<Type>Create<<UnitTestName>SoortKind_PleegKind</Type>UnitTestName>
<CurrentKey> <ProfileResults>
<ModuleElement> <ProfileResult>
<Project Name="TestProject"/><ProfileId>0</ProfileId>
<Module Name="TestModule" ModuleType="Interaction"/> <UnitTestResult>
<Key xsi:type="RelationKey" Name="hasAddress" ModuleElementType="Relation">
<ExpectedValue>
<Entity xmlns="">Person</Entity><string>Pleegkin</string>
</Key>
ExpectedValue>
</ModuleElement>
<SourcedValue>
< <string>PleegKind</CurrentKey>string>
</ElementChange>
SourcedValue>
</GetRevisionChangesResult> <Succeeded>false</Succeeded>
</GetRevisionChangesResponse>UnitTestResult>
</s:Body>
</s:Envelope> |
|
GetRevisionDescriptor
GetRevisions
Returns a list of revisions in a specified repository and branch.
Parameters:
...
</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 |
|---|
|
| 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 |
|
...
| 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>GetRevisionChanges>
<ns:repository>TestRepository</ns:repository><!--Optional:-->
<ns:branch>Trunk<repository>TestRepository</ns:branch>repository>
<ns:startIndex>0</ns:startIndex><!--Optional:-->
<ns:amount>-1<branch>Trunk</ns:amount>branch>
<ns:taggedOnly>false</ns:taggedOnly><!--Optional:-->
<ns:includeMergeRevisions>true<revision>eadcb8e1-c306-4ea0-a983-162afa863473</ns:includeMergeRevisions>revision>
</ns:GetRevisions>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">
<GetRevisionsResponse<GetRevisionChangesResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<GetRevisionsResult><GetRevisionChangesResult>
<Revision><ElementChange>
<CommitTime>2015-02-21T22:07:36.857</CommitTime><Type>Create</Type>
<RevisionId>147513d0-558e-4562-8281-595a6471d1aa</RevisionId><CurrentKey>
<Message>created new entity</Message><ModuleElement>
<Committer>admin</Committer>
<Project Name="TestProject"/>
<Branch>Trunk</Branch>
<Module <ParentRevisionIds>b1372603-4705-4728-8ef4-198477f97e6e</ParentRevisionIds>Name="TestModule" ModuleType="Interaction"/>
<Tags>tag1</Tags>
<Key Name="Address" ModuleElementType="Entity"/>
</Revision>
<Revision></ModuleElement>
<CommitTime>2015-02-17T15:05:14.213</CommitTime>
</CurrentKey>
<Authors>admin</Authors> <RevisionId>b1372603<!-4705-4728-8ef4-198477f97e6e</RevisionId>- Since Blueriq 15.13 -->
<Message>initial commit in Trunk</Message>
<Authors>ci</Authors> <!-- Since Blueriq 15.13 -->
</ElementChange>
<Committer>admin</Committer><ElementChange>
<Branch>Trunk<<Type>Create</Branch>Type>
<ParentRevisionIds>7371efb5-be0d-43fb-ba54-287836daedd6</ParentRevisionIds><CurrentKey>
</Revision>
<ModuleElement>
<Revision>
<CommitTime>2015-02-13T13:14:39.353</CommitTime>
<Project Name="TestProject"/>
<RevisionId>7371efb5-be0d-43fb-ba54-287836daedd6</RevisionId> <Module Name="TestModule" ModuleType="Interaction"/>
<Message>Branch created</Message>
<Key xsi:type="AttributeKey" Name="Street" ModuleElementType="Attribute">
<Committer>admin</Committer>
<Entity xmlns="">Address</Entity>
<Branch>Trunk< </Branch>Key>
</Revision>ModuleElement>
</GetRevisionsResult>CurrentKey>
</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
Parameters:
- 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, required; a negative amount includes all revisions
- taggedOnly : boolean flag indicating whether to include only tagged revisions, required
- level : the level of merge revision to include, required; a negative amount includes all levels 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).
| Expand |
|---|
|
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:GetRevisionsWithLeveledMergeRevisions>
<Authors>admin</Authors> <!-- Since Blueriq 15.13 -->
</ElementChange>
<ElementChange>
<Type>Create</Type>
<CurrentKey>
<ModuleElement>
<Project Name="TestProject"/>
<Module Name="TestModule" ModuleType="Interaction"/>
<Key <ns:repository>TestRepository</ns:repository>xsi:type="RelationKey" Name="hasAddress" ModuleElementType="Relation">
<ns:branch>Trunk</ns:branch>
<ns:startIndex>0</ns:startIndex>
<Entity xmlns="">Person</Entity>
<ns:amount>10</ns:amount>
<ns:taggedOnly>false</ns:taggedOnly></Key>
<ns:level>1</ns:level>
</ns:GetRevisionsWithLeveledMergeRevisions>ModuleElement>
</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">
<GetRevisionsWithLeveledMergeRevisionsResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<GetRevisionsWithLeveledMergeRevisionsResult>CurrentKey>
<Authors>admin</Authors> <!-- Since Blueriq 15.13 -->
</ElementChange>
<Revision></GetRevisionChangesResult>
</GetRevisionChangesResponse>
<CommitTime>2016-11-29T13:30:18.277</CommitTime>
<RevisionId>99a878f4-5338-4910-974c-b5749303f7fe</RevisionId></s:Body>
</s:Envelope> |
|
GetRevisionDescriptor
GetRevisions
Returns a list of revisions in a specified repository and branch.
| Expand |
|---|
|
| 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 |
|
| 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>
<Message>update from A B C</Message> <ns:branch>Trunk</ns:branch>
<ns:startIndex>0</ns:startIndex>
<Committer>admin</Committer>
<ns:amount>-1</ns:amount>
<Branch>Trunk</Branch><ns:taggedOnly>false</ns:taggedOnly>
<ns:includeMergeRevisions>true</ns:includeMergeRevisions>
<ParentRevisionIds>64bac7d9-7140-4669-b3de-a8f0c98db5cf</ParentRevisionIds></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"> <ParentRevisionIds>6fd443ee-9a20-431f-8d91-b7b1a85bc217</ParentRevisionIds>
<GetRevisionsResult>
<MergeRevisions>
<Revision>
<CommitTime>2016<CommitTime>2015-1102-29T1321T22:2807:4236.4<857</CommitTime>
<RevisionId>6fd443ee-9a20-431f-8d91-b7b1a85bc217<<RevisionId>147513d0-558e-4562-8281-595a6471d1aa</RevisionId>
<Message>created <Message>update from Team b & C<new entity</Message>
<Committer>admin</Committer>
<Branch>TeamA<<Branch>Trunk</Branch>
<ParentRevisionIds>300c5d5c-08a5-4184-8c47-db7eb2aa1466<<ParentRevisionIds>b1372603-4705-4728-8ef4-198477f97e6e</ParentRevisionIds>
<<Tags>tag1</MergeRevisions>Tags>
</Revision>
<MergeRevisions>
<Revision>
<CommitTime>2016 <CommitTime>2015-1102-28T1717T15:3905:0114.007<213</CommitTime>
<RevisionId>300c5d5c-08a5-4184-8c47-db7eb2aa1466<<RevisionId>b1372603-4705-4728-8ef4-198477f97e6e</RevisionId>
<Message>initial commit <Message>update fromin Trunk</Message>
<Committer>admin</Committer>
<Branch>TeamA<<Branch>Trunk</Branch>
<ParentRevisionIds>c00795a2-2c4d-4d12-be7d-35e3ea8d636d<<ParentRevisionIds>7371efb5-be0d-43fb-ba54-287836daedd6</ParentRevisionIds>
</MergeRevisions>Revision>
</Revision><Revision>
<Revision> <CommitTime>2015-02-13T13:14:39.353</CommitTime>
<CommitTime>2016<RevisionId>7371efb5-11-28T17:38:00.823</CommitTime>
<RevisionId>64bac7d9-7140-4669-b3de-a8f0c98db5cf<be0d-43fb-ba54-287836daedd6</RevisionId>
<Message>create entity C on Trunk<<Message>Branch created</Message>
<Committer>admin</Committer>
<Branch>Trunk</Branch>
<ParentRevisionIds>6f8c6390-dcb2-402d-b6bb-dc33bcdfce42</ParentRevisionIds>
</Revision>
</Revision>GetRevisionsResult>
<Revision>
<CommitTime>2016-11-28T17:37:39.927</CommitTime></GetRevisionsResponse>
<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>
</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).
| Expand |
|---|
|
| 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 |
|
| 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>
<MergeRevisions><ns:branch>Trunk</ns:branch>
<ns:startIndex>0</ns:startIndex>
<CommitTime>2016-11-28T17:36:44.877</CommitTime><ns:amount>10</ns:amount>
<ns:taggedOnly>false</ns:taggedOnly>
<RevisionId>c00795a2-2c4d-4d12-be7d-35e3ea8d636d</RevisionId><ns:level>1</ns:level>
</ns:GetRevisionsWithLeveledMergeRevisions>
</soapenv:Body>
</soapenv:Envelope> |
| Code Block |
|---|
| <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <Message>commit on TeamA branch</Message>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Committer>admin</Committer><GetRevisionsWithLeveledMergeRevisionsResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<GetRevisionsWithLeveledMergeRevisionsResult>
<Branch>TeamA</Branch>
<Revision>
<ParentRevisionIds>311d5dd3<CommitTime>2016-8931-4e5c-99e5-0b3f22c47571</ParentRevisionIds>11-29T13:30:18.277</CommitTime>
</MergeRevisions><RevisionId>99a878f4-5338-4910-974c-b5749303f7fe</RevisionId>
</Revision>
<Message>update from A <Revision>B C</Message>
<CommitTime>2016-11-28T17:09:25.783</CommitTime><Committer>admin</Committer>
<RevisionId>311d5dd3-8931-4e5c-99e5-0b3f22c47571</RevisionId><Branch>Trunk</Branch>
<Message>initial commit on Trunk</Message><ParentRevisionIds>64bac7d9-7140-4669-b3de-a8f0c98db5cf</ParentRevisionIds>
<Committer>admin</Committer><ParentRevisionIds>6fd443ee-9a20-431f-8d91-b7b1a85bc217</ParentRevisionIds>
<Branch>Trunk</Branch><MergeRevisions>
<ParentRevisionIds>f9db26db-ca13-4154-a8dc-2c05fa81eda1</ParentRevisionIds> <CommitTime>2016-11-29T13:28:42.4</CommitTime>
</Revision>
<RevisionId>6fd443ee-9a20-431f-8d91-b7b1a85bc217</RevisionId>
<Revision>
<Message>update from <CommitTime>2016-11-28T17:08:58.74</CommitTime>
Team b & C</Message>
<RevisionId>f9db26db-ca13-4154-a8dc-2c05fa81eda1</RevisionId> <Committer>admin</Committer>
<Message>Created repository<<Branch>TeamA</Message>Branch>
<Committer>admin</Committer><ParentRevisionIds>300c5d5c-08a5-4184-8c47-db7eb2aa1466</ParentRevisionIds>
<Branch>Trunk<</Branch>MergeRevisions>
</Revision> <MergeRevisions>
</GetRevisionsWithLeveledMergeRevisionsResult>
</GetRevisionsWithLeveledMergeRevisionsResponse>
</s:Body>
</s:Envelope> |
|
MergeBranch
MergeRevision
SetTags
UpdateRepository
UpdateBranch
UpdateBranchType
Other Methods
ApplyOperation
EvaluateExpression
GetCurrentIdentity
GetDataSource
GetLicenseData
GetStatus
GetStatusMaxDepth
HasModuleWriteAccess
IsInRole
Logout
RetrieveLog
RetrieveServerInformation
RetrieveSubscriptionStatus
SendMessage
SetDataSource
ValidateProject
GetStatusMaxDepth
Returns a list of revisions which are the pending revisions to be commited(accepted in the branch). Same as GetStatus
- repository : the repository to search in, required
- branch : the branch to search in, required
- maxMergedRevisionsDepth : the maximum depth which is search is the revision tree
The maxMergedRevisionsDepth service was added because the GetStatus service retrieved HUGE amount of data which was mostly repetitive in very big pending revisions structures. Suggested maxMergedRevisionsDepth values :5-10
| Expand |
|---|
|
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>
<CommitTime>2016-11-28T17:39:01.007</CommitTime>
<RevisionId>300c5d5c-08a5-4184-8c47-db7eb2aa1466</RevisionId>
<Message>update from Trunk</Message>
<Committer>admin</Committer>
<ns:GetStatusMaxDepth>
<Branch>TeamA</Branch>
<ns:repository>FunStuff</ns:repository>
<ns:branch>branch9</ns:branch><ParentRevisionIds>c00795a2-2c4d-4d12-be7d-35e3ea8d636d</ParentRevisionIds>
<ns:maxMergedRevisionsDepth>3</ns:maxMergedRevisionsDepth>
</MergeRevisions>
</ns:GetStatusMaxDepth>Revision>
</x:Body>
</x:Envelope> |
Response: | Code Block |
|---|
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <Revision>
<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">
<CommitTime>2016-11-28T17:38:00.823</CommitTime>
<GetStatusMaxDepthResult>
<TipRevision>2538eada-bb93-46a7-948c-c9e9f7f68cc1</TipRevision><RevisionId>64bac7d9-7140-4669-b3de-a8f0c98db5cf</RevisionId>
<WorkingRevision>cbde6cb1-b3ff-44b0-91b2-73afbeee423b</WorkingRevision><Message>create entity C on Trunk</Message>
<Commitable>true</Commitable><Committer>admin</Committer>
<Branch>Trunk</Branch>
<Changes><ParentRevisionIds>6f8c6390-dcb2-402d-b6bb-dc33bcdfce42</ParentRevisionIds>
</Revision>
<Type>Create</Type>
<Revision>
<CurrentKey><CommitTime>2016-11-28T17:37:39.927</CommitTime>
<RevisionId>6f8c6390-dcb2-402d-b6bb-dc33bcdfce42</RevisionId>
<Project>
<Message>merge with teamA</Message>
<Committer>admin</Committer>
<Key>branch4project</Key>
<Branch>Trunk</Branch>
</Project><ParentRevisionIds>311d5dd3-8931-4e5c-99e5-0b3f22c47571</ParentRevisionIds>
</CurrentKey><ParentRevisionIds>c00795a2-2c4d-4d12-be7d-35e3ea8d636d</ParentRevisionIds>
</Changes><MergeRevisions>
<Changes>
<CommitTime>2016-11-28T17:36:44.877</CommitTime>
<Type>Create</Type>
<RevisionId>c00795a2-2c4d-4d12-be7d-35e3ea8d636d</RevisionId>
<Message>commit on TeamA <CurrentKey>branch</Message>
<Committer>admin</Committer>
<Project>
<Branch>TeamA</Branch>
<Key>brnach3project</Key>
<ParentRevisionIds>311d5dd3-8931-4e5c-99e5-0b3f22c47571</ParentRevisionIds>
</MergeRevisions>
</Project>Revision>
</CurrentKey><Revision>
</Changes><CommitTime>2016-11-28T17:09:25.783</CommitTime>
<Changes><RevisionId>311d5dd3-8931-4e5c-99e5-0b3f22c47571</RevisionId>
<Message>initial commit on <Type>Create<Trunk</Type>Message>
<CurrentKey><Committer>admin</Committer>
<Project><Branch>Trunk</Branch>
<ParentRevisionIds>f9db26db-ca13-4154-a8dc-2c05fa81eda1</ParentRevisionIds>
<Key>branch2Project<</Key>Revision>
</Project><Revision>
</CurrentKey><CommitTime>2016-11-28T17:08:58.74</CommitTime>
</Changes><RevisionId>f9db26db-ca13-4154-a8dc-2c05fa81eda1</RevisionId>
<Message>Created <MergeRevisions>repository</Message>
<CommitTime>2017-03-15T13:56:23.793</CommitTime><Committer>admin</Committer>
<RevisionId>9796f7eb-060e-42dd-bef2-927078e94609</RevisionId><Branch>Trunk</Branch>
<Message>aaa</Message></Revision>
</GetRevisionsWithLeveledMergeRevisionsResult>
</GetRevisionsWithLeveledMergeRevisionsResponse>
<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></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.
| Expand |
|---|
|
| 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).
| 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>
<Committer>admin</Committer><ns:operations>
<ns:Operations>
<Branch>Branch5</Branch><ns:OperationEntry>
<ns:ModuleElementOperation Type="Create" GenerateLayout="false">
<ParentRevisionIds>8b6fb392-bb40-4274-b8f8-635f6049fdf7</ParentRevisionIds>
<ns:Project>ExampleProject</ns:Project>
<ParentRevisionIds>4c57d9c4-8a4c-4a84-a535-c5b5cdb926f0</ParentRevisionIds>
<ns:Module Name="MainModule" ModuleType="Interaction"/>
</MergeRevisions>
<ns:OriginalKey xsi:type="ns:AttributeKey" Entity="MyEntity" Name="MyAttribute" ModuleElementType="Attribute"/>
</MergeRevisions>
</MergeRevisions><ns:ModuleElement xsi:type="ns:Attribute"
<MergeRevisions>
Entity="MyEntity" Name="MyAttribute"
<CommitTime>2017-03-15T13:55:53.077</CommitTime>
DataType="String" MultiValued="false" Askable="false"
<RevisionId>55a73f9d-3b31-4852-bcc0-08558bb1ed62</RevisionId>
<Message>a44</Message>ActsAsReference="false"></ns:ModuleElement>
<Committer>admin</Committer></ns:ModuleElementOperation>
<Branch>branch6</Branch></ns:OperationEntry>
</ns:Operations>
<ParentRevisionIds>ac9ce6f0-d814-4a69-b0cc-5205509d4a65</ParentRevisionIds> </ns:operations>
</ns:ApplyOperations>
</soapenv:Body>
</soapenv:Envelope> |
| Code Block |
|---|
| <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body <ParentRevisionIds>abeedd37-9c04-4783-8850-1dd2f1ded126</ParentRevisionIds>xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApplyOperationsResponse <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>
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 |
|---|
|
| Parameter | Parameter description | Required/optional |
|---|
| repository | the repository to search in | required | | branch | the branch to search in | required |
|
| 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>
<ParentRevisionIds>f81a0556-3891-49f4-ade8-3d6abe3dcbfe</ParentRevisionIds><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/">
<ParentRevisionIds>4c57d9c4-8a4c-4a84-a535-c5b5cdb926f0</ParentRevisionIds>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<MergeRevisions><GetStatusResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<GetStatusResult>
<CommitTime>2017-03-15T13:45:16.333</CommitTime><TipRevision>2538eada-bb93-46a7-948c-c9e9f7f68cc1</TipRevision>
<Commitable>true</Commitable>
<RevisionId>4c57d9c4-8a4c-4a84-a535-c5b5cdb926f0</RevisionId>
<Changes>
<Message>merge</Message><Type>Create</Type>
<Committer>admin</Committer><CurrentKey>
<Branch>Trunk</Branch><Project>
<ParentRevisionIds>d137f43d-fce9-4d08-8f51-aca31e7dc720</ParentRevisionIds><Key>branch4project</Key>
<ParentRevisionIds>17d4af9d-bce7-4ca2-a35d-bf48a88644ec</ParentRevisionIds></Project>
</MergeRevisions>CurrentKey>
<Authors>admin</Authors> <!-- Since Blueriq <MergeRevisions>
15.13 -->
<Authors>ci</Authors> <!-- Since Blueriq 15.13 <CommitTime>2017-03-15T13:44:44.5</CommitTime>->
</Changes>
<RevisionId>d137f43d-fce9-4d08-8f51-aca31e7dc720</RevisionId>
<Changes>
<Message>merge<<Type>Create</Message>Type>
<Committer>admin</Committer><CurrentKey>
<Branch>Trunk</Branch><Project>
<ParentRevisionIds>8b6fb392-bb40-4274-b8f8-635f6049fdf7</ParentRevisionIds><Key>brnach3project</Key>
<ParentRevisionIds>233e802d-7392-459e-a5a4-32baf676c344</ParentRevisionIds>
</Project>
</MergeRevisions>CurrentKey>
<Authors>admin</Authors> <!-- Since <MergeRevisions>Blueriq 15.13 -->
</Changes>
<CommitTime>2017-03-15T13:43:40.307</CommitTime>
<Changes>
<Type>Create</Type>
<RevisionId>8b6fb392-bb40-4274-b8f8-635f6049fdf7</RevisionId>
<CurrentKey>
<Message>mergeIntoMaster</Message><Project>
<Committer>admin<<Key>branch2Project</Committer>Key>
</Project>
<Branch>Trunk</Branch>
</CurrentKey>
<ParentRevisionIds>53ec7bf3-0d47-4763-9f9d-d7e733f5c802</ParentRevisionIds>
<Authors>admin</Authors> <!-- Since Blueriq 15.13 -->
</Changes>
<ParentRevisionIds>5fe5fd12-4610-422c-9496-e18130dc822b</ParentRevisionIds>
<MergeRevisions>
</MergeRevisions><CommitTime>2017-03-15T13:56:23.793</CommitTime>
<RevisionId>9796f7eb-060e-42dd-bef2-927078e94609</RevisionId>
<MergeRevisions>
<Message>aaa</Message>
<CommitTime>2017-03-15T13:37:29.477</CommitTime>
<Committer>admin</Committer>
<RevisionId>53ec7bf3<Parent>55a73f9d-0d473b31-47634852-9f9dbcc0-d7e733f5c802<08558bb1ed62</RevisionId>Parent>
<MergeParent>014c231e-9381-47f5-96b8-8a2692ad9b54</MergeParent>
<Message>a1</Message>
</MergeRevisions>
<MergeRevisions>
<Committer>admin</Committer>
<CommitTime>2017-03-15T13:55:53.077</CommitTime>
<Branch>Trunk</Branch>
<RevisionId>55a73f9d-3b31-4852-bcc0-08558bb1ed62</RevisionId>
<ParentRevisionIds>2538eada-bb93-46a7-948c-c9e9f7f68cc1</ParentRevisionIds><Message>a44</Message>
</MergeRevisions><Committer>admin</Committer>
</MergeRevisions><Parent>ac9ce6f0-d814-4a69-b0cc-5205509d4a65</Parent>
</MergeRevisions>
</GetStatusMaxDepthResult>GetStatusResult>
</GetStatusMaxDepthResponse>GetStatusResponse>
</s:Body>
</s:Envelope>: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 :
...
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 .
Parameters :
...
| Expand |
|---|
|
| Parameter | Parameter description | Required/optional |
|---|
| ElementName | name of the element to be searched |
|
...
...
...
| 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 |
|
...
...
...
| 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 |
|
...
...
...
| parameter of type int, indicating the level of dependencies on which to search |
|
...
| optional, default value = 5 |
|
...
...
| 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 |
| Info |
|---|
For more details about how the input parameters influence the search result, see the Reponse Example of the GetAdvancedSearchResults method. |
|
Output :
- SearchID : GUID associated with the newly started search
...
| Expand |
|---|
|
| Start Advanced Search | Example |
| collapse | true |
|---|
<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 example :
| Start Advanced Search | 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 the Studio server. If the provided search id does not exist anymore, an error will be returned.
Parameters :
...
.
| Expand |
|---|
|
| Parameter | Parameter description | Required/optional |
|---|
| SearchId | the GUID obtained after calling the StartAdvancedSearch method |
|
...
| Expand |
|---|
|
| Stop Advanced Search | Example |
| collapse | true |
|---|
<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 example :
| Stop Advanced Search 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">
<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.
Parameters :
...
| Expand |
|---|
|
| Parameter | Parameter description | Required/optional |
|---|
| SearchId | the GUID obtained after calling the StartAdvancedSearch method |
|
...
...
|
| Get Advanced Search Results Example | collapse | true | <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 example :
| Get Advanced Search Results 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">
<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 |
|
...
...
|
|
| collapse | true |
|---|
| GetLibraries 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:GetLibraries>
<!--Optional:-->
<ns:repository>Repository2</ns:repository>
<!--Optional:-->
<ns:branch>Trunk</ns:branch>
</ns:GetLibraries>
</soapenv:Body>
</soapenv:Envelope> |
|
...
| GetLibraries 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">
<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> |
|
|---|