orchestrator
2024.10
true
- Introdução
- Definição do Swagger
- APIs do Orchestrator
- Solicitações de alertas
- 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
- 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 webhooks
Solicitações de ambientes
Guia da API do Orchestrator
Última atualização 11 de nov de 2024
Solicitações de ambientes
Observação: a partir da v2018.3, o conceito de tipo de ambiente foi removido e não é mais exibido na interface do usuário. Fique tranquilo, a compatibilidade com versões anteriores ainda é mantida, pois essa opção não foi removida da API do orquestrador. No entanto, observe que todos os novos ambientes criados na interface do usuário são do tipo Dev.
A chamada a seguir ajuda a exibir apenas os ambientes atribuídos ao pacote "add_queue_items".
Obter
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Releases?$filter=ProcessKey eq 'add_queue_items'&$select=EnvironmentName
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Releases(EnvironmentName)",
"@odata.count": 2,
"value": [
{
"EnvironmentName": "clean_env"
},
{
"EnvironmentName": "doc_env"
}
]
}
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Releases(EnvironmentName)",
"@odata.count": 2,
"value": [
{
"EnvironmentName": "clean_env"
},
{
"EnvironmentName": "doc_env"
}
]
}
O exemplo a seguir permite recuperar todos os processos associados ao ambiente "doc_env".
Obter
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Releases?$filter=EnvironmentName eq 'doc_env'
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Releases",
"@odata.count": 5,
"value": [
{
"Key": "663119a9-cd88-4345-ad9a-e91e96c97eb2",
"ProcessKey": "add_queue_items",
"ProcessVersion": "1.0.6586.22741",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": null,
"Name": "add_queue_items_doc_env",
"EnvironmentId": 312,
"EnvironmentName": "doc_env",
"Id": 422
},
{
"Key": "57fb1bd5-f8fd-40b4-be7b-4a18f34fe293",
"ProcessKey": "DataScraping",
"ProcessVersion": "1.0.6586.22750",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": null,
"Name": "DataScraping_doc_env",
"EnvironmentId": 312,
"EnvironmentName": "doc_env",
"Id": 421
},
{
"Key": "cabdbd2e-0c92-4abe-9266-ac053d660bbc",
"ProcessKey": "in_progress_items",
"ProcessVersion": "1.0.6640.35909",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": null,
"Name": "in_progress_items_doc_env",
"EnvironmentId": 312,
"EnvironmentName": "doc_env",
"Id": 598
},
{
"Key": "795cbab2-8008-4a54-b1cb-f9ff1ece139e",
"ProcessKey": "new_activities_tests",
"ProcessVersion": "1.0.6586.22737",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": null,
"Name": "new_activities_tests_doc_env",
"EnvironmentId": 312,
"EnvironmentName": "doc_env",
"Id": 423
},
{
"Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
"ProcessKey": "Release_Project",
"ProcessVersion": "1.0.6589.35468",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": "rockerii",
"Name": "Release_Project_doc_env",
"EnvironmentId": 312,
"EnvironmentName": "doc_env",
"Id": 440
}
]
}
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Releases",
"@odata.count": 5,
"value": [
{
"Key": "663119a9-cd88-4345-ad9a-e91e96c97eb2",
"ProcessKey": "add_queue_items",
"ProcessVersion": "1.0.6586.22741",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": null,
"Name": "add_queue_items_doc_env",
"EnvironmentId": 312,
"EnvironmentName": "doc_env",
"Id": 422
},
{
"Key": "57fb1bd5-f8fd-40b4-be7b-4a18f34fe293",
"ProcessKey": "DataScraping",
"ProcessVersion": "1.0.6586.22750",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": null,
"Name": "DataScraping_doc_env",
"EnvironmentId": 312,
"EnvironmentName": "doc_env",
"Id": 421
},
{
"Key": "cabdbd2e-0c92-4abe-9266-ac053d660bbc",
"ProcessKey": "in_progress_items",
"ProcessVersion": "1.0.6640.35909",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": null,
"Name": "in_progress_items_doc_env",
"EnvironmentId": 312,
"EnvironmentName": "doc_env",
"Id": 598
},
{
"Key": "795cbab2-8008-4a54-b1cb-f9ff1ece139e",
"ProcessKey": "new_activities_tests",
"ProcessVersion": "1.0.6586.22737",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": null,
"Name": "new_activities_tests_doc_env",
"EnvironmentId": 312,
"EnvironmentName": "doc_env",
"Id": 423
},
{
"Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
"ProcessKey": "Release_Project",
"ProcessVersion": "1.0.6589.35468",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": "rockerii",
"Name": "Release_Project_doc_env",
"EnvironmentId": 312,
"EnvironmentName": "doc_env",
"Id": 440
}
]
}