Version: 4.42

Referência de API — Gerenciamento de grupos de política

Visão geral

Os grupos de política são os recursos que definem o contexto de aplicação de uma política. Antes de criar uma política, você deve criar os grupos de aplicações e grupos de sites que ela utilizará.

Grupos de aplicações definem quais aplicações de desktop podem usar certificados sob uma política.
Grupos de sites definem quais sites podem usar certificados sob uma política.

Após a criação, use os IDs desses grupos como parâmetros applicationGroupIds e siteGroupIds em AddPolicy e EditPolicy.

Antes de começar

Antes de testar estes métodos, é necessário configurar o SoapUI.

important

Os comentários  que aparecem nas requisições SOAP são gerados automaticamente e podem marcar incorretamente campos obrigatórios como opcionais.

Esta documentação especifica explicitamente quais campos são obrigatórios ou opcionais. Sempre confie nesta documentação.

Grupos de aplicações

`ListApplicationGroups`

Retorna a lista de grupos de aplicações definidos no sistema.

Nome	Tipo	Obrigatório	Descrição
`filter`	string	Não	Texto que os resultados devem conter. Se vazio, retorna todos os grupos.

Requisição
Resposta

<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>

Consulte a referência completa de campos de GroupsResponse em Objetos de resposta.

`GetApplicationGroup`

Retorna os dados completos de um grupo de aplicações.

Nome	Tipo	Obrigatório	Descrição
`appGroupId`	integer	Sim	ID do grupo de aplicações. Encontre o valor em `ListApplicationGroups`.

Requisição
Resposta

<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>

Consulte a referência completa de campos de ApplicationGroup em Objetos de resposta.

`AddApplicationGroup`

Cria um grupo de aplicações no sistema.

Nome	Tipo	Obrigatório	Descrição
`name`	string	Sim	Nome do grupo de aplicações.
`applications`	array de Application	Sim	Lista de aplicações no grupo. Cada item inclui: `expType` (tipo de expressão: `PROCESS` para nome de processo, `REGEXP` para expressão regular padrão, `RTREGEXP` para expressão regular do Redtrust, `COMMAND_LINE` para linha de comando), `id` (inteiro positivo único que não esteja atribuído a outra aplicação) e `name` (nome do processo ou padrão).
`mappedSites`	array de strings	Não	Lista de sites associados ao grupo de aplicações.

Requisição
Resposta

<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>

O campo ResultData contém o ID do novo grupo de aplicações.

`UpdateApplicationGroup`

Atualiza um grupo de aplicações existente. A lista de aplicações substitui completamente os valores atuais; omitir um item remove-o do grupo.

Nome	Tipo	Obrigatório	Descrição
`appGroupId`	integer	Sim	ID do grupo a atualizar. Encontre o valor em `ListApplicationGroups`.
`name`	string	Sim	Novo nome do grupo de aplicações.
`applications`	array de Application	Sim	Nova lista completa de aplicações. Substitui a lista atual. Cada item inclui: `expType` (tipo de expressão: `PROCESS`, `REGEXP`, `RTREGEXP`, `COMMAND_LINE`), `id` (inteiro positivo único que não esteja atribuído a outra aplicação) e `name` (nome do processo ou padrão).
`mappedSites`	array de strings	Não	Nova lista de sites associados. Substitui a lista atual.

Requisição
Resposta

<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>

O campo ResultData contém o ID do grupo de aplicações atualizado.

`DeleteApplicationGroups`

Exclui um ou mais grupos de aplicações.

Nome	Tipo	Obrigatório	Descrição
`appGroupIds`	array de integers	Sim	IDs dos grupos a excluir. Encontre os valores em `ListApplicationGroups`.
`forceDelete`	boolean	Sim	Se `true`, exclui o grupo mesmo que esteja em uso por políticas. Se `false`, a operação falha se o grupo estiver em uso.

Requisição
Resposta

<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`

Verifica se um valor corresponde a uma ou mais expressões. Útil para validar se os padrões de um grupo funcionam corretamente antes de usá-los em uma política.

Nome	Tipo	Obrigatório	Descrição
`value`	string	Sim	Valor a verificar (por exemplo, um nome de processo).
`itemTests`	array de WhereItemTest	Sim	Lista de expressões a verificar com o valor. Cada item deve incluir: `expType` (obrigatório; tipo de expressão: `PROCESS`, `REGEXP`, `RTREGEXP`, `COMMAND_LINE`), `value` (obrigatório; padrão ou nome) e `itemId` (obrigatório; identificador externo para correlacionar os resultados). Não inclua `matchExpression` na requisição: o servidor retorna um erro se estiver presente. Na resposta, cada item também inclui `internalId`, `postData` e `matchExpression` (`true` se o valor corresponde à expressão, `false` caso contrário).

Requisição
Resposta

<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>

Cada item em ResultData inclui o campo matchExpression: true se o valor corresponde à expressão, false caso contrário.

`DownloadApplicationsCSV`

Faz download de um arquivo CSV com a lista de grupos de aplicações do sistema. Os parâmetros são enviados no cabeçalho SOAP, não no corpo.

Nome	Tipo	Obrigatório	Descrição
`basicFilter` (cabeçalho)	string	Não	Texto que os resultados devem conter. Se vazio, inclui todos os grupos.

Requisição
Resposta

<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>

O status do resultado e o nome do arquivo são retornados no cabeçalho SOAP da resposta. O conteúdo do arquivo está no corpo como um anexo binário MTOM.

<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>

Grupos de sites

`ListSiteGroups`

Retorna a lista de grupos de sites definidos no sistema.

Nome	Tipo	Obrigatório	Descrição
`q`	string	Não	Texto que os resultados devem conter. Se vazio, retorna todos os grupos.

Requisição
Resposta

<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>

Consulte a referência completa de campos de GroupsResponse em Objetos de resposta.

`GetSitesGroup`

Retorna os dados completos de um grupo de sites.

Nome	Tipo	Obrigatório	Descrição
`sitesGroupId`	integer	Sim	ID do grupo de sites. Encontre o valor em `ListSiteGroups`.

Requisição
Resposta

<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>

Consulte a referência completa de campos de SiteGroup em Objetos de resposta.

`AddSitesGroup`

Cria um grupo de sites no sistema.

Nome	Tipo	Obrigatório	Descrição
`name`	string	Sim	Nome do grupo de sites.
`sites`	array de Site	Sim	Lista de sites no grupo. Cada item inclui: `expType` (tipo de expressão: `REGEXP` para expressão regular padrão, `RTREGEXP` para expressão regular do Redtrust), `id` (inteiro positivo único que não esteja atribuído a outro site), `name` (URL ou padrão de site) e `postdata` (dados POST opcionais para distinguir sites com a mesma URL; use um elemento vazio se não se aplicar).
`mappedSites`	array de strings	Não	Lista de sites adicionais associados ao grupo.

Requisição
Resposta

<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>

O campo ResultData contém o ID do novo grupo de sites.

`UpdateSitesGroup`

Atualiza um grupo de sites existente. A lista de sites substitui completamente os valores atuais; omitir um item remove-o do grupo.

Nome	Tipo	Obrigatório	Descrição
`sitesGroupId`	integer	Sim	ID do grupo a atualizar. Encontre o valor em `ListSiteGroups`.
`name`	string	Sim	Novo nome do grupo de sites.
`sites`	array de Site	Sim	Nova lista completa de sites. Substitui a lista atual. Cada item inclui: `expType` (tipo de expressão: `REGEXP`, `RTREGEXP`), `id` (inteiro positivo único que não esteja atribuído a outro site), `name` (URL ou padrão de site) e `postdata` (dados POST opcionais; use um elemento vazio se não se aplicar).
`mappedSites`	array de strings	Não	Nova lista de sites adicionais. Substitui a lista atual.

Requisição
Resposta

<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>

O campo ResultData contém o ID do grupo de sites atualizado.

`DeleteSitesGroups`

Exclui um ou mais grupos de sites.

Nome	Tipo	Obrigatório	Descrição
`siteGroupIds`	array de integers	Sim	IDs dos grupos a excluir. Encontre os valores em `ListSiteGroups`.
`forceDelete`	boolean	Sim	Se `true`, exclui o grupo mesmo que esteja em uso por políticas. Se `false`, a operação falha se o grupo estiver em uso.

Requisição
Resposta

<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`

Faz download de um arquivo CSV com a lista de grupos de sites do sistema. Os parâmetros são enviados no cabeçalho SOAP, não no corpo.

Nome	Tipo	Obrigatório	Descrição
`basicFilter` (cabeçalho)	string	Não	Texto que os resultados devem conter. Se vazio, inclui todos os grupos.

Requisição
Resposta

<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>

O status do resultado e o nome do arquivo são retornados no cabeçalho SOAP da resposta. O conteúdo do arquivo está no corpo como um anexo binário MTOM.

<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>

Esta página foi útil?

Visão geral​

Antes de começar​

Grupos de aplicações​

ListApplicationGroups​

GetApplicationGroup​

AddApplicationGroup​

UpdateApplicationGroup​

DeleteApplicationGroups​

TestValueInWheres​

DownloadApplicationsCSV​

Grupos de sites​

ListSiteGroups​

GetSitesGroup​

AddSitesGroup​

UpdateSitesGroup​

DeleteSitesGroups​

DownloadSitesCSV​