Versions Compared

Old Version 22

changes.mady.by.user Tijmen Daatselaar

Saved on

compared with

New Version Current

changes.mady.by.user Tijmen Daatselaar

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

...

For authentication, you have to send your credentials with each request to the management service . How these credentials are sent to the management service depends on the configuration of the Blueriq Studio installation, but Basic authentication is used by defaultusing Basic authentication.

Expand
titleExample of how to configure authentication in SOAPUI

...

The server will return a description of the element with all the settings which can be configured in studio.

UI Text Box
type
Info

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.

...

This method searches for an element in a given branch, project or module. It is equivalent to the search functionality present in studioBlueriq Encore.

Expand
titleParameters
ParameterParameter descriptionPossible ValuesRequired / Optional
SearchTypeIn what scope you would like to searchBranch, ProjectStructure, SingleProject, ModuleScoperequired
Repositorythe repository in which the search is performed
required
Branchthe branch in which the search is performed
required
Projectthe projectin which the search is performed
optional
Modulethe module in which the search is performed
optional
SearchStringthe string to be searched for
required
SearchInNamesa boolean indicating whether to search in names of elementstrue, falserequired
SearchInDependenciesa boolean indicating whether to search in the dependencies of an elementtrue, falserequired
IncludeGlobalElementsa boolean indicating whether to search in global elementstrue, falserequired
IncludeModuleElementsa boolean indicating whether to search in module elementstrue, falserequired
FullTexta boolean indicating if a full text search should be performedtrue, falserequired
CaseSensitivea boolean indicating that the search should be performed in a case-sensitive mannertrue, falserequired

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


...

Similar to ExecuteAllUnitTests above, but with the branch parameter replaced by a revisionId parameter to execute the tests of a particular revision. This operation is available since Blueriq 15.2.0. 

ExecuteUnitTests

Returns the result of a list of specified unit tests, defined within a specific module scope. 

...

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 : 

...

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. 

...