Page History
...
| Expand | ||||
|---|---|---|---|---|
| ||||
Request:
Response:
|
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.
...
| Expand | ||||
|---|---|---|---|---|
| ||||
Request:
Response:
|
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 :
| Code Block | ||||
|---|---|---|---|---|
| ||||
<!--Advanced Search Configuration-->
<advancedsearch timeout-in-minutes="30"/> |
If no interaction occurs with a started search entry (e.g. results are not pulled via the GetAdvancedSearchResults method) for the configured timeout, the search is stopped and results are removed.
StartAdvancedSearch
This method starts a new search according to the input parameters and returns a GUID that can be further used to get the results or stop the search.
Parameters :
- ElementName : name of the element to be searched (required)
- ElementTypes : array of element types that can be searched. Currently, the following global or module element types are supported : Container, Attribute, Presentation Style, Content Style, Text Item, Service Call, Flow (optional)
- IsInExposedFlow : boolean indicating whether the search should return information about elements in exposed flows (required).
- 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.
- true : the advanced search will check if the searched element is reachable through an exposed flow and will return the information accordingly in the
- IsSpecialized : boolean indicating whether the search should return information about specialized elements (required).
- 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.
- true : the advanced search will check if the search element is specialized and return the information accordingly in the
- FullText : boolean indicating whether full-text search is enabled (optional).
- SearchDepth : parameter of type int, indicating the level of dependencies on which to search (optional, default value = 5)
- SearchIn : Array of objects composed of the name of the repository, branch and project which specifies the search location (optional)
- Valid combinations are : repository + branch + project , repository + branch , repository
- Invalid combinations are ignored (search is done in all repositories, branches, projects)
| 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
Request example :
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<soapenv:Header/>
<soapenv:Body>
<ns:StartAdvancedSearch>
<ns:parameters>
<ns:ElementName>Age</ns:ElementName>
<ns:ElementTypes>Attribute</ns:ElementTypes>
<ns:IsInExposedFlow>true</ns:IsInExposedFlow>
<ns:IsSpecialized>false</ns:IsSpecialized>
<ns:IsFullTextEnabled>false</ns:IsFullTextEnabled>
<ns:SearchDepth>5</ns:SearchDepth>
<ns:SearchIn>
<ns:Repository>CoffeeAdvisor</ns:Repository>
<ns:Branch>Trunk</ns:Branch>
<ns:Project>CoffeeAdvisor</ns:Project>
</ns:SearchIn>
</ns:parameters>
</ns:StartAdvancedSearch>
</soapenv:Body>
</soapenv:Envelope> |
Response example :
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<StartAdvancedSearchResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<StartAdvancedSearchResult>
<SearchId>72852a96-3bea-4786-a2d5-17d98bd8d430</SearchId>
</StartAdvancedSearchResult>
</StartAdvancedSearchResponse>
</s:Body>
</s:Envelope> |
StopAdvancedSearch
This method stops the search for the specified Search Id, and also clears the results that are stored in the search cache in Studio. If the provided search id does not exist anymore, an error will be returned.
Parameters :
- SearchId : the GUID obtained after calling the StartAdvancedSearch method
Request example :
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<soapenv:Header/>
<soapenv:Body>
<ns:StopAdvancedSearch>
<!--Optional:-->
<ns:searchId>
<!--Optional:-->
<ns:SearchId>304254f5-76fc-4bf5-b806-6bce78533a64</ns:SearchId>
</ns:searchId>
</ns:StopAdvancedSearch>
</soapenv:Body>
</soapenv:Envelope> |
Response example :
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<StopAdvancedSearchResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0"/>
</s:Body>
</s:Envelope> |
GetAdvancedSearchResults
This method returns the results associated with the input search id. The results could be partial or complete. The state of the search is indicated by the "IsSearchFinished" parameter.
Parameters :
- SearchId : the GUID obtained after calling the StartAdvancedSearch method
Request example :
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<soapenv:Header/>
<soapenv:Body>
<ns:GetAdvancedSearchResults>
<!--Optional:-->
<ns:searchId>
<!--Optional:-->
<ns:SearchId>304254f5-76fc-4bf5-b806-6bce78533a64</ns:SearchId>
</ns:searchId>
</ns:GetAdvancedSearchResults>
</soapenv:Body>
</soapenv:Envelope> |
Response example :
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<GetAdvancedSearchResultsResponse xmlns="http://www.everest.nl/aquima/studio/ManagementService/1.0">
<GetAdvancedSearchResultsResult>
<ResultEntries>
<ResultEntry>
<Repository>CoffeeAdvisor</Repository>
<Branch>Trunk</Branch>
<Project>CoffeeAdvisor</Project>
<Elements>
<ElementDetails>
<ElementName>Age</ElementName>
<ElementType>Attribute</ElementType>
<Module>CoffeeAdvisor</Module>
<IsInExposedFlow>true</IsInExposedFlow>
<IsSpecialized>null</IsSpecialized>
</ElementDetails>
</Elements>
</ResultEntry>
</ResultEntries>
<IsSearchFinished>true</IsSearchFinished>
</GetAdvancedSearchResultsResult>
</GetAdvancedSearchResultsResponse>
</s:Body>
</s:Envelope> |
GetLibraries
This method returns libraries that are present in a branch.
Parameters :
- repository : string parameter representing the name of the repository where the search is made
- branch : string parameter representing the name of the branch where the search is made
Request example :
| 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:GetLibraries>
<!--Optional:-->
<ns:repository>Repository2</ns:repository>
<!--Optional:-->
<ns:branch>Trunk</ns:branch>
</ns:GetLibraries>
</soapenv:Body>
</soapenv:Envelope> |
Reponse example :
| 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">
<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> |
Overview
Content Tools