Version: 4.42

API reference — Policy group management

Overview

Policy groups are the resources that define the application context of a policy. Before creating a policy, you must create the application groups and site groups it will use.

Application groups define which desktop applications can use certificates under a policy.
Site groups define which websites can use certificates under a policy.

Once created, use the IDs of these groups as the applicationGroupIds and siteGroupIds parameters in AddPolicy and EditPolicy.

Before you start

Before testing these methods, you need to set up SoapUI.

important

The  comments that appear in SOAP requests are generated automatically and may incorrectly mark required fields as optional.

This documentation explicitly states which fields are required or optional. Always trust this documentation.

Application groups

`ListApplicationGroups`

Returns the list of application groups defined in the system.

Name	Type	Required	Description
`filter`	string	No	Text that results must contain. If empty, returns all groups.

Request
Response

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
    <soap:Header/>
    <soap:Body>
        <urn:ListApplicationGroups>
            <urn:filter></urn:filter>
        </urn:ListApplicationGroups>
    </soap:Body>
</soap:Envelope>

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
    <s:Header>
        <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/ListApplicationGroupsResponse</a:Action>
    </s:Header>
    <s:Body>
        <ListApplicationGroupsResponse xmlns="urn:evolium:redtrust:administration:ws">
            <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
                <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
                <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Operation finalized successfully</ResultMessage>
                <ResultData i:type="b:GroupsResponse" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">
                    <b:globalApps>true</b:globalApps>
                    <b:groups>
                        <b:BaseGroup i:type="b:ApplicationGroup">
                            <b:friendlyName>Javaw</b:friendlyName>
                            <b:groupId>1</b:groupId>
                            <b:roleId>0</b:roleId>
                            <b:roleName i:nil="true"/>
                            <b:applications>
                                <b:Application>
                                    <b:expType>PROCESS</b:expType>
                                    <b:id>5</b:id>
                                    <b:name>javaw</b:name>
                                </b:Application>
                            </b:applications>
                            <b:mappedSites xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
                        </b:BaseGroup>
                    </b:groups>
                </ResultData>
            </Result>
        </ListApplicationGroupsResponse>
    </s:Body>
</s:Envelope>

See the full field reference for GroupsResponse in Response objects.

`GetApplicationGroup`

Returns the full data for an application group.

Name	Type	Required	Description
`appGroupId`	integer	Yes	Application group ID. Find the value in `ListApplicationGroups`.

Request
Response

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
    <soap:Header/>
    <soap:Body>
        <urn:GetApplicationGroup>
            <urn:appGroupId>1</urn:appGroupId>
        </urn:GetApplicationGroup>
    </soap:Body>
</soap:Envelope>

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
    <s:Header>
        <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/GetApplicationGroupResponse</a:Action>
    </s:Header>
    <s:Body>
        <GetApplicationGroupResponse xmlns="urn:evolium:redtrust:administration:ws">
            <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
                <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
                <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Operation finalized successfully</ResultMessage>
                <ResultData i:type="b:ApplicationGroup" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">
                    <b:friendlyName>Javaw</b:friendlyName>
                    <b:groupId>1</b:groupId>
                    <b:roleId>0</b:roleId>
                    <b:roleName i:nil="true"/>
                    <b:applications>
                        <b:Application>
                            <b:expType>PROCESS</b:expType>
                            <b:id>5</b:id>
                            <b:name>javaw</b:name>
                        </b:Application>
                    </b:applications>
                    <b:mappedSites xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
                </ResultData>
            </Result>
        </GetApplicationGroupResponse>
    </s:Body>
</s:Envelope>

See the full field reference for ApplicationGroup in Response objects.

`AddApplicationGroup`

Creates an application group in the system.

Name	Type	Required	Description
`name`	string	Yes	Application group name.
`applications`	array of Application	Yes	List of applications in the group. Each item includes: `expType` (expression type: `PROCESS` for process name, `REGEXP` for standard regular expression, `RTREGEXP` for Redtrust regular expression, `COMMAND_LINE` for command line), `id` (unique positive integer not already assigned to another application) and `name` (process name or pattern).
`mappedSites`	array of strings	No	List of websites associated with the application group.

Request
Response

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws" xmlns:rtad="http://schemas.datacontract.org/2004/07/RTAdminService.Types">
    <soap:Header/>
    <soap:Body>
        <urn:AddApplicationGroup>
            <urn:name>Navegadores web</urn:name>
            <urn:applications>
                <rtad:Application>
                    <rtad:expType>PROCESS</rtad:expType>
                    <rtad:id>1</rtad:id>
                    <rtad:name>msedge.exe</rtad:name>
                </rtad:Application>
                <rtad:Application>
                    <rtad:expType>PROCESS</rtad:expType>
                    <rtad:id>2</rtad:id>
                    <rtad:name>chrome.exe</rtad:name>
                </rtad:Application>
            </urn:applications>
            <urn:mappedSites/>
        </urn:AddApplicationGroup>
    </soap:Body>
</soap:Envelope>

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
    <s:Header>
        <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/AddApplicationGroupResponse</a:Action>
    </s:Header>
    <s:Body>
        <AddApplicationGroupResponse xmlns="urn:evolium:redtrust:administration:ws">
            <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
                <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
                <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Operation finalized successfully</ResultMessage>
                <ResultData i:type="c:int" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult" xmlns:c="http://www.w3.org/2001/XMLSchema">1</ResultData>
            </Result>
        </AddApplicationGroupResponse>
    </s:Body>
</s:Envelope>

The ResultData field contains the ID of the new application group.

`UpdateApplicationGroup`

Updates an existing application group. The list of applications fully replaces the current values; omitting an item removes it from the group.

Name	Type	Required	Description
`appGroupId`	integer	Yes	ID of the group to update. Find the value in `ListApplicationGroups`.
`name`	string	Yes	New application group name.
`applications`	array of Application	Yes	New complete list of applications. Replaces the current list. Each item includes: `expType` (expression type: `PROCESS`, `REGEXP`, `RTREGEXP`, `COMMAND_LINE`), `id` (unique positive integer not already assigned to another application) and `name` (process name or pattern).
`mappedSites`	array of strings	No	New list of associated websites. Replaces the current list.

Request
Response

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws" xmlns:rtad="http://schemas.datacontract.org/2004/07/RTAdminService.Types">
    <soap:Header/>
    <soap:Body>
        <urn:UpdateApplicationGroup>
            <urn:appGroupId>1</urn:appGroupId>
            <urn:name>Navegadores web</urn:name>
            <urn:applications>
                <rtad:Application>
                    <rtad:expType>PROCESS</rtad:expType>
                    <rtad:id>1</rtad:id>
                    <rtad:name>msedge.exe</rtad:name>
                </rtad:Application>
                <rtad:Application>
                    <rtad:expType>PROCESS</rtad:expType>
                    <rtad:id>2</rtad:id>
                    <rtad:name>chrome.exe</rtad:name>
                </rtad:Application>
                <rtad:Application>
                    <rtad:expType>PROCESS</rtad:expType>
                    <rtad:id>3</rtad:id>
                    <rtad:name>firefox.exe</rtad:name>
                </rtad:Application>
            </urn:applications>
            <urn:mappedSites/>
        </urn:UpdateApplicationGroup>
    </soap:Body>
</soap:Envelope>

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
    <s:Header>
        <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/UpdateApplicationGroupResponse</a:Action>
    </s:Header>
    <s:Body>
        <UpdateApplicationGroupResponse xmlns="urn:evolium:redtrust:administration:ws">
            <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
                <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
                <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Operation finalized successfully</ResultMessage>
                <ResultData i:type="c:int" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult" xmlns:c="http://www.w3.org/2001/XMLSchema">1</ResultData>
            </Result>
        </UpdateApplicationGroupResponse>
    </s:Body>
</s:Envelope>

The ResultData field contains the ID of the updated application group.

`DeleteApplicationGroups`

Deletes one or more application groups.

Name	Type	Required	Description
`appGroupIds`	array of integers	Yes	IDs of the groups to delete. Find the values in `ListApplicationGroups`.
`forceDelete`	boolean	Yes	If `true`, deletes the group even if it is in use by policies. If `false`, the operation fails if the group is in use.

Request
Response

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <soap:Header/>
    <soap:Body>
        <urn:DeleteApplicationGroups>
            <urn:appGroupIds>
                <arr:int>1</arr:int>
                <arr:int>2</arr:int>
            </urn:appGroupIds>
            <urn:forceDelete>false</urn:forceDelete>
        </urn:DeleteApplicationGroups>
    </soap:Body>
</soap:Envelope>

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
    <s:Header>
        <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/DeleteApplicationGroupsResponse</a:Action>
    </s:Header>
    <s:Body>
        <DeleteApplicationGroupsResponse xmlns="urn:evolium:redtrust:administration:ws">
            <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
                <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
                <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Operation finalized successfully</ResultMessage>
            </Result>
        </DeleteApplicationGroupsResponse>
    </s:Body>
</s:Envelope>

`TestValueInWheres`

Checks whether a value matches one or more expressions. Useful to verify that a group's patterns work correctly before using them in a policy.

Name	Type	Required	Description
`value`	string	Yes	Value to check (for example, a process name).
`itemTests`	array of WhereItemTest	Yes	List of expressions to check the value against. Each item must include: `expType` (required; expression type: `PROCESS`, `REGEXP`, `RTREGEXP`, `COMMAND_LINE`), `value` (required; pattern or name), and `itemId` (required; external identifier to correlate results). Do not include `matchExpression` in the request — the server returns an error if it is present. In the response, each item also includes `internalId`, `postData`, and `matchExpression` (`true` if the value matches the expression, `false` if not).

Request
Response

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws" xmlns:rtad="http://schemas.datacontract.org/2004/07/RTAdminService.Types">
    <soap:Header/>
    <soap:Body>
        <urn:TestValueInWheres>
            <urn:value>msedge.exe</urn:value>
            <urn:itemTests>
                <rtad:WhereItemTest>
                    <rtad:expType>PROCESS</rtad:expType>
                    <rtad:value>msedge.exe</rtad:value>
                    <rtad:itemId>test-1</rtad:itemId>
                </rtad:WhereItemTest>
                <rtad:WhereItemTest>
                    <rtad:expType>PROCESS</rtad:expType>
                    <rtad:value>chrome.exe</rtad:value>
                    <rtad:itemId>test-2</rtad:itemId>
                </rtad:WhereItemTest>
            </urn:itemTests>
        </urn:TestValueInWheres>
    </soap:Body>
</soap:Envelope>

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
    <s:Header>
        <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/TestValueInWheresResponse</a:Action>
    </s:Header>
    <s:Body>
        <TestValueInWheresResponse xmlns="urn:evolium:redtrust:administration:ws">
            <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
                <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
                <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Operation finalized successfully</ResultMessage>
                <ResultData i:type="b:ArrayOfWhereItemTest" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">
                    <b:WhereItemTest>
                        <b:expType>PROCESS</b:expType>
                        <b:internalId>0</b:internalId>
                        <b:postData i:nil="true"/>
                        <b:value>msedge.exe</b:value>
                        <b:itemId>test-1</b:itemId>
                        <b:matchExpression>true</b:matchExpression>
                    </b:WhereItemTest>
                    <b:WhereItemTest>
                        <b:expType>PROCESS</b:expType>
                        <b:internalId>0</b:internalId>
                        <b:postData i:nil="true"/>
                        <b:value>chrome.exe</b:value>
                        <b:itemId>test-2</b:itemId>
                        <b:matchExpression>false</b:matchExpression>
                    </b:WhereItemTest>
                </ResultData>
            </Result>
        </TestValueInWheresResponse>
    </s:Body>
</s:Envelope>

Each item in ResultData includes the matchExpression field: true if the value matches the expression, false if it does not.

`DownloadApplicationsCSV`

Downloads a CSV file with the list of application groups in the system. Parameters go in the SOAP header, not the body.

Name	Type	Required	Description
`basicFilter` (header)	string	No	Text that results must contain. If empty, includes all groups.

Request
Response

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
    <soap:Header>
        <urn:basicFilter></urn:basicFilter>
    </soap:Header>
    <soap:Body>
        <urn:DownloadApplicationsCSV/>
    </soap:Body>
</soap:Envelope>

The result status and filename are returned in the SOAP response header. The file content is in the body as an MTOM binary attachment.

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
    <s:Header>
        <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/DownloadApplicationsCSVResponse</a:Action>
        <h:result s:mustUnderstand="1" xmlns:h="urn:evolium:redtrust:administration:ws" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
            <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
            <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Operation finalized successfully</ResultMessage>
            <Filename xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Applications_202605070928.csv</Filename>
        </h:result>
    </s:Header>
    <s:Body>
        <ResultFileStream xmlns="urn:evolium:redtrust:administration:ws">
            <stream>
                <xop:Include href="cid:http://tempuri.org/1/639137428825129817" xmlns:xop="http://www.w3.org/2004/08/xop/include"/>
            </stream>
        </ResultFileStream>
    </s:Body>
</s:Envelope>

Site groups

`ListSiteGroups`

Returns the list of site groups defined in the system.

Name	Type	Required	Description
`q`	string	No	Text that results must contain. If empty, returns all groups.

Request
Response

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
    <soap:Header/>
    <soap:Body>
        <urn:ListSiteGroups>
            <urn:q></urn:q>
        </urn:ListSiteGroups>
    </soap:Body>
</soap:Envelope>

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
    <s:Header>
        <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/ListSiteGroupsResponse</a:Action>
    </s:Header>
    <s:Body>
        <ListSiteGroupsResponse xmlns="urn:evolium:redtrust:administration:ws">
            <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
                <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
                <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Operation finalized successfully</ResultMessage>
                <ResultData i:type="b:GroupsResponse" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">
                    <b:globalApps>true</b:globalApps>
                    <b:groups>
                        <b:BaseGroup i:type="b:SiteGroup">
                            <b:friendlyName>all.sites</b:friendlyName>
                            <b:groupId>3</b:groupId>
                            <b:roleId>0</b:roleId>
                            <b:roleName i:nil="true"/>
                            <b:mappedSites xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
                            <b:sites>
                                <b:Site>
                                    <b:expType>REGEXP</b:expType>
                                    <b:id>3</b:id>
                                    <b:name>.*</b:name>
                                    <b:postdata/>
                                </b:Site>
                            </b:sites>
                        </b:BaseGroup>
                    </b:groups>
                </ResultData>
            </Result>
        </ListSiteGroupsResponse>
    </s:Body>
</s:Envelope>

See the full field reference for GroupsResponse in Response objects.

`GetSitesGroup`

Returns the full data for a site group.

Name	Type	Required	Description
`sitesGroupId`	integer	Yes	Site group ID. Find the value in `ListSiteGroups`.

Request
Response

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
    <soap:Header/>
    <soap:Body>
        <urn:GetSitesGroup>
            <urn:sitesGroupId>3</urn:sitesGroupId>
        </urn:GetSitesGroup>
    </soap:Body>
</soap:Envelope>

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
    <s:Header>
        <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/GetSitesGroupResponse</a:Action>
    </s:Header>
    <s:Body>
        <GetSitesGroupResponse xmlns="urn:evolium:redtrust:administration:ws">
            <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
                <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
                <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Operation finalized successfully</ResultMessage>
                <ResultData i:type="b:SiteGroup" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">
                    <b:friendlyName>all.sites</b:friendlyName>
                    <b:groupId>3</b:groupId>
                    <b:roleId>0</b:roleId>
                    <b:roleName i:nil="true"/>
                    <b:mappedSites xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
                    <b:sites>
                        <b:Site>
                            <b:expType>REGEXP</b:expType>
                            <b:id>3</b:id>
                            <b:name>.*</b:name>
                            <b:postdata/>
                        </b:Site>
                    </b:sites>
                </ResultData>
            </Result>
        </GetSitesGroupResponse>
    </s:Body>
</s:Envelope>

See the full field reference for SiteGroup in Response objects.

`AddSitesGroup`

Creates a site group in the system.

Name	Type	Required	Description
`name`	string	Yes	Site group name.
`sites`	array of Site	Yes	List of sites in the group. Each item includes: `expType` (expression type: `REGEXP` for standard regular expression, `RTREGEXP` for Redtrust regular expression), `id` (unique positive integer not already assigned to another site), `name` (URL or site pattern) and `postdata` (optional POST data to distinguish sites with the same URL; use an empty element if not applicable).
`mappedSites`	array of strings	No	List of additional websites associated with the group.

Request
Response

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws" xmlns:rtad="http://schemas.datacontract.org/2004/07/RTAdminService.Types">
    <soap:Header/>
    <soap:Body>
        <urn:AddSitesGroup>
            <urn:name>Portal corporativo</urn:name>
            <urn:sites>
                <rtad:Site>
                    <rtad:expType>REGEXP</rtad:expType>
                    <rtad:id>1</rtad:id>
                    <rtad:name>portal.example.com</rtad:name>
                    <rtad:postdata/>
                </rtad:Site>
            </urn:sites>
            <urn:mappedSites/>
        </urn:AddSitesGroup>
    </soap:Body>
</soap:Envelope>

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
    <s:Header>
        <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/AddSitesGroupResponse</a:Action>
    </s:Header>
    <s:Body>
        <AddSitesGroupResponse xmlns="urn:evolium:redtrust:administration:ws">
            <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
                <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
                <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Operation finalized successfully</ResultMessage>
                <ResultData i:type="c:int" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult" xmlns:c="http://www.w3.org/2001/XMLSchema">2</ResultData>
            </Result>
        </AddSitesGroupResponse>
    </s:Body>
</s:Envelope>

The ResultData field contains the ID of the new site group.

`UpdateSitesGroup`

Updates an existing site group. The list of sites fully replaces the current values; omitting an item removes it from the group.

Name	Type	Required	Description
`sitesGroupId`	integer	Yes	ID of the group to update. Find the value in `ListSiteGroups`.
`name`	string	Yes	New site group name.
`sites`	array of Site	Yes	New complete list of sites. Replaces the current list. Each item includes: `expType` (expression type: `REGEXP`, `RTREGEXP`), `id` (unique positive integer not already assigned to another site), `name` (URL or site pattern) and `postdata` (optional POST data; use an empty element if not applicable).
`mappedSites`	array of strings	No	New list of additional websites. Replaces the current list.

Request
Response

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws" xmlns:rtad="http://schemas.datacontract.org/2004/07/RTAdminService.Types">
    <soap:Header/>
    <soap:Body>
        <urn:UpdateSitesGroup>
            <urn:sitesGroupId>2</urn:sitesGroupId>
            <urn:name>Portal corporativo</urn:name>
            <urn:sites>
                <rtad:Site>
                    <rtad:expType>REGEXP</rtad:expType>
                    <rtad:id>1</rtad:id>
                    <rtad:name>portal.example.com</rtad:name>
                    <rtad:postdata/>
                </rtad:Site>
            </urn:sites>
            <urn:mappedSites/>
        </urn:UpdateSitesGroup>
    </soap:Body>
</soap:Envelope>

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
    <s:Header>
        <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/UpdateSitesGroupResponse</a:Action>
    </s:Header>
    <s:Body>
        <UpdateSitesGroupResponse xmlns="urn:evolium:redtrust:administration:ws">
            <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
                <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
                <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Operation finalized successfully</ResultMessage>
                <ResultData i:type="c:int" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult" xmlns:c="http://www.w3.org/2001/XMLSchema">2</ResultData>
            </Result>
        </UpdateSitesGroupResponse>
    </s:Body>
</s:Envelope>

The ResultData field contains the ID of the updated site group.

`DeleteSitesGroups`

Deletes one or more site groups.

Name	Type	Required	Description
`siteGroupIds`	array of integers	Yes	IDs of the groups to delete. Find the values in `ListSiteGroups`.
`forceDelete`	boolean	Yes	If `true`, deletes the group even if it is in use by policies. If `false`, the operation fails if the group is in use.

Request
Response

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <soap:Header/>
    <soap:Body>
        <urn:DeleteSitesGroups>
            <urn:siteGroupIds>
                <arr:int>2</arr:int>
            </urn:siteGroupIds>
            <urn:forceDelete>false</urn:forceDelete>
        </urn:DeleteSitesGroups>
    </soap:Body>
</soap:Envelope>

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
    <s:Header>
        <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/DeleteSitesGroupsResponse</a:Action>
    </s:Header>
    <s:Body>
        <DeleteSitesGroupsResponse xmlns="urn:evolium:redtrust:administration:ws">
            <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
                <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
                <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Operation finalized successfully</ResultMessage>
            </Result>
        </DeleteSitesGroupsResponse>
    </s:Body>
</s:Envelope>

`DownloadSitesCSV`

Downloads a CSV file with the list of site groups in the system. Parameters go in the SOAP header, not the body.

Name	Type	Required	Description
`basicFilter` (header)	string	No	Text that results must contain. If empty, includes all groups.

Request
Response

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
    <soap:Header>
        <urn:basicFilter></urn:basicFilter>
    </soap:Header>
    <soap:Body>
        <urn:DownloadSitesCSV/>
    </soap:Body>
</soap:Envelope>

The result status and filename are returned in the SOAP response header. The file content is in the body as an MTOM binary attachment.

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
    <s:Header>
        <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/DownloadSitesCSVResponse</a:Action>
        <h:result s:mustUnderstand="1" xmlns:h="urn:evolium:redtrust:administration:ws" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
            <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
            <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Operation finalized successfully</ResultMessage>
            <Filename xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Sites_202605070928.csv</Filename>
        </h:result>
    </s:Header>
    <s:Body>
        <ResultFileStream xmlns="urn:evolium:redtrust:administration:ws">
            <stream>
                <xop:Include href="cid:http://tempuri.org/1/639137428825129817" xmlns:xop="http://www.w3.org/2004/08/xop/include"/>
            </stream>
        </ResultFileStream>
    </s:Body>
</s:Envelope>

Was this page helpful?

Overview​

Before you start​

Application groups​

ListApplicationGroups​

GetApplicationGroup​

AddApplicationGroup​

UpdateApplicationGroup​

DeleteApplicationGroups​

TestValueInWheres​

DownloadApplicationsCSV​

Site groups​

ListSiteGroups​

GetSitesGroup​

AddSitesGroup​

UpdateSitesGroup​

DeleteSitesGroups​

DownloadSitesCSV​