...
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 of how to configure this in SOAPUI:
We distinguish different categories of methods:
...
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">
<GetUsedByElementsForModuleElement xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<repository>TestRepository</repository>
<branch>Trunk</branch>
<project>TestProject</project>
<module Name="main" ModuleType="Interaction"/>
<moduleElement xsi:type="AttributeKey" Name="test" ModuleElementType="Attribute">
<Entity xmlns="">test</Entity>
</moduleElement>
</GetUsedByElementsForModuleElement>
</s:Body>
</s:Envelope> |
Response Code Block |
---|
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<GetUsedByElementsForModuleElementResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<GetUsedByElementsForModuleElementResult>
<Dependency>
<ReferenceType>Usage</ReferenceType>
<From>
<ModuleElement>
<Project Name="TestProject"/>
<Module Name="main" ModuleType="Interaction"/>
<Key Name="testpage" ModuleElementType="Page"/>
</ModuleElement>
</From>
<To>
<ModuleElement>
<Project Name="TestProject"/>
<Module Name="main" ModuleType="Interaction"/>
<Key xsi:type="AttributeKey" Name="test" ModuleElementType="Attribute">
<Entity xmlns="">test</Entity>
</Key>
</ModuleElement>
</To>
</Dependency>
<Dependency>
<ReferenceType>Usage</ReferenceType>
<From>
<ModuleElement>
<Project Name="TestProject"/>
<Module Name="main" ModuleType="Interaction"/>
<Key Name="testcontainer" ModuleElementType="Container"/>
</ModuleElement>
</From>
<To>
<ModuleElement>
<Project Name="TestProject"/>
<Module Name="main" ModuleType="Interaction"/>
<Key xsi:type="AttributeKey" Name="test" ModuleElementType="Attribute">
<Entity xmlns="">test</Entity>
</Key>
</ModuleElement>
</To>
</Dependency>
</GetUsedByElementsForModuleElementResult>
</GetUsedByElementsForModuleElementResponse>
</s:Body>
</s:Envelope> |
Response:
|
Something to consider
If you use inheritance between modules, and specialization of elements, elements and dependencies you are looking for may react differently than expected.
...
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</ns:repository>
<ns:branch>Trunk</ns:branch>
<ns:project>Main_Dashboard</ns:project>
<ns:globalElement Name="MyContentStyle" GlobalElementType="ContentStyle"/>
</ns:GetUseElementsForGlobalElement>
</soapenv:Body>
</soapenv:Envelope> |
Example Response Message Code Block |
---|
language | xml |
---|
title | Example Response |
---|
| <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<GetUseElementsForGlobalElementResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<GetUseElementsForGlobalElementResult>
<Dependency>
<ReferenceType>Usage</ReferenceType>
<From>
<Global>
<Project Name="Main_Dashboard"/>
<Key Name="MyContentStyle" GlobalElementType="ContentStyle"/>
</Global>
</From>
<To>
<Global>
<Project Name="AquimaTheme"/>
<Key Name="Anchor" GlobalElementType="ContentStyle"/>
</Global>
</To>
</Dependency>
</GetUseElementsForGlobalElementResult>
</GetUseElementsForGlobalElementResponse>
</s:Body>
</s:Envelope> |
|
GetUseElementsForModuleElement
...
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:ExportProject>
<ns:repository>TestRepository</ns:repository>
<ns:branch>Trunk</ns:branch>
<ns:project>TestProject</ns:project>
<ns:encrypt>false</ns:encrypt>
</ns:ExportProject>
</soapenv:Body>
</soapenv:Envelope> |
Response: Code Block |
---|
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ExportProjectResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<ExportProjectResult ContentType="application/zip">
<Content>UEsDBBQACAA ... CxJwAAAAA=</Content>
</ExportProjectResult>
</ExportProjectResponse>
</s:Body>
</s:Envelope> |
|
...
ExportProjectRevision
Exports a project at a specific revision
...
Expand |
---|
|
Request: Code Block |
---|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<soapenv:Header/>
<soapenv:Body>
<ns:ExportProjectRevision>
<ns:repository>TestRepository</ns:repository>
<ns:branch>Trunk</ns:branch>
<ns:revisionId>b1372603-4705-4728-8ef4-198477f97e6e</ns:revisionId>
<ns:project>TestProject</ns:project>
<ns:encrypt>false</ns:encrypt>
</ns:ExportProjectRevision>
</soapenv:Body>
</soapenv:Envelope> |
Response: Code Block |
---|
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ExportProjectRevisionResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ExportProjectRevisionResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<ExportProjectRevisionResult ContentType="application/zip">
<Content>UEsDBBQ ... CeIQAAAAA=</Content>
</ExportProjectRevisionResult>
</ExportProjectRevisionResponse>
</s:Body>
</s:Envelope> |
|
Elements
FindGlobalElementProject
FindglobalElements
FindModuleElement
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 module element 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 the same entity. 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.
Expand |
---|
Request: Code Block |
---|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<soapenv:Header/>
<soapenv:Body>
<ns:GetModuleElement>
<ns:repository>TestRepository</ns:repository>
<ns:branch>Trunk</ns:branch>
<ns:project>TestProject</ns:project>
<ns:module Name="Main" ModuleType="Interaction"/>
<ns:moduleElement xsi:type="ns:AttributeKey" Name="DateOfBirth" ModuleElementType="Attribute">
<Entity>Person</Entity>
</ns:moduleElement>
</ns:GetModuleElement>
</soapenv:Body>
</soapenv:Envelope> |
Response: Code Block |
---|
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<GetModuleElementResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<GetModuleElementResult xsi:type="Attribute" Name="DateOfBirth" Entity="Person" DataType="Date" MultiValued="false" Askable="true" ActsAsReference="false">
<Comments xmlns=""/>
<Tags xmlns="">
<Tag>
<Name>Person</Name>
</Tag>
</Tags>
<QuestionText xmlns="">
<Text Language="dutch">
<Value>Date of Birth</Value>
</Text>
</QuestionText>
<ExportProjectRevisionResult ContentType="application/zip" <ExplainText xmlns=""/>
<Content>UEsDBBQ ... CeIQAAAAA=</Content><ValidationRules xmlns=""/>
</ExportProjectRevisionResult>GetModuleElementResult>
</ExportProjectRevisionResponse>GetModuleElementResponse>
</s:Body>
</s:Envelope> |
|
Elements
FindGlobalElementProject
FindglobalElements
FindModuleElement
GetAllGlobalElements
GetAllModuleElements
GetGlobalElement
GetGlobalElements
GetModuleElement
GetModuleElements
Parameters
...
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:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<soapenv:Header/>
<soapenv:Body>
<ns:GetModuleElements>
<ns:repository>TestRepository</ns:repository>
<ns:branch>Trunk</ns:branch>
<ns:project>TestProject</ns:project>
<ns:module Name="main" ModuleType="Interaction"/>
<ns:elementType>Attribute</ns:elementType>
</ns:GetModuleElements>
</soapenv:Body>
</soapenv:Envelope> |
Response: 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
...
- at least one of
IncludeGlobalElements
or IncludeModuleElements
should be true
- at least one of
SearchInNames
, SearchInDependencies
or FullText
should be 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:Search>
<ns:parameters>
<ns:SearchType>ModuleScope</ns:SearchType>
<ns:Repository>HospitalDCM</ns:Repository>
<ns:Branch>Trunk</ns:Branch>
<ns:Project>HospitalDCM</ns:Project>
<ns:Module Name="Dashboard" ModuleType="Interaction"/>
<ns:SearchString>Menu</ns:SearchString>
<ns:SearchInNames>1</ns:SearchInNames>
<ns:SearchInDependencies>0</ns:SearchInDependencies>
<ns:IncludeGlobalElements>0</ns:IncludeGlobalElements>
<ns:IncludeModuleElements>1</ns:IncludeModuleElements>
<ns:FullText>0</ns:FullText>
<ns:CaseSensitive>0</ns:CaseSensitive>
</ns:parameters>
</ns:Search>
</soapenv:Body>
</soapenv:Envelope> |
Response: Code Block |
---|
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SearchResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<SearchResult>
<SearchResultItem xsi:type="ElementSearchResultItem">
<Element>
<ModuleElement>
<Project Name="HospitalDCM"/>
<Module Name="Dashboard" ModuleType="Interaction"/>
<Key Name="MenuBar" ModuleElementType="Container"/>
</ModuleElement>
</Element>
</SearchResultItem>
<SearchResultItem xsi:type="ElementSearchResultItem">
<Element>
<ModuleElement>
<Project Name="HospitalDCM"/>
<Module Name="Dashboard" ModuleType="Interaction"/>
<Key Name="Dashboard_Menu" ModuleElementType="Container"/>
</ModuleElement>
</Element>
</SearchResultItem>
<SearchResultItem xsi:type="ElementSearchResultItem">
<Element>
<ModuleElement>
<Project Name="HospitalDCM"/>
<Module Name="Dashboard" ModuleType="Interaction"/>
<Key Name="DashboardMenu" ModuleElementType="FlowEvent"/>
</ModuleElement>
</Element>
</SearchResultItem>
</SearchResult>
</SearchResponse>
</s:Body>
</s:Envelope> |
|
...
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:GetRevisionChanges>
<!--Optional:-->
<ns:repository>TestRepository</ns:repository>
<!--Optional:-->
<ns:branch>Trunk</ns:branch>
<!--Optional:-->
<ns:revision>eadcb8e1-c306-4ea0-a983-162afa863473</ns:revision>
</ns:GetRevisionChanges>
</soapenv:Body>
</soapenv:Envelope> |
Response: Code Block |
---|
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<GetRevisionChangesResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<GetRevisionChangesResult>
<ElementChange>
<Type>Create</Type>
<CurrentKey>
<ModuleElement>
<Project Name="TestProject"/>
<Module Name="TestModule" ModuleType="Interaction"/>
<Key Name="Address" ModuleElementType="Entity"/>
</ModuleElement>
</CurrentKey>
</ElementChange>
<ElementChange>
<Type>Create</Type>
<CurrentKey>
<ModuleElement>
<Project Name="TestProject"/>
<Module Name="TestModule" ModuleType="Interaction"/>
<Key xsi:type="AttributeKey" Name="Street" ModuleElementType="Attribute">
<Entity xmlns="">Address</Entity>
</Key>
</ModuleElement>
</CurrentKey>
</ElementChange>
<ElementChange>
<Type>Create</Type>
<CurrentKey>
<ModuleElement>
<Project Name="TestProject"/>
<Module Name="TestModule" ModuleType="Interaction"/>
<Key xsi:type="RelationKey" Name="hasAddress" ModuleElementType="Relation">
<Entity xmlns="">Person</Entity>
</Key>
</ModuleElement>
</CurrentKey>
</ElementChange>
</GetRevisionChangesResult>
</GetRevisionChangesResponse>
</s:Body>
</s:Envelope> |
|
...
GetRevisionDescriptor
GetRevisions
...
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>
<ns:repository>TestRepository</ns:repository>
<ns:branch>Trunk</ns:branch>
<ns:startIndex>0</ns:startIndex>
<ns:amount>10</ns:amount>
<ns:taggedOnly>false</ns:taggedOnly>
<ns:level>1</ns:level>
</ns:GetRevisionsWithLeveledMergeRevisions>
</soapenv:Body>
</soapenv:Envelope> |
Response: 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
...
SetDataSource
ValidateProject
GetStatusMaxDepth
Returns a list of revisions which are the pending revisions to be commited(accepted in the branch). Same as GetStatus
...