private-test-cloud
2.2510
true
Guia da API do Test Cloud privado
- Introdução
- Autenticação
- Escopos e permissões
- APIs de gestão de plataforma
- Recuperação do partiçãoGlobalId para uso da API
- Obter logs de auditoria
- Baixar logs de auditoria
- Alertas
- ClienteExterno
Importante :
A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.
Referência de API para baixar logs de auditoria no Test Cloud privado, incluindo pontos de extremidade, campos de solicitação e respostas.
Baixa os logs de auditoria para uma organização, com base na ID da organização, para sua máquina, em um formato .CSV.
Ponto de Extremidade da API
GET https://{yourDomain}/{organizationName}/audit_/api/auditlogs/download
Escopos
Requer um dos seguintes escopos:
- PM.Audit
- PM.Audit.Read
Cabeçalhos de solicitação.
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Observação:
Para obter o {access_token}, certifique-se de se autenticar por meio de um dos métodos descritos em Métodos de autenticação.
Parâmetros de Consulta
| Parâmetro de consulta | Tipo de dados | Description |
|---|---|---|
language (opcional) | String | Especifica o idioma de exibição disponível, na forma reduzida. Por exemplo, en, fr, de, ja etc. |
size (opcional) | Int32 | Especifica o tamanho do download. |
Resposta
200 OK
A lista de eventos de auditoria é baixada para sua máquina, no formato .csv.
Exemplo de solicitação
Digamos que você reuniu todas as informações necessárias para criar a chamada de API.
- Seu
{baseURL}é:https://{yourDomain}/{organizationName} - Seu
{access_token}é:1234(para considerações de comprimento). - Você define os seguintes parâmetros de consulta:
language=ensize= 13, para baixar as 13 principais entradas.
A chamada deve ser semelhante ao seguinte exemplo (CURL):
curl --location --request GET ' https://{yourDomain}/{organizationName}/audit_/api/auditlogs/download?language=en&size=13' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
curl --location --request GET ' https://{yourDomain}/{organizationName}/audit_/api/auditlogs/download?language=en&size=13' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'