- Introdução
- Definição do Swagger
- APIs do Orchestrator
- Solicitações de alertas
- Solicitações de tarefas de aplicativo
- Solicitações de ativos
- Solicitações de calendários
- Solicitações de ambientes
- Solicitações de pastas
- Solicitações de tarefas genéricas
- Solicitações de trabalhos
- Solicitações de bibliotecas
- Solicitações de licenças
- Solicitações de pacotes
- Solicitações de permissões
- Solicitações de espaços de trabalho pessoais
- Solicitações de processos
- Processar solicitações de política de retenção de dados
- Solicitações de itens de fila
- Solicitações da política de retenção de filas
- Solicitações de robôs
- Solicitações de funções
- Solicitações de agendamentos
- Solicitações de configurações
- Solicitações de bucket de armazenamento
- Solicitações de tarefas
- Solicitações de catálogos de tarefas
- Solicitações de formulários de tarefas
- Solicitações de tenants
- Solicitações de Transações
- Solicitações de usuários
- Solicitações de gravações de vídeo
- Solicitações de webhooks
Solicitações de API para recuperar URLs de download e excluir gravações de vídeo de execução de trabalhos e itens de fila.
Quando a gravação de vídeo está habilitada, as execuções unattended podem produzir gravações de vídeo que são armazenadas em buckets de armazenamento do sistema. Essas solicitações permitem que você recupere URLs de download limitados em tempo para as gravações de um trabalho ou item de fila e as exclua.
Esses pontos de extremidade exigem que a gravação de vídeo seja habilitada para que o tenant e os buckets de armazenamento sejam configurados. Se a gravação de vídeo não estiver habilitada, as solicitações retornarão um erro.
As URLs de download retornadas pelas solicitações read são URLs SAS (assinatura de acesso compartilhado) limitadas no tempo que apontam diretamente para cada arquivo de gravação. Você não precisa saber os nomes dos arquivos, a resposta contém um URL pronto para uso por gravação. Baixe a gravação emitindo uma solicitação GET para cada Uri retornado.
Permissões necessárias
| Solicitar | Permissões |
|---|---|
| Obter URLs de download de gravação de trabalho | Jobs.View e ExecutionMedia.View |
| Excluir gravações de trabalho | Jobs.Delete e ExecutionMedia.Delete |
| Obter URLs de download de gravação de itens da fila | Jobs.View, Queues.View e ExecutionMedia.View |
| Excluir gravações de itens da fila | Queues.Delete e ExecutionMedia.Delete |
Obtendo os URLs de download para as gravações de um trabalho
Essa solicitação GET retorna os URLs de download para todas as gravações associadas a um trabalho. O trabalho é identificado por seu {jobKey}, que é o campo GUID Key do trabalho (não o numérico Id). Você pode recuperar o Key de um trabalho das Solicitações de trabalhos, por exemplo, GET /odata/Jobs?$filter=Id eq 125161 retorna o Key.
Ponto de Extremidade da API
Obter
{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/api/VideoRecording/jobs/{jobKey}/read
Cabeçalhos de solicitação.
| Chave | Valor |
|---|---|
| Autorização | Portador {access_token} |
| X-UIPATH-OrganizationUnitId | {ID_pasta} |
Código de resposta
200 OK
Corpo da Resposta
[
{
"Uri": "https://{storage-account}.blob.core.windows.net/orchestrator/.../recording_1.mp4?sv=2023-01-03&se=2026-06-24T12%3A30%3A00Z&sr=b&sp=r&sig=...",
"Verb": "GET",
"RequiresAuth": false,
"Headers": null
}
]
[
{
"Uri": "https://{storage-account}.blob.core.windows.net/orchestrator/.../recording_1.mp4?sv=2023-01-03&se=2026-06-24T12%3A30%3A00Z&sr=b&sp=r&sig=...",
"Verb": "GET",
"RequiresAuth": false,
"Headers": null
}
]
Um trabalho pode ter no máximo 10 arquivos de gravação. Cada Uri é válido por um tempo limitado; solicite os URLs novamente se eles expirarem. Para gravações fornecidas por meio do mecanismo SAS integrado do Orchestrator, a extensão do arquivo é anexada ao URL como um parâmetro de consulta &type= para que você possa determinar o tipo de arquivo.
Exclusão das gravações de um trabalho
Essa solicitação DELETE remove todos os arquivos de gravação associados a um trabalho, identificados por seu GUID {jobKey}.
Ponto de Extremidade da API
Excluir
{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/api/VideoRecording/jobs/{jobKey}
Cabeçalhos de solicitação.
| Chave | Valor |
|---|---|
| Autorização | Portador {access_token} |
| X-UIPATH-OrganizationUnitId | {ID_pasta} |
Código de resposta
204 Sem conteúdo
Obtendo os URLs de download para as gravações de um item da fila
Essa solicitação GET retorna os URLs de download para todas as gravações associadas a um item da fila, identificados pelo seu {queueItemId}.
Ponto de Extremidade da API
Obter
{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/api/VideoRecording/QueueItems/{queueItemId}/Read
Cabeçalhos de solicitação.
| Chave | Valor |
|---|---|
| Autorização | Portador {access_token} |
| X-UIPATH-OrganizationUnitId | {ID_pasta} |
Código de resposta
200 OK
Corpo da Resposta
[
{
"Uri": "https://{storage-account}.blob.core.windows.net/orchestrator/.../recording_1.mp4?sv=2023-01-03&se=2026-06-24T12%3A30%3A00Z&sr=b&sp=r&sig=...",
"Verb": "GET",
"RequiresAuth": false,
"Headers": null
}
]
[
{
"Uri": "https://{storage-account}.blob.core.windows.net/orchestrator/.../recording_1.mp4?sv=2023-01-03&se=2026-06-24T12%3A30%3A00Z&sr=b&sp=r&sig=...",
"Verb": "GET",
"RequiresAuth": false,
"Headers": null
}
]
Exclusão das gravações de um item da fila
Esta solicitação DELETE remove todos os arquivos de gravação associados a um item da fila, identificado por seu numérico {queueItemId}.
Ponto de Extremidade da API
Excluir
{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/api/VideoRecording/QueueItems/{queueItemId}
Cabeçalhos de solicitação.
| Chave | Valor |
|---|---|
| Autorização | Portador {access_token} |
| X-UIPATH-OrganizationUnitId | {ID_pasta} |
Código de resposta
204 Sem conteúdo
- Permissões necessárias
- Obtendo os URLs de download para as gravações de um trabalho
- Ponto de Extremidade da API
- Cabeçalhos de solicitação.
- Código de resposta
- Corpo da Resposta
- Exclusão das gravações de um trabalho
- Ponto de Extremidade da API
- Cabeçalhos de solicitação.
- Código de resposta
- Obtendo os URLs de download para as gravações de um item da fila
- Ponto de Extremidade da API
- Cabeçalhos de solicitação.
- Código de resposta
- Corpo da Resposta
- Exclusão das gravações de um item da fila
- Ponto de Extremidade da API
- Cabeçalhos de solicitação.
- Código de resposta