--- sourceDocument: Referência de API do Xanadu sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference Release : - xanadu ft:locale : - pt-BR ft:publication_title : - Referência de API do Xanadu ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # API de integração contínua/entrega contínua (CICD) # API de integração contínua/entrega contínua (CICD) {#ariaid-title1} * Versão de lançamento: Xanadu * * Atualizado 1 de ago. de 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 74 min. de leitura A API CICD fornece endpoints que permitem a integração com ferramentas DevOps comuns para criar pipelines. Essas ferramentas incluem Jenkins, Azure Pipelines, GitLab, GitHub Actions, Atlassian Bamboo/Pipelines e muito mais. Ele fornece aos integradores a capacidade de criar CICD pipelines para Now Platform aplicações orientadas por fluxos de trabalho de solicitação de extração/mesclagem típicos do desenvolvimento orientado pela origem. Ele aproveita os recursos Controle de código-fonte, Repositório de aplicações e Automated Test Framework. A API de IC/CD fornece as seguintes áreas de produto e recurso: * Controle de código-fonteAplique mudanças remotas para uma aplicação vinculada a um repositório Git remoto por meio do recurso Controle de código-fonte no Studio, em uma instância específica. Importa uma aplicação usando o URL do repositório e o nome da ramificação especificados. * Repositório de aplicações: disponível para aplicações com escopo, aplicação global, personalizações de aplicação para aplicações com escopo no ServiceNow Storee por meio de plug-ins. * Publique uma aplicação de uma instância no repositório de aplicações conectado. * Instale uma aplicação em uma instância do repositório de aplicações conectado. * Reverta uma aplicação que foi instalada por meio do contexto de reversão. * Lote * Defina um arquivo de manifesto JSON para instalar em lote vários aplicativos juntos. * Reverta toda a instalação em lote por meio do contexto de reversão. * Retorna os resultados de uma instalação em lote com base em um identificador de resultado especificado. * Plug-ins * Ativar um plug-in. * Reverta um plug-in por meio do contexto de reversão. * Automated Test Framework (ATF) * Inicie um pacote de testes do ATF. * Obtenha o resultado de aprovação/falha de um pacote de testes ATF. * Verificação de instância * Iniciar uma verificação de instância (completa, verificação de ponto na tabela, verificação de ponto no registro, aplicação com escopo, conjunto de atualizações, combinação desses itens). * Obtenha o resultado de aprovação/falha de uma execução de verificação de instância. * AndamentoObtenha a porcentagem de conclusão em uma instância para processos iniciados por outras chamadas de endpoint. Você pode usar este recurso para pesquisar até a conclusão do andamento antes de prosseguir com a próxima etapa. {#cicd-api__ul_rr4_fnq_spb} Esta API usa um modelo de resposta assíncrono. Quando você chama um endpoint, como para executar um pacote de testes /sn_cicd/testsuite/run, o endpoint inicia a função associada, como iniciar a execução do pacote de testes. O endpoint retorna uma mensagem de resposta que contém o status de execução da função solicitada, normalmente `Pendente`, junto com um identificador e link exclusivos. Use essas informações para obter informações adicionais sobre o andamento, a origem, os resultados e/ou as descobertas da solicitação. Dependendo da solicitação de função, você pode usar um dos seguintes meios para obter informações adicionais sobre uma solicitação: * Chame o endpoint /sn_cicd/progress/{progress_id} usando o parâmetro links.progress.id retornado pelo endpoint inicial. * Chame o endpoint /sn_cicd/testsuite/results/{result_id} usando o parâmetro links.result.id retornado pelo endpoint inicial. * Chame o endpoint /sn_cicd/instance_scan/result/{progress_id} usando o parâmetro links.progress.id retornado pelo endpoint inicial. * Chame o endpoint /sn_cicd/sc/apply_stash/{stash_id} usando o parâmetro links.stash.id retornado peloendpoint /sn_cicd/progress/{progress_id}. * Link de saída para o parâmetro links.\.url retornado pelo endpoint inicial. Nota: Para instalar uma aplicação de um repositório, a aplicação deve primeiro ser publicada no repositório usando o endpoint /sn_cicd/app_repo/publish. Depois de publicado, qualquer instância conectada a esse repositório pode instalar e reverter a aplicação. Se a aplicação não for publicada pela primeira vez, a solicitação de instalação falhará. A função de administrador ou sn_cicd.sys_ci_automation é necessária para usar esta API. A partir de Tokyo, os endpoints de API CICD que precisam obter o bloqueio/mutex de toda a instância para executar a operação solicitada usarão uma fila, em vez de rejeitar solicitações enquanto o bloqueio/mutex de toda a instância estiver ocupado. Vários CICD pipelines fazem solicitações simultaneamente sem detectar a rejeição e a nova tentativa e, em vez disso, podem simplesmente monitorar o andamento como fariam para solicitações bem-sucedidas anteriormente. Este comportamento está ativado por padrão. A fila atual pode ser inspecionada por um usuário com a função de administrador navegando até Diagnóstico do sistema -\> Fila de operações da aplicação. A partir daqui, a fila pode ser pausada e retomada pelo administrador para permitir outras operações manuais que possam exigir o bloqueio/mutex em toda a instância. Nota: Quando pausado, qualquer operação em andamento será executada até a conclusão, mas nenhuma nova operação será iniciada. A API continuará a aceitar e enfileirar novas solicitações. Uma operação pendente também pode ser cancelada antes de começar a ser executada, atualizando o rastreador de execução listado para um estado cancelado. Se, por qualquer motivo, uma operação não puder prosseguir após o tempo limite especificado em com.glide.update_operation.job_cancel_timeout_minutes (padrão: 48 horas), ela será cancelada. Quando um upgrade é programado, a fila entra em um estado de upgrade pausado duas horas antes do upgrade, a menos que seja substituída pela propriedade com.glide.update_operation.queue_upgrade_window. Isso permite que qualquer operação em andamento seja concluída antes do início do upgrade. Nota: A fila é reiniciada automaticamente quando o upgrade é concluído. Para obter informações adicionais sobre CICD, consulte: * [Spoke de Integração Contínua e Entrega Contínua (CICD)](https://www.servicenow.com/docs/access?context=cicd-spoke&version=xanadu&pubname=xanadu-integrate-applications&ft:locale=en-US) * * * [https://github.com/marketplace?type=actions\&query=servicenow](https://github.com/marketplace?type=actions&query=servicenow) * ## IC/CD - GET /sn_cicd/app/batch/results/{result_id} {#ariaid-title2} Retorna os resultados de uma instalação em lote com base em um identificador de resultado especificado. Chame este método depois de chamar o endpoint /sn_cicd/app/batch/install para obter os resultados da instalação em lote. Use o valor retornado no parâmetro links.results.id dos resultados de retorno do endpoint /sn_cicd/app/batch/install como o result_id para este endpoint. Você também pode chamar o endpoint /api/sn_cicd/progress/{progress_id} para obter informações sobre o andamento da instalação caso ela ainda não tenha sido concluída. ### Formato da URL URL com controle de versão: /api/sn_cicd/{api_version}/app/batch/results/{result_id} URL padrão: /api/sn_cicd/app/batch/results/{result_id} ### Parâmetros de solicitação compatíveis {#cicd-GET-app-batch-results__entry__2}{#cicd-GET-app-batch-results__version-RESTAPI} | Nome | Descrição | |-|-| | api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres | | result_id | Sys_id da instalação em lote para a qual as informações de resultados serão retornadas. Este valor é retornado no parâmetro links.results.id do endpoint /sn_cicd/app/batch/install. Tipo de dados: cadeia de caracteres | [Tabela 1. Parâmetros de caminho] {#cicd-GET-app-batch-results__entry__8} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 2. Parâmetros de consulta] {#cicd-GET-app-batch-results__entry__12} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-GET-app-batch-results__entry__16}{#cicd-GET-app-batch-results__accept-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json | [Tabela 4. Cabeçalhos da solicitação] {#cicd-GET-app-batch-results__entry__20} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 5. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-GET-app-batch-results__entry__24}{#cicd-GET-app-batch-results__entry-200-status-code}{#cicd-GET-app-batch-results__row-401-status-code}{#cicd-GET-app-batch-results__row-403-status-code}{#cicd-GET-app-batch-results__row-404-status-code}{#cicd-GET-app-batch-results__row-405-status-code}{#cicd-GET-app-batch-results__row-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 401 | As credenciais do usuário estão incorretas. | | 403 | Proibido. O usuário não é um administrador ou não tem a função sn_cicd.sys_ci_automation. | | 404 | Não encontrado. O item solicitado não foi encontrado. | | 405 | Método inválido. A funcionalidade está inativa. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. | [Tabela 6. Códigos de status] ### Parâmetros do corpo da resposta (JSON ou XML) {#cicd-GET-app-batch-results__entry__38}{#cicd-GET-app-batch-results__row-error} | Nome | Descrição | |-|-| | erro | Mensagens de erro Tipo de dados: cadeia de caracteres | | batch_items | Matriz JSON, em que cada objeto fornece detalhes de uma instalação de pacote. Tipo de dados: matriz "batch_items" [{ "customization_version": "String", "id": "String", "install_date": "String", "name": "String", "notes": "String", "state": "String", "status_message": "String", "type": "String", "url": "String", "version": "String" }] | | batch_items.customization_version | Aplicável somente quando o parâmetro batch_items.type está definido como aplicação ou plug -in e o parâmetro requested_customization_version é passado na solicitação de instalação em lote. Versão da aplicação da loja ou pacote de personalização de plug-in ServiceNow com escopo a ser instalado, como 1.0.2 ou 2.3. Tipo de dados: cadeia de caracteres | | lote_items.id | Sys_id da aplicação ou identificador do plug-in a ser instalado. Igual ao parâmetro packages.id na chamada de endpoint /sn_cicd/app/batch/install inicial. Tipo de dados: cadeia de caracteres | | itens_batch.data_instalação | Data e hora em que o pacote foi instalado. Vazio se a solicitação ainda estiver em andamento. Tipo de dados: cadeia de caracteres | | lote_itens.nome | Nome do pacote. Tipo de dados: cadeia de caracteres | | itens_batch.anotações | Anotações especificadas pelo usuário sobre o pacote. Igual ao parâmetro packages.notes na chamada de endpoint /sn_cicd/app/batch/install inicial. Tipo de dados: cadeia de caracteres | | lote_itens.estado | Estado atual da instalação do pacote associado. Valores possíveis: * Reprovado * Em andamento * Instalado * Inválida * Pronto * Revertido Tipo de dados: cadeia de caracteres | | batch_items.status_message | Descreve todos os erros ocorridos durante a instalação do pacote e/ou personalizações. Tipo de dados: cadeia de caracteres | | lote_itens.tipo | Tipo de aplicação. Igual ao parâmetro packages.type na chamada de endpoint /sn_cicd/app/batch/install inicial. Valores válidos: * aplicação * plug-in {#cicd-GET-app-batch-results__ul_pfk_sbq_2nb} Tipo de dados: cadeia de caracteres | | itens_batch.URL | URL do registro de instalação do pacote associado em sua instância ServiceNow. Tipo de dados: cadeia de caracteres | | itens_batch.versão | Versão do pacote a ser instalado, como 1.0.2 ou 2.3. Igual ao parâmetro packages.requested_version na chamada de endpoint /sn_cicd/app/batch/install inicial. Tipo de dados: cadeia de caracteres | | batch_plan | Descreve o plano em lote de instalação. Tipo de dados: objeto "batch_plan": { "id": "String", "name": "String", "notes": "String", "state": "String", "url": "String" } | | lote_plano.ID | Sys_id das informações de resultados de retorno. Mesmo valor que foi passado no parâmetro de solicitação result_id. Tipo de dados: cadeia de caracteres | | lote_plano.nome | Nome descritivo especificado pelo usuário para esta solicitação em lote. Igual ao parâmetro name na chamada de endpoint /sn_cicd/app/batch/install inicial. Tipo de dados: cadeia de caracteres | | lote_plano.anotações | Anotações que foram passadas quando a instalação em lote foi invocada. Igual ao parâmetro notes na chamada de endpoint /sn_cicd/app/batch/install inicial. Tipo de dados: cadeia de caracteres | | lote_plano.estado | Estado atual da instalação em lote geral. Valores possíveis: * Reprovado * Em andamento * Instalado * Inválida * Instalação parcial * Pronto * Revertido {#cicd-GET-app-batch-results__ul_dyj_sfy_2nb} Tipo de dados: cadeia de caracteres | | lote_plano.url | URL do registro do plano de instalação em lote na sua instância ServiceNow. Tipo de dados: cadeia de caracteres | [ ] ### Solicitação de cURL {#cicd-GET-app-batch-results__example_eyp_wdq_2nb} Este exemplo verifica o status de um plano de instalação em lote chamado Versão 2.0 IT Operations. curl 'instance.servicenow.com/api/sn_cicd/app/batch/results/df24b1e9db2d0110b5e3f6c5ae97c561 \ --request GET \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "batch_plan": { "name":"Release 2.0 IT Operations", "id": "df24b1e9db2d0110b5e3f6c5ae97c561", "url": "https://instance.service-now.com/sys_batch_install_plan.do?sys_id=df24b1e9db2d0110b5e3f6c5ae97c561", "state": "Installed", "notes": "User specified notes for batch install plan", } "batch_items": [ { "name": "com.sn_cicd_spoke", "type": "Application", "version": "7.0.0", "state": "Installed", "install_date": "2020-08-31 15:30:01", "id": "c159b1e9db1c0010b5e3f6c5ae961903", "url":"https://instance.service-now.com/sys_batch_install_item.do?sys_id=c159b1e9db1c0010b5e3f6c5ae961903", "notes" : "" }, { "name": "Customization for CSM App1", "type": "Application", "version": "1.0.0", "state": "Installed", "install_date": "2020-08-31 15:32:01", "id": "e824b1e9db2d1001b5e3f6c5ae97d628", "url": "https://instance.service-now.com/sys_batch_install_item.do?sys_id=e824b1e9db2d1001b5e3f6c5ae97d628", "notes": "Customized headers.", "customization_version": "2.1.1", "status_message": "" }] } } ## IC/CD - GET /sn_cicd/instance_scan/result/{progress_id} {#ariaid-title3} Retorna o andamento e o status atuais da função de verificação da instância de IC/CD associada a um ID de andamento aprovado. Chame este método depois de chamar um dos outros endpoints de IC/CD de verificação de instância, como /sn_cicd/instance_scan/full_scan ou /sn_cicd/instance_scan/point_scan. Nota: Este endpoint faz parte da API CICD Instance Scan Execution Service e é usado no namespace sn_cicd. ### Formato da URL URL com controle de versão: /api/sn_cicd/{api_version}/instance_scan/result/{progress_id} URL padrão: /api/sn_cicd/instance_scan/result/{progress_id} ### Parâmetros de solicitação compatíveis {#cicd-GET-instancescan-result__entry__2}{#cicd-GET-instancescan-result__version-RESTAPI} | Parâmetro | Descrição | |-|-| | api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres | | progress_id | Identificador exclusivo da função para a qual as informações de andamento serão retornadas. Este valor é retornado no parâmetro links.progress.id do endpoint que iniciou a ação, como /sn_cicd/instance_scan/full_scan ou /sn_cicd/instance_scan/point_scan. Tipo de dados: cadeia de caracteres | [Tabela 7. Parâmetros] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-GET-instancescan-result__entry__8}{#cicd-GET-instancescan-result__accept-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json | [Tabela 8. Cabeçalhos da solicitação] {#cicd-GET-instancescan-result__entry__12} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 9. Cabeçalhos de resposta] ### Códigos de status Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-GET-instancescan-result__table_wwn_rhd_ct__entry__2}{#cicd-GET-instancescan-result__entry-200-status-code}{#cicd-GET-instancescan-result__entry-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 401 | As credenciais do usuário estão incorretas. | | 403 | Proibido. O usuário não é um administrador ou não tem a função sn_cicd.sys_ci_automation. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. | [Tabela 10. Códigos de status] {#cicd-GET-instancescan-result__table_wwn_rhd_ct} ### Corpo da solicitação A API aceita esses elementos JSON ou XML no corpo da solicitação. {#cicd-GET-instancescan-result__table_rm1_yjd_kv__entry__2} | Elemento | Descrição | |-|-| | Nenhum(a) | | [Tabela 11. Elementos aceitos no corpo da solicitação] {#cicd-GET-instancescan-result__table_rm1_yjd_kv} ### Corpo da resposta A API retorna esses elementos JSON ou XML no corpo da resposta. {#cicd-GET-instancescan-result__table_mc1_pr1_tx__entry__2}{#cicd-GET-instancescan-result__entry-error}{#cicd-GET-instancescan-result__entry-link}{#cicd-GET-instancescan-result__entry-links_progress}{#cicd-GET-instancescan-result__entry-progress_url}{#cicd-GET-instancescan-result__entry-links_results}{#cicd-GET-instancescan-result__entry-links_results_id}{#cicd-GET-instancescan-result__entry-links_results_url}{#cicd-GET-instancescan-result__entry-status}{#cicd-GET-instancescan-result__entry-status_detail}{#cicd-GET-instancescan-result__entry-status_label}{#cicd-GET-instancescan-result__entry-healthscan_status_message} | Elemento | Descrição | |-|-| | erro | Mensagens de erro Tipo de dados: cadeia de caracteres | | links | Todos os links e sys_ids associados à resposta. Tipo de dados: objeto "links": { "progress": {Object} } | | links.descobertas | Objeto que contém informações sobre as descobertas da verificação da instância. | | links.descobertas.rótulo | Informações adicionais sobre as descobertas da verificação da instância. | | links.descobertas.URL | URL a ser usada para recuperar uma lista de registros que violaram as verificações. | | links.progress | Descreve as informações do link de andamento. Tipo de dados: objeto "progress": { "id": "String", "url": "String" } | | links.progress.id | Identificador exclusivo do detalhe do andamento. | | links.progress.url | URL a ser usada para recuperar os detalhes do andamento. Tipo de dados: cadeia de caracteres | | links.resultados | Informações dos resultados. Tipo de dados: objeto "results": { "id": "String", "url": "String" } | | links.results.id | Sys_id do registro de resultados da verificação da instância. | | links.resultados.URL | URL a ser usada para obter os resultados da verificação da instância. | | status | Estado de execução numérica. Usado com status_label. Valores: * 0 (Pendente) * 1 (em execução) * 2 (Bem-sucedido) * 3 (com falha) * 4 (Cancelado) Tipo de dados: cadeia de caracteres | | status_detail | Informações adicionais sobre o estado atual. Tipo de dados: cadeia de caracteres | | status_label | Descrição do estado de execução. Usado com status. Valores: * Cancelado(a) * Reprovado * Pendente * Em Execução * Bem-sucedido Tipo de dados: cadeia de caracteres | | status_message | Informações adicionais sobre o motivo da falha da operação. Vazio se a operação for bem-sucedida. Tipo de dados: cadeia de caracteres | [Tabela 12. Elementos retornados no corpo da resposta] {#cicd-GET-instancescan-result__table_mc1_pr1_tx} ### Amostra de solicitação cURL curl 'instance.service-now.com/api/sn_cicd/instance_scan/result/a74c70a11b7800103d374087bc4bcb28' \ --request GET \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "links": { "findings": { "url": "https://instance.service-now.com/api/now/table/scan_finding?sysparm_query%3Dresult%3D6f4cf8651b7800103d374087bc4bcb41%5EORDERBYsys_id", "label": "First 10,000 findings" }, "progress": { "id": "a74c70a11b7800103d374087bc4bcb28", "url": "https://instance.service-now.com/api/sn_cicd/progress/a74c70a11b7800103d374087bc4bcb28" }, "results": { "id": "a74c70a11b7800103d374087bc4bcb28", "url": "https://instance.service-now.com/api/sn_cicd/instance_scan/result/a74c70a11b7800103d374087bc4bcb28" } }, "status": "2", "status_label": "Successful", "status_message": "", "status_detail": "", "error": "" } } ## IC/CD - GET /sn_cicd/progress/{progress_id} {#ariaid-title4} Retorna o andamento atual e o status da função Integração e entrega contínuas (CICD) associada a um ID de andamento especificado. Chame este método depois de chamar um dos endpoints de CICD assíncronos, como /sn_cicd/app_repo/publish, /sn_cicd/app_repo/install, /sn_cicd/testsuite/runou /sn_cicd/sc/apply_stash. ### Formato da URL {#cicd-GET-progress__section_jcv_cwv_ylb} URL com controle de versão: /api/sn_cicd/{api_version}/progress/{progress_id} URL padrão: /api/sn_cicd/progress/{progress_id} ### Parâmetros de solicitação compatíveis {#cicd-GET-progress__entry__2}{#cicd-GET-progress__version-RESTAPI} | Nome | Descrição | |-|-| | api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres | | progress_id | Identificador exclusivo da função para a qual as informações de andamento serão retornadas. Este valor é retornado no parâmetro links.progress.id do endpoint que iniciou a ação, como /sn_cicd/app_repo/publish, /sn_cicd/app_repo/install, /sn_cicd/testsuite/runou /sn_cicd/sc/apply_stash. Tipo de dados: cadeia de caracteres | [Tabela 13. Parâmetros de caminho] {#cicd-GET-progress__entry__8} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 14. Parâmetros de consulta] {#cicd-GET-progress__entry__12} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 15. Parâmetros do corpo da solicitação (XML ou JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-GET-progress__entry__16}{#cicd-GET-progress__accept-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json | [Tabela 16. Cabeçalhos da solicitação] {#cicd-GET-progress__entry__20} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 17. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-GET-progress__entry__24}{#cicd-GET-progress__entry-200-status-code}{#cicd-GET-progress__row-401-status-code}{#cicd-GET-progress__row-403-status-code}{#cicd-GET-progress__row-404-status-code}{#cicd-GET-progress__row-405-status-code}{#cicd-GET-progress__row-409-status-code}{#cicd-GET-progress__row-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 401 | As credenciais do usuário estão incorretas. | | 403 | Proibido. O usuário não é um administrador ou não tem a função sn_cicd.sys_ci_automation. | | 404 | Não encontrado. O item solicitado não foi encontrado. | | 405 | Método inválido. A funcionalidade está inativa. | | 409 | Conflito. O item solicitado não é exclusivo. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. | [Tabela 18. Códigos de status] ### Parâmetros do corpo da resposta (JSON ou XML) {#cicd-GET-progress__entry__40}{#cicd-GET-progress__row-error}{#cicd-GET-progress__row-link}{#cicd-GET-progress__row-links_progress}{#cicd-GET-progress__row-links_progress_id}{#cicd-GET-progress__row-links_progress_url}{#cicd-GET-progress__row-links_results}{#cicd-GET-progress__row-links_results_id}{#cicd-GET-progress__row-links_results_url}{#cicd-GET-progress__row-links_source}{#cicd-GET-progress__row-links_source_id}{#cicd-GET-progress__row-links_source_url}{#cicd-GET-progress__row-percent_complete}{#cicd-GET-progress__row-status}{#cicd-GET-progress__row-status_detail}{#cicd-GET-progress__row-status_label}{#cicd-GET-progress__row-status_message} | Nome | Descrição | |-|-| | erro | Mensagens de erro Tipo de dados: cadeia de caracteres | | links | Todos os links e sys_ids associados à resposta. Tipo de dados: objeto "links": { "progress": {Object} } | | links.progress | Descreve as informações do link de andamento. Tipo de dados: objeto "progress": { "id": "String", "url": "String" } | | links.progress.id | Identificador exclusivo a ser usado para obter os detalhes do andamento da operação. Use este valor ao chamar o endpoint /sn_cicd/progress/{progress_id}. Tipo de dados: cadeia de caracteres | | links.progress.url | URL a ser usada para recuperar os detalhes do andamento. Tipo de dados: cadeia de caracteres | | links.resultados | Informações dos resultados. Tipo de dados: objeto "results": { "id": "String", "url": "String" } | | links.results.id | Identificador exclusivo das informações de resultados. Use este valor ao chamar o endpoint de resultados associados. Tipo de dados: cadeia de caracteres | | links.resultados.URL | URL a ser usada para obter os resultados da execução do endpoint, como resultados. Tipo de dados: cadeia de caracteres | | links.origem | Informações de origem. Tipo de dados: objeto "source": { "id": "String", "url": "String" } | | links.source.id | Identificador exclusivo do registro de origem na tabela Rastreador de execução \[sys_execution_tracker\]. Tipo de dados: cadeia de caracteres | | links.origem.url | URL a ser usada para obter as informações de origem na tabela Rastreador de execução \[sys_execution_tracker\]. Tipo de dados: cadeia de caracteres | | links.stash | Se um foi criado durante uma operação [apply_changes](https://servicenow-prod.fluidtopics.net/~Tfwy9xIj2f0IqLxE71S1A#cicd-POST-sc-apply_changes "Inicia a aplicação de mudanças de um controle de código-fonte remoto a uma aplicação local ou personalização de aplicação especificada."), este objeto conterá informações sobre o stash. Este objeto não será retornado se um stash não tiver sido criado. Tipo de dados: objeto "stash": { "id": "String", "url": "String" } | | links.stash.id | Identificador exclusivo do stash criado. Use este valor ao chamar o endpoint [IC/CD - POST /sn_cicd/sc/apply_stash/{stash_id}](https://servicenow-prod.fluidtopics.net/~Tfwy9xIj2f0IqLxE71S1A#cicd-POST-sc-apply_stash "Inicia a aplicação de um \"estoque\" gerado anteriormente de mudanças de um controle de código-fonte remoto para uma aplicação local ou personalização de aplicação especificada.") para aplicar o stash. Tipo de dados: cadeia de caracteres | | links.stash.URL | URL do stash associado. Tipo de dados: cadeia de caracteres | | percent_complete | Porcentagem da solicitação que está concluída. Tipo de dados: número | | status | Estado de execução numérica. Usado com status_label. Valores: * 0 (Pendente) * 1 (em execução) * 2 (Bem-sucedido) * 3 (com falha) * 4 (Cancelado) Tipo de dados: cadeia de caracteres | | status_detail | Informações adicionais sobre o estado atual. Tipo de dados: cadeia de caracteres | | status_label | Descrição do estado de execução. Usado com status. Valores: * Cancelado(a) * Reprovado * Pendente * Em Execução * Bem-sucedido Tipo de dados: cadeia de caracteres | | status_message | Descrição do estado atual. Tipo de dados: cadeia de caracteres | [ ] ### Obter o andamento de uma execução de pacote de testes curl 'instance.servicenow.com/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd' \ --request GET \ --header 'Accept: application/json' \ --user 'username':'password' Andamento da chamada para aplicar mudanças. { "result": { "links": { "progress": { "id": "a4fae8911bdc00103d374087bc4bcbbd", "url": "https://instance.servicenow.com/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd" }, "source": { "id": "59c4c4d11b5c00103d374087bc4bcb26", "url": "https://instance.servicenow.com/api/now/table/sys_app/59c4c4d11b5c00103d374087bc4bcb26" } }, "status": "2", "status_label": "Successful", "status_message": "This operation succeeded", "status_detail": "Successfully applied commit 1f14e11a7dedcbfa194beb5875fcdaa15ed8accb from source control", "error": "", "percent_complete": 100 } } ### Obtenha o andamento de uma chamada para aplicar mudanças. Nesse caso, havia mudanças não salvas/não confirmadas na instância no Studio, portanto, um stash foi criado para manter as mudanças não salvas curl 'instance.servicenow.com/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd' \ --request GET \ --header 'Accept: application/json' \ --user 'username':'password' Andamento no fornecimento de informações sobre o stash criado. { "result": { "links": { "progress": { "id": "5b12eca4e0429110f8771827f8fd36a4", "url": "https://instance.servicenow.com/api/sn_cicd/progress/5b12eca4e0429110f8771827f8fd36a4" }, "stash": { "id": "fc2224e4e0429110f8771827f8fd3634", "url": "https://instance.servicenow.com/api/sn_cicd/sc/apply_stash/fc2224e4e0429110f8771827f8fd3634" } }, "status": "2", "status_label": "Successful", "status_message": "This operation succeeded", "status_detail": "Successfully applied commit fa5626f6f1f7fef677c16b4a0dd8b22ba8a6e311 from source control", "error": "", "percent_complete": 100 } } ### Solicitação de cURL {#cicd-GET-progress__example_k4r_rrk_z5b} curl 'instance.servicenow.com/api/sn_cicd/progress/5b12eca4e0429110f8771827f8fd36a4' \ --request GET \ --header 'Accept: application/json' \ --user 'username':'password' Andamento de uma execução de pacote de testes (/sn_cicd/testsuite/run). { "result": { "links": { "progress": { "id": "e891389d1b1040103d374087bc4bcb75", "url": "https://instance.servicenow.com/api/sn_cicd/progress/e891389d1b1040103d374087bc4bcb75" }, "results": { "id": "2891389d1b1040103d374087bc4bcb09", "url": "https://instance.servicenow.com/api/sn_cicd/testsuite/results/2891389d1b1040103d374087bc4bcb09" } }, "status": "2", "status_label": "Successful", "status_message": "Suite passed", "status_detail": "Suite passed", "error": "", "percent_complete": 100 } } ## IC/CD - GET /sn_cicd/testsuite/results/{result_id} {#ariaid-title5} Retorna os resultados de uma execução de pacote de testes com base em um identificador de resultados especificado. Chame este endpoint depois de chamar /sn_cicd/progress/{progress_id} para obter o resultado do pacote de testes executado. ### Formato da URL {#cicd-GET-testsuite-results__section_od3_myv_ylb} URL com controle de versão: /api/sn_cicd/{api_version}/testsuite/results/{result_id} URL padrão: /api/sn_cicd/testsuite/results/{result_id} ### Parâmetros de solicitação compatíveis {#cicd-GET-testsuite-results__entry__2}{#cicd-GET-testsuite-results__version-RESTAPI} | Nome | Descrição | |-|-| | api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres | | result_id | Identificador exclusivo dos resultados do pacote de testes a serem recuperados. A chamada de endpoint /sn_cicd/progress/{progress_id} correspondente retorna essas informações. Tipo de dados: cadeia de caracteres | [Tabela 19. Parâmetros de caminho] {#cicd-GET-testsuite-results__entry__8} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 20. Parâmetros de consulta] {#cicd-GET-testsuite-results__entry__12} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 21. Parâmetros do corpo da solicitação (XML ou JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-GET-testsuite-results__entry__16}{#cicd-GET-testsuite-results__accept-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json | [Tabela 22. Cabeçalhos da solicitação] {#cicd-GET-testsuite-results__entry__20} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 23. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-GET-testsuite-results__entry__24}{#cicd-GET-testsuite-results__entry-200-status-code}{#cicd-GET-testsuite-results__row-401-status-code}{#cicd-GET-testsuite-results__row-403-status-code}{#cicd-GET-testsuite-results__row-404-status-code}{#cicd-GET-testsuite-results__row-405-status-code}{#cicd-GET-testsuite-results__row-409-status-code}{#cicd-GET-testsuite-results__row-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 401 | As credenciais do usuário estão incorretas. | | 403 | Proibido. O usuário não é um administrador ou não tem a função sn_cicd.sys_ci_automation. | | 404 | Não encontrado. O item solicitado não foi encontrado. | | 405 | Método inválido. A funcionalidade está inativa. | | 409 | Conflito. O item solicitado não é exclusivo. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. | [Tabela 24. Códigos de status] ### Parâmetros do corpo da resposta (JSON ou XML) {#cicd-GET-testsuite-results__entry__40}{#cicd-GET-testsuite-results__entry-error}{#cicd-GET-testsuite-results__entry-link}{#cicd-GET-testsuite-results__entry-links_results}{#cicd-GET-testsuite-results__entry-links_results_id}{#cicd-GET-testsuite-results__entry-links_results_url}{#cicd-GET-testsuite-results__entry-percent_complete}{#cicd-GET-testsuite-results__entry-status}{#cicd-GET-testsuite-results__entry-status_detail}{#cicd-GET-testsuite-results__entry-status_label}{#cicd-GET-testsuite-results__entry-status_message} | Nome | Descrição | |-|-| | resultados_do_pacote_crianças | Resultados de pacotes de testes aninhados. O formato deste conteúdo é o mesmo do teste primário. | | erro | Mensagens de erro Tipo de dados: cadeia de caracteres | | links | Objeto que contém todos os links e sys_ids associados à resposta. Tipo de dados: objeto | | links.resultados | Objeto que contém as informações dos resultados. Tipo de dados: objeto | | links.results.id | Identificador exclusivo das informações de resultados. Use este valor ao chamar o endpoint /sn_cicd/testsuite/results/{result_id}. Tipo de dados: cadeia de caracteres | | links.resultados.URL | URL a ser usada para obter os resultados da execução do endpoint, como resultados. Tipo de dados: cadeia de caracteres | | percent_complete | Porcentagem da solicitação que está concluída. | | rolledup_test_error_count | Número de testes com erros. Tipo de dados: número | | rolledup_test_failure_count | Número de testes com falha. Tipo de dados: número | | rolledup_test_skip_count | Número de testes que foram ignorados. Tipo de dados: número | | rolledup_test_success_count | Número de testes executados com sucesso. Tipo de dados: número | | status | Estado de execução numérica. Usado com status_label, como 0: Pendente. Valores: * 0 (Pendente) * 1 (em execução) * 2 (Bem-sucedido) * 3 (com falha) * 4 (Cancelado) {#cicd-GET-testsuite-results__ul_qm3_pzg_w3b} Tipo de dados: cadeia de caracteres | | status_detail | Informações adicionais sobre o estado atual. Tipo de dados: cadeia de caracteres | | status_label | Descrição do estado de execução. Usado com status, como 0: Pendente. Valores: * Pendente * Em Execução * Bem-sucedido * Reprovado * Cancelado(a) {#cicd-GET-testsuite-results__ul_hhg_wzg_w3b} Tipo de dados: cadeia de caracteres | | status_message | Descrição do estado atual. Tipo de dados: cadeia de caracteres | | test_suite_duration | Quantidade de tempo necessária para executar o pacote de testes. Unidade: segundos Tipo de dados: cadeia de caracteres | | test_suite_name | Nome do pacote de testes. Tipo de dados: cadeia de caracteres | | test_suite_status | Estado do pacote de testes. Tipo de dados: cadeia de caracteres | [ ] ### Solicitação de cURL curl 'instance.servicenow.com/api/sn_cicd/testsuite/results/2891389d1b1040103d374087bc4bcb09' \ --request GET \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "links": { "results": { "id": "2891389d1b1040103d374087bc4bcb09", "url": "https://instance.servicenow.com/sys_atf_test_suite_result.do?sys_id=2891389d1b1040103d374087bc4bcb09" } }, "status": "2", "status_label": "Successful", "status_message": "", "status_detail": "", "error": "", "test_suite_status": "success", "test_suite_duration": "1 Second", "rolledup_test_success_count": 1, "rolledup_test_failure_count": 0, "rolledup_test_error_count": 0, "rolledup_test_skip_count": 0, "test_suite_name": "Quick Test", "child_suite_results": [] } } ## IC/CD - POST /sn_cicd/app/batch/install {#ariaid-title6} Instala dois ou mais pacotes em um único lote especificado. Um lote pode conter qualquer combinação dos seguintes tipos: * Aplicação: * Aplicações com escopo no ServiceNow Store que não pertencem à sua empresa * Aplicações com escopo ou globais no repositório de aplicações que pertencem à sua empresa * Suas personalizações de aplicações para aplicações da Store no repositório de aplicações {#cicd-POST-app-batch-install__ul_plg_s4l_znb} * ServiceNow plug-in: Personalizações de aplicações para aplicações com escopo que foram empacotadas em um plug-in e publicadas no repositório de aplicações. {#cicd-POST-app-batch-install__ul_f1s_kpp_2nb} Nota: Este endpoint usa um modelo de resposta assíncrona. Quando você chama um endpoint, ele inicia a função associada, como iniciar a execução do plano de instalação em lote. O endpoint retorna uma mensagem de resposta que contém o status de execução da função solicitada, normalmente Pendente, junto com um identificador e link exclusivos. Use essas informações para obter informações adicionais sobre o andamento ou os resultados da solicitação. ### Formato da URL URL com controle de versão: /api/sn_cicd/{api_version}/app/batch/install URL padrão: /api/sn_cicd/app/batch/install ### Parâmetros de solicitação compatíveis {#cicd-POST-app-batch-install__entry__2}{#cicd-POST-app-batch-install__version-RESTAPI} | Nome | Descrição | |-|-| | api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres | [Tabela 25. Parâmetros de caminho] {#cicd-POST-app-batch-install__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 26. Parâmetros de consulta] {#cicd-POST-app-batch-install__entry__10} | Nome | Descrição | |-|-| | nome | Obrigatório. Nome descritivo especificado pelo usuário para esta solicitação em lote. Tipo de dados: cadeia de caracteres | | anotações | O usuário especificou anotações adicionais sobre o plano de instalação em lote. Tipo de dados: cadeia de caracteres Padrão: nulo | | pacotes | Obrigatório. Matriz JSON, em que cada objeto especifica detalhes de um pacote a ser instalado. Tipo de dados: matriz "packages": [{ "id": "String", "load_demo_data": Boolean, "notes": "String", "requested_customization_version": "String", "requested_version": "String", "type": "String" }] | | pacotes.id | Obrigatório. Sys_id da aplicação ou identificador do plug-in a ser instalado. Tipo de dados: cadeia de caracteres | | pacotes.carregar_demo_dados | Sinalizador que indica se os dados de demonstração são carregados ao instalar o pacote. Valores válidos: * verdadeiro: os dados de demonstração devem ser carregados. * falso: os dados de demonstração não devem ser carregados. Tipo de dados: booliano Padrão: falso | | pacotes.anotações | Anotações especificadas pelo usuário sobre o pacote. Tipo de dados: cadeia de caracteres Padrão: nulo | | pacotes.requested_customization_version | Versão da personalização da aplicação para a aplicação da loja ou para o plug-in ServiceNow com escopo a ser instalado, como 1.0.2 ou 2.3. Tipo de dados: cadeia de caracteres Padrão: nenhum. Se este parâmetro não estiver definido, o sistema não procurará personalizações para a aplicação. | | pacotes.requested_version | Obrigatório se packages.type estiver definido como aplicação; ignorado se definido como plug-in . Versão do pacote a ser instalado, como 1.0.2 ou 2.3. Tipo de dados: cadeia de caracteres | | pacotes.tipo | Obrigatório. Tipo de pacote. Valores válidos: * aplicação * plug-in {#cicd-POST-app-batch-install__ul_pfk_sbq_2nb} Tipo de dados: cadeia de caracteres | [Tabela 27. Parâmetros do corpo da solicitação (XML ou JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-app-batch-install__entry__30}{#cicd-POST-app-batch-install__accept-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json | [Tabela 28. Cabeçalhos da solicitação] {#cicd-POST-app-batch-install__entry__34} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 29. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-app-batch-install__entry__38}{#cicd-POST-app-batch-install__entry-200-status-code}{#cicd-POST-app-batch-install__entry-405-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 401 | As credenciais do usuário estão incorretas. | | 403 | Proibido. O usuário não é um administrador ou não tem a função sn_cicd.sys_ci_automation. | | 405 | Método inválido. A funcionalidade está desabilitada. | [Tabela 30. Códigos de status] ### Parâmetros do corpo da resposta (JSON ou XML) {#cicd-POST-app-batch-install__entry__48}{#cicd-POST-app-batch-install__row-error}{#cicd-POST-app-batch-install__row-link}{#cicd-POST-app-batch-install__row-links_progress}{#cicd-POST-app-batch-install__row-links_progress_id}{#cicd-POST-app-batch-install__row-links_progress_url}{#cicd-POST-app-batch-install__row-percent_complete}{#cicd-POST-app-batch-install__row-status}{#cicd-POST-app-batch-install__row-status_detail}{#cicd-POST-app-batch-install__row-status_label}{#cicd-POST-app-batch-install__row-status_message} | Nome | Descrição | |-|-| | erro | Mensagens de erro Tipo de dados: cadeia de caracteres | | links | Todos os links e sys_ids associados à resposta. Tipo de dados: objeto "links": { "progress": {Object}, "results": {Object}, "rollback": {Object} } | | links.progress | Descreve as informações do link de andamento. Tipo de dados: objeto "progress": { "id": "String", "url": "String" } | | links.progress.id | Identificador exclusivo a ser usado para obter os detalhes do andamento da operação. Use este valor ao chamar o endpoint /sn_cicd/progress/{progress_id}. Tipo de dados: cadeia de caracteres | | links.progress.url | URL a ser usada para recuperar os detalhes do andamento. Tipo de dados: cadeia de caracteres | | links.resultados | Descreve as informações do link de resultados. Tipo de dados: objeto "results": { "id": "String", "url": "String" } | | links.results.id | Sys_id dos resultados da chamada de endpoint em lote. Use este valor ao chamar o endpoint especificado em links.results.url para consultar os resultados da instalação em lote. Tipo de dados: cadeia de caracteres | | links.resultados.URL | URL a ser usada para recuperar os resultados da instalação em lote. Tipo de dados: cadeia de caracteres | | links.reversão | Descreve as informações de reversão de instalação em lote. Tipo de dados: objeto "rollback": { "id": "String" } | | links.rollback.id | Sys_id dos detalhes de reversão dos pacotes instalados. Use este parâmetro para reverter a instalação dos pacotes especificados para suas versões anteriores usando o endpoint /sn_cicd/app/batch/rollback/{rollback_id}. Nota: A capacidade de reversão só estará disponível após a conclusão da instalação. Tipo de dados: cadeia de caracteres | | percent_complete | Porcentagem da solicitação que está concluída. Tipo de dados: número | | status | Estado de execução numérica. Usado com status_label. Valores: * 0 (Pendente) * 1 (em execução) * 2 (Bem-sucedido) * 3 (com falha) * 4 (Cancelado) Tipo de dados: cadeia de caracteres | | status_detail | Informações adicionais sobre o estado atual. Tipo de dados: cadeia de caracteres | | status_label | Descrição do estado de execução. Usado com status. Valores: * Cancelado(a) * Reprovado * Pendente * Em Execução * Bem-sucedido Tipo de dados: cadeia de caracteres | | status_message | Descrição do estado atual. Tipo de dados: cadeia de caracteres | [ ] ### Solicitação de cURL {#cicd-POST-app-batch-install__example_eyp_wdq_2nb} Este exemplo inicia uma instalação em lote chamada Implantação da versão 2.2 que contém três pacotes (um de cada tipo) para instalar. curl 'instance.servicenow.com/api/sn_cicd/app/batch/install \ --request POST \ --header 'Accept: application/json' \ --user 'username':'password' \ --data { "name": "Release 2.2 Deployment", "packages": [ { "id": "syd_id_abcefghi", "type": "application", "load_demo_data": false, "requested_version": "1.0.2", "notes": "User specific text to describe this application install" }, { "id": "syd_id_defabcde", "type": "application", "requested_version": "1.0.0", "requested_customization_version": "2.0.7", "notes": "Customization for CSM App1" }, { "id": "com.glide.some.plugin", "type": "plugin", "load_demo_data": true, "notes": "Plugin related notes" }] } { "result": { "links": { "progress": { "id": "c159b1e9db1c0010b5e3f6c5ae961903", "url": "https://instance.servicenow.com/api/sn_cicd/progress/c159b1e9db1c0010b5e3f6c5ae961903" }, "results": { "id": "df24b1e9db2d0110b5e3f6c5ae97c561", "url": "https://instance.servicenow.com/api/sn_cicd/app/batch/results/df24b1e9db2d0110b5e3f6c5ae97c561" }, "rollback":{ "id": "a329f82e871da64c724ba21c82a764f2" }, }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "", "percent_complete": 0 } } ## IC/CD - POST /sn_cicd/app/batch/rollback/{rollback_id} {#ariaid-title7} Reverte todos os pacotes associados a uma instalação em lote específica para suas versões anteriores. Este endpoint funciona em conjunto com o endpoint /sn_cicd/app/batch/install. O rollback_id é fornecido nos resultados de retorno deste endpoint. Quando este endpoint é chamado, ele reverte todos os pacotes especificados na instalação associada; você não pode reverter pacotes individuais. Se não houver uma versão anterior, o endpoint desinstalará o pacote associado. Nota: Este endpoint usa um modelo de resposta assíncrona. Quando você chama um endpoint, ele inicia a função associada, como iniciar a execução do plano de instalação em lote. O endpoint retorna uma mensagem de resposta que contém o status de execução da função solicitada, normalmente Pendente, junto com um identificador e link exclusivos. Use essas informações para obter informações adicionais sobre o andamento ou os resultados da solicitação. ### Formato da URL URL com controle de versão: /api/sn_cicd/{api_version}/app/batch/rollback/{rollback_id} URL padrão: /api/sn_cicd/app/batch/rollback/{rollback_id} ### Parâmetros de solicitação compatíveis {#cicd-POST-app-batch-rollback__entry__2}{#cicd-POST-app-batch-rollback__version-RESTAPI} | Nome | Descrição | |-|-| | api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres | | rollback_id | Sys_id do plano de instalação em lote para o qual os pacotes instalados serão revertidos para suas versões anteriores. Este valor é retornado no parâmetro links.rollback.id do endpoint /sn_cicd/app/batch/install. Tipo de dados: cadeia de caracteres | [Tabela 31. Parâmetros de caminho] {#cicd-POST-app-batch-rollback__entry__8} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 32. Parâmetros de consulta] {#cicd-POST-app-batch-rollback__entry__12} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 33. Parâmetros do corpo da solicitação (XML ou JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-app-batch-rollback__entry__16}{#cicd-POST-app-batch-rollback__accept-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json | [Tabela 34. Cabeçalhos da solicitação] {#cicd-POST-app-batch-rollback__entry__20} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 35. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-app-batch-rollback__entry__24}{#cicd-POST-app-batch-rollback__entry-200-status-code}{#cicd-POST-app-batch-rollback__row-401-status-code}{#cicd-POST-app-batch-rollback__row-403-status-code}{#cicd-POST-app-batch-rollback__row-404-status-code}{#cicd-POST-app-batch-rollback__row-405-status-code}{#cicd-POST-app-batch-rollback__row-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 401 | As credenciais do usuário estão incorretas. | | 403 | Proibido. O usuário não é um administrador ou não tem a função sn_cicd.sys_ci_automation. | | 404 | Não encontrado. O item solicitado não foi encontrado. | | 405 | Método inválido. A funcionalidade está inativa. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. | [Tabela 36. Códigos de status] ### Parâmetros do corpo da resposta (JSON ou XML) {#cicd-POST-app-batch-rollback__entry__38}{#cicd-POST-app-batch-rollback__row-error}{#cicd-POST-app-batch-rollback__row-link}{#cicd-POST-app-batch-rollback__row-links_progress}{#cicd-POST-app-batch-rollback__row-links_progress_id}{#cicd-POST-app-batch-rollback__row-links_progress_url}{#cicd-POST-app-batch-rollback__row-percent_complete}{#cicd-POST-app-batch-rollback__row-status}{#cicd-POST-app-batch-rollback__row-status_detail}{#cicd-POST-app-batch-rollback__row-status_label}{#cicd-POST-app-batch-rollback__row-status_message} | Nome | Descrição | |-|-| | erro | Mensagens de erro Tipo de dados: cadeia de caracteres | | links | Todos os links e sys_ids associados à resposta. Tipo de dados: objeto "links": { "progress": {Object} } | | links.progress | Descreve as informações do link de andamento. Tipo de dados: objeto "progress": { "id": "String", "url": "String" } | | links.progress.id | Identificador exclusivo a ser usado para obter os detalhes do andamento da operação. Use este valor ao chamar o endpoint /sn_cicd/progress/{progress_id}. Tipo de dados: cadeia de caracteres | | links.progress.url | URL a ser usada para recuperar os detalhes do andamento. Tipo de dados: cadeia de caracteres | | percent_complete | Porcentagem da solicitação que está concluída. Tipo de dados: número | | status | Estado de execução numérica. Usado com status_label. Valores: * 0 (Pendente) * 1 (em execução) * 2 (Bem-sucedido) * 3 (com falha) * 4 (Cancelado) Tipo de dados: cadeia de caracteres | | status_detail | Informações adicionais sobre o estado atual. Tipo de dados: cadeia de caracteres | | status_label | Descrição do estado de execução. Usado com status. Valores: * Cancelado(a) * Reprovado * Pendente * Em Execução * Bem-sucedido Tipo de dados: cadeia de caracteres | | status_message | Descrição do estado atual. Tipo de dados: cadeia de caracteres | [ ] ### Solicitação de cURL {#cicd-POST-app-batch-rollback__example_eyp_wdq_2nb} Este exemplo reverte todos os pacotes no plano em lote de instalação especificado para a versão anterior. curl 'instance.servicenow.com/api/sn_cicd/app/batch/rollback/a329f82e871da64c724ba21c82a764f2 \ --request POST \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "links": { "progress": { "id": "c159b1e9db1c0010b5e3f6c5ae961903", "url": "https://instance.servicenow.com/api/sn_cicd/progress/c159b1e9db1c0010b5e3f6c5ae961903" }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "", "percent_complete": 0 } } ## IC/CD - POST /sn_cicd/app_repo/install {#ariaid-title8} Instala a aplicação especificada do repositório de aplicações na instância que faz a chamada do endpoint. Usando este endpoint, você pode instalar o sistema base ServiceNow StoreServiceNow e aplicações \[\], plug-ins ServiceNow personalizados e suas próprias aplicações ServiceNow. A seguir descreve os parâmetros que você precisa passar para implementar casos de uso específicos. Todos os parâmetros não especificados não são passados e usam os padrões associados. * Para instalar somente a aplicação base e não as personalizações da aplicação correspondentes. * sys_id: Sys_id da aplicação base que foi personalizada. * base_app_version: versão da aplicação base a ser instalada. {#cicd-POST-app_repo-install__ul_mwp_zly_hnb} * Para instalar uma versão especificada das personalizações da aplicação e instalar automaticamente a versão da aplicação base recomendada. A versão da aplicação base recomendada é a versão da aplicação base que estava instalada na instância no momento em que as personalizações foram publicadas pela última vez. Cada versão de personalizações da aplicação tem uma versão da aplicação base recomendada correspondente. * sys_id: Sys_id da aplicação que foi personalizada. * auto_upgrade_base_app: verdadeiro * version: versão das personalizações da aplicação a serem instaladas. {#cicd-POST-app_repo-install__ul_c5t_wly_hnb} * Para instalar a versão mais recente das personalizações da aplicação e sua versão da aplicação base recomendada correspondente. * sys_id: Sys_id da aplicação que foi personalizada. * auto_upgrade_base_app: verdadeiro {#cicd-POST-app_repo-install__ul_iwh_dmy_hnb} * Para instalar a versão mais recente das personalizações da aplicação, mas não fazer upgrade da aplicação base para a versão da aplicação base recomendada de personalizações da aplicação. * sys_id: Sys_id da aplicação que foi personalizada. * auto_upgrade_base_app: falso {#cicd-POST-app_repo-install__ul_hp1_bny_hnb} * Para instalar personalizações da aplicação junto com o plug-in ServiceNow com escopo da versão atual. * escopo: escopo do plug-in que foi personalizado OU * sys_id: Sys_id da aplicação que foi personalizada. Este não é o ID do plug-in. * version: versão das personalizações da aplicação a serem instaladas. {#cicd-POST-app_repo-install__ul_qs4_vvq_spb} * Para instalar personalizações de aplicação para um plug-in com escopo já instalado e ativado. * sys_id: Sys_id da aplicação que foi personalizada. Este não é o ID do plug-in. * auto_upgrade_base_app: falso * version: versão das personalizações da aplicação a serem instaladas. {#cicd-POST-app_repo-install__ul_ubt_jh5_mpb} Como os plug-ins de base podem ter apenas uma versão por versão da família, os parâmetros auto_upgrade_base_app e base_app_version não se aplicam às instalações de personalização da aplicação para plug-ins. Para ativar um plug-in pela primeira vez em uma instância, use o endpoint /sn_cicd/plugin/{plugin_id}/activate. Nota: Este endpoint usa um modelo de resposta assíncrona. Quando você chama um endpoint, ele inicia a função associada, como iniciar a execução do plano de instalação em lote. O endpoint retorna uma mensagem de resposta que contém o status de execução da função solicitada, normalmente Pendente, junto com um identificador e link exclusivos. Use essas informações para obter informações adicionais sobre o andamento ou os resultados da solicitação. ### Formato da URL {#cicd-POST-app_repo-install__section_jrg_tbw_ylb} URL com controle de versão: /api/sn_cicd/{api_version}/app_repo/install URL padrão: /api/sn_cicd/app_repo/install ### Parâmetros de solicitação compatíveis {#cicd-POST-app_repo-install__entry__2}{#cicd-POST-app_repo-install__version-RESTAPI} | Nome | Descrição | |-|-| | api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres | [Tabela 37. Parâmetros de caminho] {#cicd-POST-app_repo-install__entry__6} | Nome | Descrição | |-|-| | auto_upgrade_base_app | Aplicável somente se você pretender instalar personalizações da aplicação e a aplicação base tiver sido criada em uma versão posterior à versão instalada atualmente. Sinalizador que indica se a aplicação base associada deve ser atualizada automaticamente para uma versão posterior. Valores válidos: * verdadeiro: faz upgrade automaticamente da aplicação base associada. * falso: deixe a aplicação base com a versão atualmente instalada na instância. {#cicd-POST-app_repo-install__ul_nm2_rgx_2nb} Tipo de dados: booliano Padrão: falso | | base_app_version | Versão da aplicação base a ser instalada. Uma aplicação base é qualquer aplicação de terceiros que esteja disponível noServiceNow Store. Se a aplicação não tiver personalizações de aplicação ou se a aplicação tiver personalizações de aplicação e você estiver atualizando somente a aplicação base, insira a versão atualizada da aplicação neste parâmetro. Se você estiver atualizando personalizações da aplicação, não passe este parâmetro, mas sim o parâmetro version. Tipo de dados: cadeia de caracteres Padrão: nulo | | scope | Obrigatório se sys_id não for especificado. Nome do escopo da aplicação, como x_aah_custom_app. Você pode localizar este valor no campo scope na tabela Aplicação personalizada \[sys_app\] ou na tabela Aplicação da loja \[sys_store_app\]. Tipo de dados: cadeia de caracteres | | sys_id | Obrigatório se scope não for especificado. Sys_id da aplicação a ser instalada. Você pode localizar este valor no campo Sys ID na tabela Aplicação personalizada \[sys_app\] ou na tabela Aplicação da loja \[sys_store_app\]. Tipo de dados: cadeia de caracteres | | versão | Versão da aplicação a ser instalada. Tipo de dados: cadeia de caracteres Padrão: se o parâmetro base_app_version estiver vazio e o parâmetro auto_upgrade_base_app estiver definido como verdadeiro, instalará as personalizações de aplicação mais recentes e sua versão da aplicação base recomendada (contanto que não faça o downgrade da aplicação base). Se o parâmetro auto_upgrade_base_app for falso, instalará as personalizações da aplicação, mas a aplicação base não será atualizada. Se o parâmetro base_app_version estiver definido, instalará somente a aplicação base. | [Tabela 38. Parâmetros de consulta] {#cicd-POST-app_repo-install__entry__18} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 39. Parâmetros do corpo da solicitação (XML ou JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-app_repo-install__entry__22}{#cicd-POST-app_repo-install__accept-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json | [Tabela 40. Cabeçalhos da solicitação] {#cicd-POST-app_repo-install__entry__26} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 41. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-app_repo-install__entry__30}{#cicd-POST-app_repo-install__entry-200-status-code}{#cicd-POST-app_repo-install__row-401-status-code}{#cicd-POST-app_repo-install__row-403-status-code}{#cicd-POST-app_repo-install__row-404-status-code}{#cicd-POST-app_repo-install__row-405-status-code}{#cicd-POST-app_repo-install__row-409-status-code}{#cicd-POST-app_repo-install__row-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 401 | As credenciais do usuário estão incorretas. | | 403 | Proibido. O usuário não é um administrador ou não tem a função sn_cicd.sys_ci_automation. | | 404 | Não encontrado. O item solicitado não foi encontrado. | | 405 | Método inválido. A funcionalidade está inativa. | | 409 | Conflito. O item solicitado não é exclusivo. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. | [Tabela 42. Códigos de status] ### Parâmetros do corpo da resposta (JSON ou XML) {#cicd-POST-app_repo-install__entry__46}{#cicd-POST-app_repo-install__row-error}{#cicd-POST-app_repo-install__row-link}{#cicd-POST-app_repo-install__row-links_progress}{#cicd-POST-app_repo-install__row-links_progress_id}{#cicd-POST-app_repo-install__row-links_progress_url}{#cicd-POST-app_repo-install__row-percent_complete}{#cicd-POST-app_repo-install__row-status}{#cicd-POST-app_repo-install__row-status_detail}{#cicd-POST-app_repo-install__row-status_label}{#cicd-POST-app_repo-install__row-status_message} | Nome | Descrição | |-|-| | erro | Mensagens de erro Tipo de dados: cadeia de caracteres | | links | Todos os links e sys_ids associados à resposta. Tipo de dados: objeto "links": { "progress": {Object} } | | links.progress | Descreve as informações do link de andamento. Tipo de dados: objeto "progress": { "id": "String", "url": "String" } | | links.progress.id | Identificador exclusivo a ser usado para obter os detalhes do andamento da operação. Use este valor ao chamar o endpoint /sn_cicd/progress/{progress_id}. Tipo de dados: cadeia de caracteres | | links.progress.url | URL a ser usada para recuperar os detalhes do andamento. Tipo de dados: cadeia de caracteres | | percent_complete | Porcentagem da solicitação que está concluída. Tipo de dados: número | | rollback_version | Se disponível, a versão instalada anteriormente. Se não estiver disponível, será nulo. Tipo de dados: cadeia de caracteres | | status | Estado de execução numérica. Usado com status_label. Valores: * 0 (Pendente) * 1 (em execução) * 2 (Bem-sucedido) * 3 (com falha) * 4 (Cancelado) Tipo de dados: cadeia de caracteres | | status_detail | Informações adicionais sobre o estado atual. Tipo de dados: cadeia de caracteres | | status_label | Descrição do estado de execução. Usado com status. Valores: * Cancelado(a) * Reprovado * Pendente * Em Execução * Bem-sucedido Tipo de dados: cadeia de caracteres | | status_message | Descrição do estado atual. Tipo de dados: cadeia de caracteres | [ ] ### Solicitação de cURL curl 'instance.servicenow.com/api/sn_cicd/app_repo/install?sys_id=2d146921dbd80010caf55268dc9619d8' \ --request POST \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "links": { "progress": { "id": "c159b1e9db1c0010b5e3f6c5ae961903", "url": "https://instance.servicenow.com/api/sn_cicd/progress/c159b1e9db1c0010b5e3f6c5ae961903" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "", "percent_complete": 0, "rollback_version": "1.1.0" } } ## IC/CD - POST /sn_cicd/app_repo/publish {#ariaid-title9} Publica a aplicação especificada e todos os seus artefatos no repositório de aplicações. Nota: Se houver mudanças não confirmadas nos arquivos rastreados quando você chamar este endpoint, ele retornará um código de status 400 Bad Request. Você pode confirmar as mudanças manualmente em Studio ou chamar o endpoint [IC/CD - POST /sn_cicd/sc/apply_changes](https://servicenow-prod.fluidtopics.net/~Tfwy9xIj2f0IqLxE71S1A#cicd-POST-sc-apply_changes "Inicia a aplicação de mudanças de um controle de código-fonte remoto a uma aplicação local ou personalização de aplicação especificada.") para armazenar as mudanças. As mudanças que não são rastreadas na tabela Atualizações do cliente \[sys_update_xml\] são confirmadas automaticamente após a publicação no repositório de aplicações. Para obter informações sobre o layout das mudanças na tabela Atualizações do cliente e uma descrição das mudanças que não estão representadas nesta tabela, consulte [Customer Updates table](https://www.servicenow.com/docs/access?context=r_CustomerUpdatesTable&version=xanadu&pubname=xanadu-platform-security&ft:locale=en-US). ### Formato da URL {#cicd-POST-app_repo-publish__section_zbt_tpb_zlb} URL com controle de versão: /api/sn_cicd/{api_version}/app_repo/publish URL padrão: /api/sn_cicd/app_repo/publish ### Parâmetros de solicitação compatíveis {#cicd-POST-app_repo-publish__entry__2}{#cicd-POST-app_repo-publish__version-RESTAPI} | Nome | Descrição | |-|-| | api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres | [Tabela 43. Parâmetros de caminho] {#cicd-POST-app_repo-publish__entry__6} | Nome | Descrição | |-|-| | dev_notes | Anotações do desenvolvedor a serem armazenadas com a aplicação. Tipo de dados: cadeia de caracteres | | scope | Obrigatório se sys_id não for especificado. O escopo da aplicação. Você pode localizar este valor no campo scope \] na tabela Aplicação personalizada \[sys_app\]. Tipo de dados: cadeia de caracteres | | sys_id | Obrigatório se scope não for especificado. O sys_id da aplicação a ser armazenado no repositório. Você pode localizar este valor no campo Sys ID \] na tabela Aplicação personalizada \[sys_app\]. Tipo de dados: cadeia de caracteres | | versão | Versão sob a qual armazenar a aplicação. Se o número da versão for aprovado, o processo de publicação usará essa versão e atualizará a versão da aplicação local, se for diferente. Se o número da versão não for aprovado, o processo de publicação usará a versão atual da aplicação local e falhará se essa versão existir no repositório de aplicações. Tipo de dados: cadeia de caracteres | [Tabela 44. Parâmetros de consulta] {#cicd-POST-app_repo-publish__entry__16} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 45. Parâmetros do corpo da solicitação (XML ou JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-app_repo-publish__entry__20}{#cicd-POST-app_repo-publish__accept-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json | [Tabela 46. Cabeçalhos da solicitação] {#cicd-POST-app_repo-publish__entry__24} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 47. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-app_repo-publish__entry__28}{#cicd-POST-app_repo-publish__entry-200-status-code}{#cicd-POST-app_repo-publish__row-401-status-code}{#cicd-POST-app_repo-publish__row-403-status-code}{#cicd-POST-app_repo-publish__row-404-status-code}{#cicd-POST-app_repo-publish__row-405-status-code}{#cicd-POST-app_repo-publish__row-409-status-code}{#cicd-POST-app_repo-publish__row-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 400 | Falha na solicitação. Possíveis problemas: * A versão da aplicação não está correta ou é um downgrade. * A aplicação está conectada ao controle de código-fonte e contém mudanças não confirmadas que devem ser resolvidas. Consulte a mensagem de erro retornada para obter informações adicionais. | | 401 | As credenciais do usuário estão incorretas. | | 403 | Proibido. O usuário não é um administrador ou não tem a função sn_cicd.sys_ci_automation. | | 404 | Não encontrado. O item solicitado não foi encontrado. | | 405 | Método inválido. A funcionalidade está inativa. | | 409 | Conflito. O item solicitado não é exclusivo. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. | [Tabela 48. Códigos de status] ### Parâmetros do corpo da resposta (JSON ou XML) {#cicd-POST-app_repo-publish__entry__46}{#cicd-POST-app_repo-publish__row-error}{#cicd-POST-app_repo-publish__row-link}{#cicd-POST-app_repo-publish__row-links_progress}{#cicd-POST-app_repo-publish__row-links_progress_id}{#cicd-POST-app_repo-publish__row-links_progress_url}{#cicd-POST-app_repo-publish__row-percent_complete}{#cicd-POST-app_repo-publish__row-status}{#cicd-POST-app_repo-publish__row-status_detail}{#cicd-POST-app_repo-publish__row-status_label}{#cicd-POST-app_repo-publish__row-status_message} | Nome | Descrição | |-|-| | erro | Mensagens de erro Tipo de dados: cadeia de caracteres | | links | Todos os links e sys_ids associados à resposta. Tipo de dados: objeto "links": { "progress": {Object} } | | links.progress | Descreve as informações do link de andamento. Tipo de dados: objeto "progress": { "id": "String", "url": "String" } | | links.progress.id | Identificador exclusivo a ser usado para obter os detalhes do andamento da operação. Use este valor ao chamar o endpoint /sn_cicd/progress/{progress_id}. Tipo de dados: cadeia de caracteres | | links.progress.url | URL a ser usada para recuperar os detalhes do andamento. Tipo de dados: cadeia de caracteres | | percent_complete | Porcentagem da solicitação que está concluída. Tipo de dados: número | | status | Informações adicionais sobre o estado atual. Tipo de dados: cadeia de caracteres | | status_detail | Informações adicionais sobre o estado atual. Tipo de dados: cadeia de caracteres | | status_label | Descrição do estado de execução. Usado com status. Valores: * Cancelado(a) * Reprovado * Pendente * Em Execução * Bem-sucedido Tipo de dados: cadeia de caracteres | | status_message | Descrição do estado atual. Tipo de dados: cadeia de caracteres | [ ] O exemplo a seguir mostra como publicar a aplicação com o sys_id especificado e todos os seus artefatos no repositório de aplicações. curl 'instance.servicenow.com/api/sn_cicd/app_repo/publish?sys_id=4dd9686d1b9800103d374087bc4bcb3d' \ --request POST \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "links": { "progress": { "id": "d174f8e11bd800103d374087bc4bcbd9", "url": "https://instance.service-now.com/api/sn_cicd/progress/d174f8e11bd800103d374087bc4bcbd9" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "", "percent_complete": 0 } } ## IC/CD - POST /sn_cicd/app_repo/rollback {#ariaid-title10} Inicia uma reversão de uma aplicação especificada para uma versão especificada. Nota: A funcionalidade de reversão só estará disponível após a conclusão da instalação. ### Formato da URL {#cicd-POST-app_repo-rollback__section_hhk_brb_zlb} URL com controle de versão: /api/sn_cicd/{api_version}/app_repo/rollback URL padrão: /api/sn_cicd/app_repo/rollback ### Parâmetros de solicitação compatíveis {#cicd-POST-app_repo-rollback__entry__2}{#cicd-POST-app_repo-rollback__version-RESTAPI} | Nome | Descrição | |-|-| | api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres | [Tabela 49. Parâmetros de caminho] {#cicd-POST-app_repo-rollback__entry__6} | Nome | Descrição | |-|-| | scope | Obrigatório se sys_id não for especificado. O nome do escopo da aplicação a ser revertido. Tipo de dados: cadeia de caracteres | | sys_id | Obrigatório se scope não for especificado. O sys_id da aplicação a ser revertido. Tipo de dados: cadeia de caracteres | | versão | Obrigatório. Versão da aplicação esperada após a operação de reversão. Se a solicitação for para reverter uma instalação de Personalização de app, defina este campo para a versão da aplicação base que o sistema deve ter após a operação de reversão. Tipo de dados: cadeia de caracteres | [Tabela 50. Parâmetros de consulta] {#cicd-POST-app_repo-rollback__entry__14} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 51. Parâmetros do corpo da solicitação (XML ou JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-app_repo-rollback__entry__18}{#cicd-POST-app_repo-rollback__accept-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json | [Tabela 52. Cabeçalhos da solicitação] {#cicd-POST-app_repo-rollback__entry__22} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 53. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-app_repo-rollback__entry__26}{#cicd-POST-app_repo-rollback__entry-200-status-code}{#cicd-POST-app_repo-rollback__row-401-status-code}{#cicd-POST-app_repo-rollback__row-403-status-code}{#cicd-POST-app_repo-rollback__row-405-status-code}{#cicd-POST-app_repo-rollback__row-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 401 | As credenciais do usuário estão incorretas. | | 403 | Proibido. O usuário não é um administrador ou não tem a função sn_cicd.sys_ci_automation. | | 405 | Método inválido. A funcionalidade está inativa. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. | [Tabela 54. Códigos de status] ### Parâmetros do corpo da resposta (JSON ou XML) {#cicd-POST-app_repo-rollback__entry__38}{#cicd-POST-app_repo-rollback__row-error}{#cicd-POST-app_repo-rollback__row-link}{#cicd-POST-app_repo-rollback__row-links_progress}{#cicd-POST-app_repo-rollback__row-links_progress_id}{#cicd-POST-app_repo-rollback__row-links_progress_url}{#cicd-POST-app_repo-rollback__row-percent_complete}{#cicd-POST-app_repo-rollback__row-status}{#cicd-POST-app_repo-rollback__row-status_detail}{#cicd-POST-app_repo-rollback__row-status_label}{#cicd-POST-app_repo-rollback__row-status_message} | Nome | Descrição | |-|-| | erro | Mensagens de erro Tipo de dados: cadeia de caracteres | | links | Todos os links e sys_ids associados à resposta. Tipo de dados: objeto "links": { "progress": {Object} } | | links.progress | Descreve as informações do link de andamento. Tipo de dados: objeto "progress": { "id": "String", "url": "String" } | | links.progress.id | Identificador exclusivo a ser usado para obter os detalhes do andamento da operação. Use este valor ao chamar o endpoint /sn_cicd/progress/{progress_id}. Tipo de dados: cadeia de caracteres | | links.progress.url | URL a ser usada para recuperar os detalhes do andamento. Tipo de dados: cadeia de caracteres | | percent_complete | Porcentagem da solicitação que está concluída. Tipo de dados: número | | status | Estado de execução numérica. Usado com status_label. Valores: * 0 (Pendente) * 1 (em execução) * 2 (Bem-sucedido) * 3 (com falha) * 4 (Cancelado) Tipo de dados: cadeia de caracteres | | status_detail | Informações adicionais sobre o estado atual. Tipo de dados: cadeia de caracteres | | status_label | Descrição do estado de execução. Usado com status. Valores: * Cancelado(a) * Reprovado * Pendente * Em Execução * Bem-sucedido Tipo de dados: cadeia de caracteres | | status_message | Descrição do estado atual. Tipo de dados: cadeia de caracteres | [ ] ### Solicitação de cURL curl 'instance.servicenow.com/api/sn_cicd/app_repo/rollback?sys_id=2d146921dbd80010caf55268dc9619d8&version=1.1.0' \ --request POST \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "links": { "progress": { "id": "f7ddb1eddb1c0010b5e3f6c5ae9619c1", "url": "https://instance.service-now.com/api/sn_cicd/progress/f7ddb1eddb1c0010b5e3f6c5ae9619c1" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "", "percent_complete": 0 } } ## IC/CD - POST /sn_cicd/instance_scan/full_scan {#ariaid-title11} Executa todas as verificações ativas presentes em sua instância. Você pode executar verificações fornecidas com Instance Scan ou pode criar suas próprias verificações. Para obter mais informações, consulte [Verificação de instância](https://www.servicenow.com/docs/access?context=hs-landing-page&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US). Nota: Este endpoint faz parte da API CICD Instance Scan Execution Service e é usado no namespace sn_cicd. ### Formato da URL URL com controle de versão: /api/sn_cicd/{api_version}/instance_scan/full_scan URL padrão: /api/sn_cicd/instance_scan/full_scan ### Parâmetros de solicitação compatíveis {#cicd-POST-instancescan-fullscan__entry__2}{#cicd-POST-instancescan-fullscan__version-RESTAPI} | Parâmetro | Descrição | |-|-| | api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres | [Tabela 55. Parâmetros] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-instancescan-fullscan__entry__6}{#cicd-POST-instancescan-fullscan__accept-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json | [Tabela 56. Cabeçalhos da solicitação] {#cicd-POST-instancescan-fullscan__entry__10} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 57. Cabeçalhos de resposta] ### Códigos de status Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-instancescan-fullscan__table_wwn_rhd_ct__entry__2}{#cicd-POST-instancescan-fullscan__entry-200-status-code}{#cicd-POST-instancescan-fullscan__entry-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 401 | As credenciais do usuário estão incorretas. | | 403 | Proibido. O usuário não é um administrador ou não tem a função sn_cicd.sys_ci_automation. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. | [Tabela 58. Códigos de status] {#cicd-POST-instancescan-fullscan__table_wwn_rhd_ct} ### Corpo da solicitação A API aceita esses elementos JSON ou XML no corpo da solicitação. {#cicd-POST-instancescan-fullscan__table_rm1_yjd_kv__entry__2} | Elemento | Descrição | |-|-| | Nenhum(a) | | [Tabela 59. Elementos aceitos no corpo da solicitação] {#cicd-POST-instancescan-fullscan__table_rm1_yjd_kv} ### Corpo da resposta A API retorna esses elementos JSON ou XML no corpo da resposta. {#cicd-POST-instancescan-fullscan__table_mc1_pr1_tx__entry__2}{#cicd-POST-instancescan-fullscan__entry-error}{#cicd-POST-instancescan-fullscan__entry-link}{#cicd-POST-instancescan-fullscan__entry-links_progress}{#cicd-POST-instancescan-fullscan__entry-progress_url}{#cicd-POST-instancescan-fullscan__entry-status}{#cicd-POST-instancescan-fullscan__entry-status_detail}{#cicd-POST-instancescan-fullscan__entry-status_label}{#cicd-POST-instancescan-fullscan__entry-healthscan_status_message} | Elemento | Descrição | |-|-| | erro | Mensagens de erro Tipo de dados: cadeia de caracteres | | links | Todos os links e sys_ids associados à resposta. Tipo de dados: objeto "links": { "progress": {Object} } | | links.progress | Descreve as informações do link de andamento. Tipo de dados: objeto "progress": { "id": "String", "url": "String" } | | links.progress.id | Identificador exclusivo do detalhe do andamento. Use este valor ao chamar o endpoint /sn_cicd/instance_scan/result/{progress_id}. | | links.progress.url | URL a ser usada para recuperar os detalhes do andamento. Tipo de dados: cadeia de caracteres | | status | Estado de execução numérica. Usado com status_label. Valores: * 0 (Pendente) * 1 (em execução) * 2 (Bem-sucedido) * 3 (com falha) * 4 (Cancelado) Tipo de dados: cadeia de caracteres | | status_detail | Informações adicionais sobre o estado atual. Tipo de dados: cadeia de caracteres | | status_label | Descrição do estado de execução. Usado com status. Valores: * Cancelado(a) * Reprovado * Pendente * Em Execução * Bem-sucedido Tipo de dados: cadeia de caracteres | | status_message | Informações adicionais sobre o motivo da falha da operação. Vazio se a operação for bem-sucedida. Tipo de dados: cadeia de caracteres | [Tabela 60. Elementos retornados no corpo da resposta] {#cicd-POST-instancescan-fullscan__table_mc1_pr1_tx} ### Amostra de solicitação cURL curl 'instance.service-now.com/api/sn_cicd/instance_scan/full_scan' \ --request POST \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "links": { "progress": { "id": "a4fae8911bdc00103d374087bc4bcbbd", "url": "https://instance.service-now/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "" } } ## IC/CD - POST /sn_cicd/instance_scan/point_scan {#ariaid-title12} Executa todas as verificações aplicáveis em relação a um registro especificado. Por exemplo, se você executar uma verificação de ponto em um Item do catálogo, somente as verificações aplicáveis à tabela Item do catálogo serão executadas e somente o registro especificado será verificado. Você pode executar verificações fornecidas com Instance Scan ou pode criar suas próprias verificações. Para obter mais informações, consulte [Verificação de instância](https://www.servicenow.com/docs/access?context=hs-landing-page&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US). Nota: Este endpoint faz parte da API CICD Instance Scan Execution Service e é usado no namespace sn_cicd. ### Formato da URL URL com controle de versões: /api/sn_cicd/{api_version}/instance_scan/point_scan URL padrão: /api/sn_cicd/instance_scan/point_scan ### Parâmetros de solicitação compatíveis {#cicd-POST-instancescan-pointscan__entry__2}{#cicd-POST-instancescan-pointscan__version-RESTAPI} | Parâmetro | Descrição | |-|-| | api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres | | target_table | Obrigatório. Nome da tabela na qual reside o registro a ser verificado, como "Incidente". Tipo de dados: cadeia de caracteres | | target_sys_id | Obrigatório. O sys_id do registro na tabela especificada a ser verificada. Tipo de dados: cadeia de caracteres | [Tabela 61. Parâmetros] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-instancescan-pointscan__entry__10}{#cicd-POST-instancescan-pointscan__accept-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json | [Tabela 62. Cabeçalhos da solicitação] {#cicd-POST-instancescan-pointscan__entry__14} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 63. Cabeçalhos de resposta] ### Códigos de status Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-instancescan-pointscan__table_wwn_rhd_ct__entry__2}{#cicd-POST-instancescan-pointscan__entry-200-status-code}{#cicd-POST-instancescan-pointscan__entry-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 400 | Solicitação Incorreta. Parâmetros de consulta inválidos ou vazios. | | 401 | As credenciais do usuário estão incorretas. | | 403 | Proibido. O usuário não é um administrador ou não tem a função sn_cicd.sys_ci_automation. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. | [Tabela 64. Códigos de status] {#cicd-POST-instancescan-pointscan__table_wwn_rhd_ct} ### Corpo da solicitação A API aceita esses elementos JSON ou XML no corpo da solicitação. {#cicd-POST-instancescan-pointscan__table_rm1_yjd_kv__entry__2} | Elemento | Descrição | |-|-| | Nenhum(a) | | [Tabela 65. Elementos aceitos no corpo da solicitação] {#cicd-POST-instancescan-pointscan__table_rm1_yjd_kv} ### Corpo da resposta A API retorna esses elementos JSON ou XML no corpo da resposta. {#cicd-POST-instancescan-pointscan__table_mc1_pr1_tx__entry__2}{#cicd-POST-instancescan-pointscan__entry-error}{#cicd-POST-instancescan-pointscan__entry-link}{#cicd-POST-instancescan-pointscan__entry-links_progress}{#cicd-POST-instancescan-pointscan__entry-progress_url}{#cicd-POST-instancescan-pointscan__entry-status}{#cicd-POST-instancescan-pointscan__entry-status_detail}{#cicd-POST-instancescan-pointscan__entry-status_label}{#cicd-POST-instancescan-pointscan__entry-healthscan_status_message} | Elemento | Descrição | |-|-| | erro | Mensagens de erro Tipo de dados: cadeia de caracteres | | links | Todos os links e sys_ids associados à resposta. Tipo de dados: objeto "links": { "progress": {Object} } | | links.progress | Descreve as informações do link de andamento. Tipo de dados: objeto "progress": { "id": "String", "url": "String" } | | links.progress.id | Identificador exclusivo do detalhe do andamento. Use este valor ao chamar o endpoint /sn_cicd/instance_scan/result/{progress_id}. | | links.progress.url | URL a ser usada para recuperar os detalhes do andamento. Tipo de dados: cadeia de caracteres | | status | Estado de execução numérica. Usado com status_label. Valores: * 0 (Pendente) * 1 (em execução) * 2 (Bem-sucedido) * 3 (com falha) * 4 (Cancelado) Tipo de dados: cadeia de caracteres | | status_detail | Informações adicionais sobre o estado atual. Tipo de dados: cadeia de caracteres | | status_label | Descrição do estado de execução. Usado com status. Valores: * Cancelado(a) * Reprovado * Pendente * Em Execução * Bem-sucedido Tipo de dados: cadeia de caracteres | | status_message | Informações adicionais sobre o motivo da falha da operação. Vazio se a operação for bem-sucedida. Tipo de dados: cadeia de caracteres | [Tabela 66. Elementos retornados no corpo da resposta] {#cicd-POST-instancescan-pointscan__table_mc1_pr1_tx} ### Amostra de solicitação cURL curl 'instance.service-now.com/api/sn_cicd/instance_scan/point_scan?target_table=incident&target_sys_id=2d146921dbd80010caf55268dc9619d8' \ --request POST \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "links": { "progress": { "id": "a4fae8911bdc00103d374087bc4bcbbd", "url": "https://instance.service-now/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "" } } ## CI/CD - POST /sn_cicd/instance_scan/suite_scan/combo/{combo_sys_id} {#ariaid-title13} Executa uma verificação usando um pacote e um destino (apps com escopo ou conjuntos de atualizações) que já foram executados anteriormente. Antes de chamar este endpoint, você deve chamar os endpoints /sn_cicd/instance_scan/suite_scan/{suite_sys_id}/scoped_apps ou /sn_cicd/instance_scan/suite_scan/{suite_sys_id}/update_sets ou [executar uma verificação de pacote](https://www.servicenow.com/docs/access?context=hc-execute-suite-scan&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US) na IU. Nota: Este endpoint faz parte da API CICD Instance Scan Execution Service e é usado no namespace sn_cicd. ### Formato da URL {#cicd-POST-instancescan-ss-combo__section_yhg_mkk_fpb} URL com controle de versão: /api/sn_cicd/{api_version}/instance_scan/suite_scan/combo/{combo_sys_id} URL padrão: /api/sn_cicd/instance_scan/suite_scan/combo/{combo_sys_id} ### Parâmetros de solicitação compatíveis {#cicd-POST-instancescan-ss-combo__entry__2}{#cicd-POST-instancescan-ss-combo__version-RESTAPI} | Nome | Descrição | |-|-| | api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres | | combo_sys_id | O sys_id da verificação a ser executada. A verificação deve ser uma verificação existente que você deseja executar novamente. Localizado na tabela Combo \[scan_combo\]. Tipo de dados: cadeia de caracteres | [Tabela 67. Parâmetros de caminho] {#cicd-POST-instancescan-ss-combo__entry__8} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 68. Parâmetros de consulta] {#cicd-POST-instancescan-ss-combo__entry__12} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 69. Parâmetros do corpo da solicitação (XML ou JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-instancescan-ss-combo__entry__16}{#cicd-POST-instancescan-ss-combo__accept-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json | [Tabela 70. Cabeçalhos da solicitação] {#cicd-POST-instancescan-ss-combo__entry__20} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 71. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-instancescan-ss-combo__table_wwn_rhd_ct__entry__2}{#cicd-POST-instancescan-ss-combo__entry-200-status-code}{#cicd-POST-instancescan-ss-combo__entry-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 401 | As credenciais do usuário estão incorretas. | | 403 | Proibido. O usuário não é um administrador ou não tem a função sn_cicd.sys_ci_automation. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. | [Tabela 72. Códigos de status] {#cicd-POST-instancescan-ss-combo__table_wwn_rhd_ct} ### Parâmetros do corpo da resposta (JSON ou XML) {#cicd-POST-instancescan-ss-combo__entry__34}{#cicd-POST-instancescan-ss-combo__entry-error}{#cicd-POST-instancescan-ss-combo__entry-link}{#cicd-POST-instancescan-ss-combo__entry-links_progress}{#cicd-POST-instancescan-ss-combo__entry-progress_url}{#cicd-POST-instancescan-ss-combo__entry-status}{#cicd-POST-instancescan-ss-combo__entry-status_detail}{#cicd-POST-instancescan-ss-combo__entry-status_label}{#cicd-POST-instancescan-ss-combo__entry-healthscan_status_message} | Elemento | Descrição | |-|-| | erro | Mensagens de erro Tipo de dados: cadeia de caracteres | | links | Todos os links e sys_ids associados à resposta. Tipo de dados: objeto "links": { "progress": {Object} } | | links.progress | Descreve as informações do link de andamento. Tipo de dados: objeto "progress": { "id": "String", "url": "String" } | | links.progress.id | Identificador exclusivo do detalhe do andamento. Use este valor ao chamar o endpoint /sn_cicd/instance_scan/result/{progress_id}. | | links.progress.url | URL a ser usada para recuperar os detalhes do andamento. Tipo de dados: cadeia de caracteres | | status | Estado de execução numérica. Usado com status_label. Valores: * 0 (Pendente) * 1 (em execução) * 2 (Bem-sucedido) * 3 (com falha) * 4 (Cancelado) Tipo de dados: cadeia de caracteres | | status_detail | Informações adicionais sobre o estado atual. Tipo de dados: cadeia de caracteres | | status_label | Descrição do estado de execução. Usado com status. Valores: * Cancelado(a) * Reprovado * Pendente * Em Execução * Bem-sucedido Tipo de dados: cadeia de caracteres | | status_message | Informações adicionais sobre o motivo da falha da operação. Vazio se a operação for bem-sucedida. Tipo de dados: cadeia de caracteres | [ ] ### Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_cicd/instance_scan/suite_scan/combo/245d29cc1bd32010178aed72604bcb4b" \ --request POST \ --header "Accept:application/json" \ --user 'username':'password' Corpo da resposta - sucesso. { "result": { "links": { "progress": { "id": "c08be5c71b1b2010178aed72604bcb6e", "url": "https://instance.servicenow.com/api/sn_cicd/progress/c08be5c71b1b2010178aed72604bcb6e" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "" } } ## CI/CD - POST /sn_cicd/instance_scan/suite_scan/{suite_sys_id}/scoped_apps {#ariaid-title14} Executa todas as verificações ativas dentro de um pacote em uma lista de apps com escopo. Nota: Este endpoint faz parte da API CICD Instance Scan Execution Service e é usado no namespace sn_cicd. ### Formato da URL URL com controle de versão: /api/sn_cicd/{api_version}/instance_scan/suite_scan/{suite_sys_id}/scoped_apps URL padrão: /api/sn_cicd/instance_scan/suite_scan/{suite_sys_id}/scoped_apps ### Parâmetros de solicitação compatíveis {#cicd-POST-instancescan-ss-sa__entry__2}{#cicd-POST-instancescan-ss-sa__version-RESTAPI} | Nome | Descrição | |-|-| | api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres | | pacote_sys_id | O sys_id do [pacote](https://www.servicenow.com/docs/access?context=hc-suites-mgmt&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US) a ser executado. Localizado na tabela Pacote \[scan_check_suite\]. Tipo de dados: cadeia de caracteres | [Tabela 73. Parâmetros de caminho] {#cicd-POST-instancescan-ss-sa__entry__8} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 74. Parâmetros de consulta] {#cicd-POST-instancescan-ss-sa__entry__12} | Nome | Descrição | |-|-| | app_scope_sys_ids | Obrigatório. Uma lista de sys_ids das aplicações com escopo a serem verificadas. Localizado na tabela Aplicação \[sys_scope\]. A matriz não pode ser uma matriz vazia. Tipo de dados: matriz app_scope_sys_ids: ["String", "String", "String"] | [Tabela 75. Parâmetros do corpo da solicitação (XML ou JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-instancescan-ss-sa__entry__16}{#cicd-POST-instancescan-ss-sa__accept-RESTAPI}{#cicd-POST-instancescan-ss-sa__content_type-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json | | Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. | [Tabela 76. Cabeçalhos da solicitação] {#cicd-POST-instancescan-ss-sa__entry__22} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 77. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-instancescan-ss-sa__table_wwn_rhd_ct__entry__2}{#cicd-POST-instancescan-ss-sa__entry-200-status-code}{#cicd-POST-instancescan-ss-sa__entry-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 401 | As credenciais do usuário estão incorretas. | | 403 | Proibido. O usuário não é um administrador ou não tem a função sn_cicd.sys_ci_automation. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. | [Tabela 78. Códigos de status] {#cicd-POST-instancescan-ss-sa__table_wwn_rhd_ct} ### Parâmetros do corpo da resposta (JSON ou XML) {#cicd-POST-instancescan-ss-sa__entry__36}{#cicd-POST-instancescan-ss-sa__entry-error}{#cicd-POST-instancescan-ss-sa__entry-link}{#cicd-POST-instancescan-ss-sa__entry-links_progress}{#cicd-POST-instancescan-ss-sa__entry-progress_url}{#cicd-POST-instancescan-ss-sa__entry-status}{#cicd-POST-instancescan-ss-sa__entry-status_detail}{#cicd-POST-instancescan-ss-sa__entry-status_label}{#cicd-POST-instancescan-ss-sa__entry-healthscan_status_message} | Elemento | Descrição | |-|-| | erro | Mensagens de erro Tipo de dados: cadeia de caracteres | | links | Todos os links e sys_ids associados à resposta. Tipo de dados: objeto "links": { "progress": {Object} } | | links.progress | Descreve as informações do link de andamento. Tipo de dados: objeto "progress": { "id": "String", "url": "String" } | | links.progress.id | Identificador exclusivo do detalhe do andamento. Use este valor ao chamar o endpoint /sn_cicd/instance_scan/result/{progress_id}. | | links.progress.url | URL a ser usada para recuperar os detalhes do andamento. Tipo de dados: cadeia de caracteres | | status | Estado de execução numérica. Usado com status_label. Valores: * 0 (Pendente) * 1 (em execução) * 2 (Bem-sucedido) * 3 (com falha) * 4 (Cancelado) Tipo de dados: cadeia de caracteres | | status_detail | Informações adicionais sobre o estado atual. Tipo de dados: cadeia de caracteres | | status_label | Descrição do estado de execução. Usado com status. Valores: * Cancelado(a) * Reprovado * Pendente * Em Execução * Bem-sucedido Tipo de dados: cadeia de caracteres | | status_message | Informações adicionais sobre o motivo da falha da operação. Vazio se a operação for bem-sucedida. Tipo de dados: cadeia de caracteres | [ ] ### Solicitação de cURL Este exemplo executa todas as verificações ativas dentro de um pacote em relação a uma aplicação com escopo. curl "https://instance.servicenow.com/api/sn_cicd/instance_scan/suite_scan/833655cc1b94101046e87733cd4bcb4e/scoped_apps" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{app_scope_sys_ids: [\"078e8020950f12a215a92e8ad9b346e0\"]}" \ --user 'username':'password' Corpo da resposta - sucesso. { "result": { "links": { "progress": { "id": "147fc14b1b572010178aed72604bcbca", "url": "https://instance.servicenow.com/api/sn_cicd/progress/147fc14b1b572010178aed72604bcbca" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "" } } ## IC/CD - POST /sn_cicd/instance_scan/suite_scan/{suite_sys_id}/update_sets {#ariaid-title15} Executa todas as verificações ativas dentro de um pacote em uma lista de conjuntos de atualizações. Nota: Este endpoint faz parte da API CICD Instance Scan Execution Service e é usado no namespace sn_cicd. ### Formato da URL {#cicd-POST-instancescan-ss-us__section_yhg_mkk_fpb} URL com controle de versões: /api/sn_cicd/{api_version}/instance_scan/suite_scan/{suite_sys_id}/update_sets URL padrão: /api/sn_cicd/instance_scan/suite_scan/{suite_sys_id}/update_sets ### Parâmetros de solicitação compatíveis {#cicd-POST-instancescan-ss-us__entry__2}{#cicd-POST-instancescan-ss-us__version-RESTAPI} | Nome | Descrição | |-|-| | api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres | | pacote_sys_id | O sys_id do [pacote](https://www.servicenow.com/docs/access?context=hc-suites-mgmt&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US) a ser executado. Localizado na tabela Pacote \[scan_check_suite\]. Tipo de dados: cadeia de caracteres | [Tabela 79. Parâmetros de caminho] {#cicd-POST-instancescan-ss-us__entry__8} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 80. Parâmetros de consulta] {#cicd-POST-instancescan-ss-us__entry__12} | Nome | Descrição | |-|-| | update_set_sys_ids | Obrigatório. Uma lista de sys_ids dos conjuntos de atualizações a serem verificados. Localizado na tabela Conjunto de atualizações \[sys_update_set\]. A matriz não pode ser uma matriz vazia. Tipo de dados: matriz update_set_sys_ids: ["String", "String", "String"] | [Tabela 81. Parâmetros do corpo da solicitação (XML ou JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-instancescan-ss-us__table_dm1_1pk_fpb__entry__2}{#cicd-POST-instancescan-ss-us__accept-RESTAPI}{#cicd-POST-instancescan-ss-us__content_type-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json | | Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. | [Tabela 82. Cabeçalhos da solicitação] {#cicd-POST-instancescan-ss-us__table_dm1_1pk_fpb} {#cicd-POST-instancescan-ss-us__entry__22} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 83. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-instancescan-ss-us__table_wwn_rhd_ct__entry__2}{#cicd-POST-instancescan-ss-us__entry-200-status-code}{#cicd-POST-instancescan-ss-us__entry-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 401 | As credenciais do usuário estão incorretas. | | 403 | Proibido. O usuário não é um administrador ou não tem a função sn_cicd.sys_ci_automation. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. | [Tabela 84. Códigos de status] {#cicd-POST-instancescan-ss-us__table_wwn_rhd_ct} ### Parâmetros do corpo da resposta (JSON ou XML) {#cicd-POST-instancescan-ss-us__entry__36}{#cicd-POST-instancescan-ss-us__entry-error}{#cicd-POST-instancescan-ss-us__entry-link}{#cicd-POST-instancescan-ss-us__entry-links_progress}{#cicd-POST-instancescan-ss-us__entry-progress_url}{#cicd-POST-instancescan-ss-us__entry-status}{#cicd-POST-instancescan-ss-us__entry-status_detail}{#cicd-POST-instancescan-ss-us__entry-status_label}{#cicd-POST-instancescan-ss-us__entry-healthscan_status_message} | Elemento | Descrição | |-|-| | erro | Mensagens de erro Tipo de dados: cadeia de caracteres | | links | Todos os links e sys_ids associados à resposta. Tipo de dados: objeto "links": { "progress": {Object} } | | links.progress | Descreve as informações do link de andamento. Tipo de dados: objeto "progress": { "id": "String", "url": "String" } | | links.progress.id | Identificador exclusivo do detalhe do andamento. Use este valor ao chamar o endpoint /sn_cicd/instance_scan/result/{progress_id}. | | links.progress.url | URL a ser usada para recuperar os detalhes do andamento. Tipo de dados: cadeia de caracteres | | status | Estado de execução numérica. Usado com status_label. Valores: * 0 (Pendente) * 1 (em execução) * 2 (Bem-sucedido) * 3 (com falha) * 4 (Cancelado) Tipo de dados: cadeia de caracteres | | status_detail | Informações adicionais sobre o estado atual. Tipo de dados: cadeia de caracteres | | status_label | Descrição do estado de execução. Usado com status. Valores: * Cancelado(a) * Reprovado * Pendente * Em Execução * Bem-sucedido Tipo de dados: cadeia de caracteres | | status_message | Informações adicionais sobre o motivo da falha da operação. Vazio se a operação for bem-sucedida. Tipo de dados: cadeia de caracteres | [ ] ### Solicitação de cURL Este exemplo executa todas as verificações ativas dentro de um pacote em relação a um conjunto de atualizações. curl "https://instance.servicenow.com/api/sn_cicd/instance_scan/suite_scan/833655cc1b94101046e87733cd4bcb4e/update_sets" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{update_set_sys_ids: [\"7abef63c1b572010178aed72604bcbfd\"]}" \ --user 'username':'password' Corpo da resposta - sucesso. { "result": { "links": { "progress": { "id": "d27511031b972010178aed72604bcb72", "url": "https://instance.servicenow.com/api/sn_cicd/progress/d27511031b972010178aed72604bcb72" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "" } } ## IC/CD - POST /sn_cicd/plugin/{plugin_id}/activate {#ariaid-title16} Ativa o plug-in especificado. ### Formato da URL {#cicd-POST-plugin-activate__section_ufb_vrk_zlb} URL com controle de versão: /api/sn_cicd/{api_version}/plugin/{plugin_id}/activate URL padrão: /api/sn_cicd/plugin/{plugin_id}/activate ### Parâmetros de solicitação compatíveis {#cicd-POST-plugin-activate__entry__2}{#cicd-POST-plugin-activate__version-RESTAPI}{#cicd-POST-plugin-activate__entry-plugin_id} | Nome | Descrição | |-|-| | api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres | | plugin_id | Identificador exclusivo do plug-in. Você pode localizar este identificador na página Plug-ins dentro do cartão do plug-in desejado; identificado com o nome "ID". Tipo de dados: cadeia de caracteres | [Tabela 85. Parâmetros de caminho] {#cicd-POST-plugin-activate__entry__8} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 86. Parâmetros de consulta] {#cicd-POST-plugin-activate__entry__12} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 87. Parâmetros do corpo da solicitação (XML ou JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-plugin-activate__entry__16}{#cicd-POST-plugin-activate__accept-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json | [Tabela 88. Cabeçalhos da solicitação] {#cicd-POST-plugin-activate__entry__20} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 89. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-plugin-activate__entry__24}{#cicd-POST-plugin-activate__entry-200-status-code}{#cicd-POST-plugin-activate__row-401-status-code}{#cicd-POST-plugin-activate__row-403-status-code}{#cicd-POST-plugin-activate__row-404-status-code}{#cicd-POST-plugin-activate__row-405-status-code}{#cicd-POST-plugin-activate__row-409-status-code}{#cicd-POST-plugin-activate__row-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 401 | As credenciais do usuário estão incorretas. | | 403 | Proibido. O usuário não é um administrador ou não tem a função sn_cicd.sys_ci_automation. | | 404 | Não encontrado. O item solicitado não foi encontrado. | | 405 | Método inválido. A funcionalidade está inativa. | | 409 | Conflito. O item solicitado não é exclusivo. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. | [Tabela 90. Códigos de status] ### Parâmetros do corpo da resposta (JSON ou XML) {#cicd-POST-plugin-activate__entry__40}{#cicd-POST-plugin-activate__row-error}{#cicd-POST-plugin-activate__row-link}{#cicd-POST-plugin-activate__row-links_progress}{#cicd-POST-plugin-activate__row-links_progress_id}{#cicd-POST-plugin-activate__row-links_progress_url}{#cicd-POST-plugin-activate__row-links_results}{#cicd-POST-plugin-activate__row-links_results_id}{#cicd-POST-plugin-activate__row-links_results_url}{#cicd-POST-plugin-activate__row-percent_complete}{#cicd-POST-plugin-activate__row-status}{#cicd-POST-plugin-activate__row-status_detail}{#cicd-POST-plugin-activate__row-status_label}{#cicd-POST-plugin-activate__row-status_message} | Nome | Descrição | |-|-| | erro | Mensagens de erro Tipo de dados: cadeia de caracteres | | links | Todos os links e sys_ids associados à resposta. Tipo de dados: objeto "links": { "progress": {Object} } | | links.progress | Descreve as informações do link de andamento. Tipo de dados: objeto "progress": { "id": "String", "url": "String" } | | links.progress.id | Identificador exclusivo a ser usado para obter os detalhes do andamento da operação. Use este valor ao chamar o endpoint /sn_cicd/progress/{progress_id}. Tipo de dados: cadeia de caracteres | | links.progress.url | URL a ser usada para recuperar os detalhes do andamento. Tipo de dados: cadeia de caracteres | | links.resultados | Informações dos resultados. Tipo de dados: objeto "results": { "id": "String", "url": "String" } | | links.results.id | Identificador exclusivo das informações de resultados. Use este valor ao chamar o endpoint de resultados associados. Tipo de dados: cadeia de caracteres | | links.resultados.URL | URL a ser usada para obter os resultados da execução do endpoint, como resultados. Tipo de dados: cadeia de caracteres | | percent_complete | Porcentagem da solicitação que está concluída. Tipo de dados: número | | status | Estado de execução numérica. Usado com status_label. Valores: * 0 (Pendente) * 1 (em execução) * 2 (Bem-sucedido) * 3 (com falha) * 4 (Cancelado) Tipo de dados: cadeia de caracteres | | status_detail | Informações adicionais sobre o estado atual. Tipo de dados: cadeia de caracteres | | status_label | Descrição do estado de execução. Usado com status. Valores: * Cancelado(a) * Reprovado * Pendente * Em Execução * Bem-sucedido Tipo de dados: cadeia de caracteres | | status_message | Descrição do estado atual. Tipo de dados: cadeia de caracteres | [ ] ### Solicitação de cURL curl 'instance.servicenow.com/api/sn_cicd/plugin/com.glide.web_service_aggregate/activate' \ --request POST \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "links": { "progress": { "id": "5b3f052ddb580010caf55268dc961963", "url": "https://instance.service-now.com/api/sn_cicd/progress/5b3f052ddb580010caf55268dc961963" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "", "percent_complete": 0 } } ## IC/CD - POST /sn_cicd/plugin/{plugin_id}/rollback {#ariaid-title17} Reverte o plug-in especificado para a versão instalada anterior. Se nenhuma versão anterior tiver sido instalada, retornará um erro.
### Formato da URL {#cicd-POST-plugin-rollback__section_zrh_q5k_zlb} URL com controle de versão: /api/sn_cicd/{api_version}plugin/{plugin_id}/rollback URL padrão: /api/sn_cicd/plugin/{plugin_id}/rollback ### Parâmetros de solicitação compatíveis {#cicd-POST-plugin-rollback__entry__2}{#cicd-POST-plugin-rollback__version-RESTAPI}{#cicd-POST-plugin-rollback__entry-plugin_id} | Nome | Descrição | |-|-| | api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres | | plugin_id | Identificador exclusivo do plug-in. Você pode localizar este identificador na página Plug-ins dentro do cartão do plug-in desejado; identificado com o nome "ID". Tipo de dados: cadeia de caracteres | [Tabela 91. Parâmetros de caminho] {#cicd-POST-plugin-rollback__entry__8} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 92. Parâmetros de consulta] {#cicd-POST-plugin-rollback__entry__12} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 93. Parâmetros do corpo da solicitação (XML ou JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-plugin-rollback__entry__16}{#cicd-POST-plugin-rollback__accept-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json | [Tabela 94. Cabeçalhos da solicitação] {#cicd-POST-plugin-rollback__entry__20} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 95. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-plugin-rollback__entry__24}{#cicd-POST-plugin-rollback__entry-200-status-code}{#cicd-POST-plugin-rollback__row-401-status-code}{#cicd-POST-plugin-rollback__row-403-status-code}{#cicd-POST-plugin-rollback__row-404-status-code}{#cicd-POST-plugin-rollback__row-405-status-code}{#cicd-POST-plugin-rollback__row-409-status-code}{#cicd-POST-plugin-rollback__row-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 401 | As credenciais do usuário estão incorretas. | | 403 | Proibido. O usuário não é um administrador ou não tem a função sn_cicd.sys_ci_automation. | | 404 | Não encontrado. O item solicitado não foi encontrado. | | 405 | Método inválido. A funcionalidade está inativa. | | 409 | Conflito. O item solicitado não é exclusivo. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. | [Tabela 96. Códigos de status] ### Parâmetros do corpo da resposta (JSON ou XML) {#cicd-POST-plugin-rollback__entry__40}{#cicd-POST-plugin-rollback__row-error}{#cicd-POST-plugin-rollback__row-link}{#cicd-POST-plugin-rollback__row-links_progress}{#cicd-POST-plugin-rollback__row-links_progress_id}{#cicd-POST-plugin-rollback__row-links_progress_url}{#cicd-POST-plugin-rollback__row-percent_complete}{#cicd-POST-plugin-rollback__row-status}{#cicd-POST-plugin-rollback__row-status_detail}{#cicd-POST-plugin-rollback__row-status_label}{#cicd-POST-plugin-rollback__row-status_message} | Nome | Descrição | |-|-| | erro | Mensagens de erro Tipo de dados: cadeia de caracteres | | links | Todos os links e sys_ids associados à resposta. Tipo de dados: objeto "links": { "progress": {Object} } | | links.progress | Descreve as informações do link de andamento. Tipo de dados: objeto "progress": { "id": "String", "url": "String" } | | links.progress.id | Identificador exclusivo a ser usado para obter os detalhes do andamento da operação. Use este valor ao chamar o endpoint /sn_cicd/progress/{progress_id}. Tipo de dados: cadeia de caracteres | | links.progress.url | URL a ser usada para recuperar os detalhes do andamento. Tipo de dados: cadeia de caracteres | | percent_complete | Porcentagem da solicitação que está concluída. Tipo de dados: número | | status | Estado de execução numérica. Usado com status_label. Valores: * 0 (Pendente) * 1 (em execução) * 2 (Bem-sucedido) * 3 (com falha) * 4 (Cancelado) Tipo de dados: cadeia de caracteres | | status_detail | Informações adicionais sobre o estado atual. Tipo de dados: cadeia de caracteres | | status_label | Descrição do estado de execução. Usado com status. Valores: * Cancelado(a) * Reprovado * Pendente * Em Execução * Bem-sucedido Tipo de dados: cadeia de caracteres | | status_message | Descrição do estado atual. Tipo de dados: cadeia de caracteres | [ ] ### Solicitação de cURL curl 'instance.servicenow.com/api/sn_cicd/plugin/com.glide.web_service_aggregate/rollback' \ --request POST \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "links": { "progress": { "id": "6185dd61db980010caf55268dc961916", "url": "https://instance.service-now.com/api/sn_cicd/progress/6185dd61db980010caf55268dc961916" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "", "percent_complete": 0 } } ## IC/CD - POST /sn_cicd/sc/apply_changes {#ariaid-title18} Inicia a aplicação de mudanças de um controle de código-fonte remoto a uma aplicação local ou personalização de aplicação especificada. ### Formato da URL URL com controle de versões: /api/sn_cicd/{api_version}/sc/apply_changes URL padrão: /api/sn_cicd/sc/apply_changes ### Parâmetros de solicitação compatíveis {#cicd-POST-sc-apply_changes__entry__2}{#cicd-POST-sc-apply_changes__version-RESTAPI} | Nome | Descrição | |-|-| | api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres | [Tabela 97. Parâmetros de caminho] {#cicd-POST-sc-apply_changes__entry__6} | Nome | Descrição | |-|-| | auto_upgrade_base_app | Aplicável somente quando as mudanças são aplicadas para personalização da aplicação e a confirmação mais recente no repositório Git é criada em uma versão posterior à da aplicação base que está instalada na instância local. Sinalizador que indica se o sistema deve fazer upgrade automaticamente da aplicação base para uma versão posterior. Tipo de dados: booliano Padrão: verdadeiro | | ramificação_nome | Nome da ramificação no sistema de controle de código-fonte do qual a aplicação será adquirida. Tipo de dados: cadeia de caracteres Padrão: ramificação padrão especificada no sistema de controle de código-fonte. | | scope | Obrigatório se sys_id não for especificado. O nome do escopo da aplicação para a qual as mudanças serão aplicadas, como x_aah_custom_app. Você pode localizar este valor no campo scope na tabela Aplicação personalizada \[sys_app\] ou na tabela Aplicação da loja \[sys_store_app\] para o app-customization. Tipo de dados: cadeia de caracteres | | sys_id | Obrigatório se scope não for especificado. O sys_id da aplicação para a qual as mudanças serão aplicadas. Você pode localizar este valor no campo Sys ID na tabela Aplicação personalizada \[sys_app\] ou na tabela Aplicação da loja \[sys_store_app\] para o app-customization. Tipo de dados: cadeia de caracteres | [Tabela 98. Parâmetros de consulta] {#cicd-POST-sc-apply_changes__entry__16} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 99. Parâmetros do corpo da solicitação (XML ou JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-sc-apply_changes__entry__20}{#cicd-POST-sc-apply_changes__accept-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json | [Tabela 100. Cabeçalhos da solicitação] {#cicd-POST-sc-apply_changes__entry__24} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 101. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-sc-apply_changes__entry__28}{#cicd-POST-sc-apply_changes__entry-200-status-code}{#cicd-POST-sc-apply_changes__row-401-status-code}{#cicd-POST-sc-apply_changes__row-403-status-code}{#cicd-POST-sc-apply_changes__row-404-status-code}{#cicd-POST-sc-apply_changes__row-405-status-code}{#cicd-POST-sc-apply_changes__row-409-status-code}{#cicd-POST-sc-apply_changes__row-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 401 | As credenciais do usuário estão incorretas. | | 403 | Proibido. O usuário não é um administrador ou não tem a função sn_cicd.sys_ci_automation. | | 404 | Não encontrado. O item solicitado não foi encontrado. | | 405 | Método inválido. A funcionalidade está inativa. | | 409 | Conflito. O item solicitado não é exclusivo. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. | [Tabela 102. Códigos de status] ### Parâmetros do corpo da resposta (JSON ou XML) {#cicd-POST-sc-apply_changes__entry__44}{#cicd-POST-sc-apply_changes__row-error}{#cicd-POST-sc-apply_changes__row-link}{#cicd-POST-sc-apply_changes__row-links_progress}{#cicd-POST-sc-apply_changes__row-links_progress_id}{#cicd-POST-sc-apply_changes__row-links_progress_url}{#cicd-POST-sc-apply_changes__row-percent_complete}{#cicd-POST-sc-apply_changes__row-status}{#cicd-POST-sc-apply_changes__row-status_detail}{#cicd-POST-sc-apply_changes__row-status_label}{#cicd-POST-sc-apply_changes__row-status_message} | Nome | Descrição | |-|-| | erro | Mensagens de erro Tipo de dados: cadeia de caracteres | | links | Todos os links e sys_ids associados à resposta. Tipo de dados: objeto "links": { "progress": {Object} } | | links.progress | Descreve as informações do link de andamento. Tipo de dados: objeto "progress": { "id": "String", "url": "String" } | | links.progress.id | Identificador exclusivo a ser usado para obter os detalhes do andamento da operação. Use este valor ao chamar o endpoint /sn_cicd/progress/{progress_id}. Tipo de dados: cadeia de caracteres | | links.progress.url | URL a ser usada para recuperar os detalhes do andamento. Tipo de dados: cadeia de caracteres | | percent_complete | Porcentagem da solicitação que está concluída. Tipo de dados: número | | status | Estado de execução numérica. Usado com status_label. Valores: * 0 (Pendente) * 1 (em execução) * 2 (Bem-sucedido) * 3 (com falha) * 4 (Cancelado) Tipo de dados: cadeia de caracteres | | status_detail | Informações adicionais sobre o estado atual. Tipo de dados: cadeia de caracteres | | status_label | Descrição do estado de execução. Usado com status. Valores: * Cancelado(a) * Reprovado * Pendente * Em Execução * Bem-sucedido Tipo de dados: cadeia de caracteres | | status_message | Informações adicionais sobre o motivo da falha da operação. Vazio se a operação for bem-sucedida. Tipo de dados: cadeia de caracteres | [ ] ### Solicitação de cURL curl 'https://instance.servicenow.com/api/sn_cicd/sc/apply_changes?app_sys_id=043db024db737300a9a754e4dc961915' \ --request POST \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "links": { "progress": { "id": "a4fae8911bdc00103d374087bc4bcbbd", "url": "https://instance.service-now/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "", "percent_complete": 0 } } ## IC/CD - POST /sn_cicd/sc/apply_stash/{stash_id} {#ariaid-title19} Inicia a aplicação de um "estoque" gerado anteriormente de mudanças de um controle de código-fonte remoto para uma aplicação local ou personalização de aplicação especificada. Este endpoint funciona em conjunto com os endpoints [POST/api/sn_cicd/sc/apply_changes](https://servicenow-prod.fluidtopics.net/~Tfwy9xIj2f0IqLxE71S1A#cicd-POST-sc-apply_changes "Inicia a aplicação de mudanças de um controle de código-fonte remoto a uma aplicação local ou personalização de aplicação especificada.") e [IC/CD - GET /sn_cicd/progress/{progress_id}](https://servicenow-prod.fluidtopics.net/~Tfwy9xIj2f0IqLxE71S1A#cicd-GET-progress "Retorna o andamento atual e o status da função Integração e entrega contínuas (CICD) associada a um ID de andamento especificado."). Quando o endpoint POST /api/sn_cicd/sc/apply_changes é chamado, todas as mudanças não salvas ou não confirmadas em App Engine Studio na instância associada são salvas no banco de dados como um [estoque](https://www.servicenow.com/docs/access?context=stash-changes&version=xanadu&pubname=xanadu-application-development&ft:locale=en-US). A maneira de determinar se um stash foi criado quando as mudanças foram aplicadas inicialmente é chamar o endpoint GET /sn_cicd/progress/{progress_id}. Se um stash tiver sido criado, o sys_id (stash_id) e a URL do stash serão retornados. Para aplicar as mudanças armazenadas à aplicação associada, chame este endpoint apply_stash usando o stash_id retornado pelo endpoint de andamento. ### Formato da URL {#cicd-POST-sc-apply_stash__section_nw2_lth_y5b} URL com controle de versões: /api/sn_cicd/{api_version}/sc/apply_stash/{stash_id} URL padrão: /api/sn_cicd/sc/apply_stash/{stash_id} ### Parâmetros de solicitação compatíveis {#cicd-POST-sc-apply_stash__entry__2}{#cicd-POST-sc-apply_stash__version-RESTAPI} | Nome | Descrição | |-|-| | api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres | | stash_id | Identificador exclusivo do stash a ser aplicado. Este valor é retornado no parâmetro links.stash.id \] na chamada de endpoint [IC/CD - GET /sn_cicd/progress/{progress_id}](https://servicenow-prod.fluidtopics.net/~Tfwy9xIj2f0IqLxE71S1A#cicd-GET-progress "Retorna o andamento atual e o status da função Integração e entrega contínuas (CICD) associada a um ID de andamento especificado.") correspondente. Tipo de dados: cadeia de caracteres | [Tabela 103. Parâmetros de caminho] {#cicd-POST-sc-apply_stash__entry__8} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 104. Parâmetros de consulta] {#cicd-POST-sc-apply_stash__entry__12} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 105. Parâmetros do corpo da solicitação (XML ou JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-sc-apply_stash__entry__16}{#cicd-POST-sc-apply_stash__accept-RESTAPI}{#cicd-POST-sc-apply_stash__content_type-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json | | Tipo de conteúdo | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json | [Tabela 106. Cabeçalhos da solicitação] {#cicd-POST-sc-apply_stash__entry__22} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 107. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-sc-apply_stash__entry__26}{#cicd-POST-sc-apply_stash__entry-200-status-code}{#cicd-POST-sc-apply_stash__row-401-status-code}{#cicd-POST-sc-apply_stash__row-403-status-code}{#cicd-POST-sc-apply_stash__row-404-status-code}{#cicd-POST-sc-apply_stash__row-405-status-code}{#cicd-POST-sc-apply_stash__row-409-status-code}{#cicd-POST-sc-apply_stash__row-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 401 | As credenciais do usuário estão incorretas. | | 403 | Proibido. O usuário não é um administrador ou não tem a função sn_cicd.sys_ci_automation. | | 404 | Não encontrado. O item solicitado não foi encontrado. | | 405 | Método inválido. A funcionalidade está inativa. | | 409 | Conflito. O item solicitado não é exclusivo. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. | [Tabela 108. Códigos de status] ### Parâmetros do corpo da resposta (JSON ou XML) {#cicd-POST-sc-apply_stash__entry__42}{#cicd-POST-sc-apply_stash__row-error}{#cicd-POST-sc-apply_stash__row-link}{#cicd-POST-sc-apply_stash__row-links_progress}{#cicd-POST-sc-apply_stash__row-links_progress_id}{#cicd-POST-sc-apply_stash__row-links_progress_url}{#cicd-POST-sc-apply_stash__row-percent_complete}{#cicd-POST-sc-apply_stash__row-status}{#cicd-POST-sc-apply_stash__row-status_detail}{#cicd-POST-sc-apply_stash__row-status_label}{#cicd-POST-sc-apply_stash__row-status_message} | Nome | Descrição | |-|-| | erro | Mensagens de erro Tipo de dados: cadeia de caracteres | | links | Todos os links e sys_ids associados à resposta. Tipo de dados: objeto "links": { "progress": {Object} } | | links.progress | Descreve as informações do link de andamento. Tipo de dados: objeto "progress": { "id": "String", "url": "String" } | | links.progress.id | Identificador exclusivo a ser usado para obter os detalhes do andamento da operação. Use este valor ao chamar o endpoint /sn_cicd/progress/{progress_id}. Tipo de dados: cadeia de caracteres | | links.progress.url | URL a ser usada para recuperar os detalhes do andamento. Tipo de dados: cadeia de caracteres | | percent_complete | Porcentagem da solicitação que está concluída. Tipo de dados: número | | status | Estado de execução numérica. Usado com status_label. Valores: * 0 (Pendente) * 1 (em execução) * 2 (Bem-sucedido) * 3 (com falha) * 4 (Cancelado) Tipo de dados: cadeia de caracteres | | status_detail | Informações adicionais sobre o estado atual. Tipo de dados: cadeia de caracteres | | status_label | Descrição do estado de execução. Usado com status. Valores: * Cancelado(a) * Reprovado * Pendente * Em Execução * Bem-sucedido Tipo de dados: cadeia de caracteres | | status_message | Descrição do estado atual. Tipo de dados: cadeia de caracteres | [ ] ### Solicitação de cURL O exemplo de código a seguir mostra como chamar o endpoint apply_stash para stash_id fc2224e4e0429110f8771827f8fd3634. curl "https://instance.servicenow.com/api/sn_cicd/sc/apply_stash/fc2224e4e0429110f8771827f8fd3634"\ --request POST \ --header "Accept:application/json" \ --header "Content_Type:application/json" \ --user 'username':'password' O stash está pendente, portanto, ainda não foi aplicado. { "result": { "links": { "progress": { "id": "6b04ec28e0429110f8771827f8fd36a4", "url": "https://instance.servicenow.com/api/sn_cicd/progress/6b04ec28e0429110f8771827f8fd36a4" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "", "percent_complete": 0 } } ## IC/CD - POST /sn_cicd/sc/import {#ariaid-title20} Importa uma aplicação usando o URL do repositório e o nome da ramificação especificados. Use este endpoint para importar uma aplicação do controle de código-fonte na instância de chamada para que você possa usar Integração e entrega contínuas (CICD) endpoints, como [/sn_cicd/sc/apply_changes](https://servicenow-prod.fluidtopics.net/~Tfwy9xIj2f0IqLxE71S1A#cicd-POST-sc-apply_changes "Inicia a aplicação de mudanças de um controle de código-fonte remoto a uma aplicação local ou personalização de aplicação especificada."), para implantar a aplicação em ambientes superiores. Nota: Antes de usar este endpoint, um repositório Git que foi configurado por outra instância usando Link para o controle de código-fonte deve estar disponível. ### Formato da URL URL com controle de versão: /api/sn_cicd/{api_version}/sc/import URL padrão: /api/sn_cicd/sc/import ### Parâmetros de solicitação compatíveis {#cicd-POST-sc-import__entry__2}{#cicd-POST-sc-import__version-RESTAPI} | Nome | Descrição | |-|-| | api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres | [Tabela 109. Parâmetros de caminho] {#cicd-POST-sc-import__entry__6} | Nome | Descrição | |-|-| | auto_upgrade_base_app | Aplicável somente quando a aplicação que está sendo importada for uma personalização de app e a confirmação mais recente no repositório Git for criada em uma versão posterior à da aplicação base que está instalada na instância local. Sinalizador que indica se o sistema deve fazer upgrade automaticamente da aplicação base para uma versão posterior. Valores válidos: * verdadeiro: upgrade automático da aplicação base. * falso: não faz o upgrade automático da aplicação base. Tipo de dados: booliano Padrão: verdadeiro | | ramificação_nome | Obrigatório. Nome da ramificação no sistema de controle de código-fonte do qual a aplicação será importada. Tipo de dados: cadeia de caracteres | | credential_sys_id | Sys_id das credenciais que têm acesso ao repositório Git. Tipo de dados: cadeia de caracteres Padrão: Sys_id definido nas propriedades do sistema glide.source_control.default_basic_auth_credential_sys_id ou glide.source_control.default_ssh_private_key_credential_sys_id, dependendo se o parâmetro repo_url é um repositório https ou ssh. Por padrão, esta propriedade está vazia. | | mid_server_sys_id | Sys_id do MID Server a ser usado para operações de controle de código-fonte para esta aplicação. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres vazia/NULO | | repo_url | Obrigatório. URL do repositório Git do qual a aplicação será importada. Tipo de dados: cadeia de caracteres | [Tabela 110. Parâmetros de consulta] {#cicd-POST-sc-import__entry__18} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 111. Parâmetros do corpo da solicitação (XML ou JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-sc-import__entry__22}{#cicd-POST-sc-import__accept-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json | [Tabela 112. Cabeçalhos da solicitação] {#cicd-POST-sc-import__entry__26} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 113. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-sc-import__entry__30}{#cicd-POST-sc-import__entry-200-status-code}{#cicd-POST-sc-import__row-401-status-code}{#cicd-POST-sc-import__row-403-status-code}{#cicd-POST-sc-import__row-405-status-code}{#cicd-POST-sc-import__row-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 401 | As credenciais do usuário estão incorretas. | | 403 | Proibido. O usuário não é um administrador ou não tem a função sn_cicd.sys_ci_automation. | | 404 | Não encontrado. O item solicitado não foi encontrado. | | 405 | Método inválido. A funcionalidade está inativa. | | 409 | Conflito. O item solicitado não é exclusivo. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. | [Tabela 114. Códigos de status] ### Parâmetros do corpo da resposta (JSON ou XML) {#cicd-POST-sc-import__entry__46}{#cicd-POST-sc-import__row-error}{#cicd-POST-sc-import__row-link}{#cicd-POST-sc-import__row-links_progress}{#cicd-POST-sc-import__row-links_progress_id}{#cicd-POST-sc-import__row-links_progress_url}{#cicd-POST-sc-import__row-percent_complete}{#cicd-POST-sc-import__row-status}{#cicd-POST-sc-import__row-status_detail}{#cicd-POST-sc-import__row-status_label}{#cicd-POST-sc-import__row-status_message} | Nome | Descrição | |-|-| | erro | Mensagens de erro Tipo de dados: cadeia de caracteres | | links | Todos os links e sys_ids associados à resposta. Tipo de dados: objeto "links": { "progress": {Object} } | | links.progress | Descreve as informações do link de andamento. Tipo de dados: objeto "progress": { "id": "String", "url": "String" } | | links.progress.id | Identificador exclusivo a ser usado para obter os detalhes do andamento da operação. Use este valor ao chamar o endpoint /sn_cicd/progress/{progress_id}. Tipo de dados: cadeia de caracteres | | links.progress.url | URL a ser usada para recuperar os detalhes do andamento. Tipo de dados: cadeia de caracteres | | percent_complete | Porcentagem da solicitação que está concluída. Tipo de dados: número | | status | Estado de execução numérica. Usado com status_label. Valores: * 0 (Pendente) * 1 (em execução) * 2 (Bem-sucedido) * 3 (com falha) * 4 (Cancelado) Tipo de dados: cadeia de caracteres | | status_detail | Informações adicionais sobre o estado atual. Tipo de dados: cadeia de caracteres | | status_label | Descrição do estado de execução. Usado com status. Valores: * Cancelado(a) * Reprovado * Pendente * Em Execução * Bem-sucedido Tipo de dados: cadeia de caracteres | | status_message | Descrição do estado atual. Tipo de dados: cadeia de caracteres | [ ] ### Solicitação de cURL O exemplo a seguir mostra como importar a aplicação localizada em `https://code.devsnc.com/some-user/ncRegrApp1.git` em `main_branch`. curl "https://instance.servicenow.com/api/sn_cicd/sc/import?repo_url=https%3A%2F%2Fcode.devsnc.com%2Fsome-user%2FncRegrApp1.git&branch_name=main_branch&credential_sys_id=af9b6d6180feb010f8779c30d4dd6b6b" \ --request POST \ --header "Accept:application/json" \ --user 'admin':'admin' Retorna o andamento da importação. { "result": { "links": { "progress": { "id": "a18c06ea64f23010f87769cd983d4574", "url": "https://instance.servicenow.com/api/sn_cicd/progress/a18c06ea64f23010f87769cd983d4574" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "", "percent_complete": 0 } } ## IC/CD - POST /sn_cicd/testsuite/run {#ariaid-title21} Inicia um pacote de testes automatizados especificado. O pacote de testes é executado na instância da qual o endpoint foi chamado. Nota: Se o pacote que você está executando contiver testes de IU, você deverá ter um Executor de teste do cliente programado aberto ou ser capaz de configurar a execução do Executor de teste remoto. Para saber mais, consulte [Navegador remoto para Automated Test Framework](https://www.servicenow.com/docs/access?context=atf-headless-browser&version=xanadu&pubname=xanadu-application-development&ft:locale=en-US). ### Formato da URL {#cicd-POST-testsuite-run__section_mvk_l2s_zlb} URL com controle de versões: /api/sn_cicd/{api_version}/testsuite/run URL padrão: /api/sn_cicd/testsuite/run ### Parâmetros de solicitação compatíveis {#cicd-POST-testsuite-run__entry__2}{#cicd-POST-testsuite-run__version-RESTAPI} | Nome | Descrição | |-|-| | api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres | [Tabela 115. Parâmetros de caminho] {#cicd-POST-testsuite-run__entry__6} | Nome | Descrição | |-|-| | navegador_nome | Nome do navegador a ser usado para executar o teste do cliente. Este valor deve corresponder ao especificado no executor de teste do cliente programado. Para obter informações adicionais sobre executores de teste do cliente programados, consulte [Executores de teste](https://developer.servicenow.com/app.do#!/training/article/app_store_learnv2_atf_rome_using_the_automated_test_framework/app_store_learnv2_atf_rome_scheduled_client_test_runners?v=utah)do cliente programados. Tipo de dados: cadeia de caracteres Valores válidos: (devem estar todos em minúsculas) * qualquer * cromado * firefox * borda * ou seja, * safári {#cicd-POST-testsuite-run__ul_thd_qln_3jb} Padrão: qualquer | | navegador_versão | Valor inicial da versão do navegador especificado em browser_name a ser usado para executar o teste. Por exemplo, se você inserir "9", todas as versões 9.xxx serão habilitadas. Este valor deve corresponder ao especificado no executor de teste do cliente programado. Tipo de dados: cadeia de caracteres | | é_desempenho_executar | Opcional. Sinalizador que indica se o pacote de testes deve ser executado como um teste de desempenho (Execução de desempenho). Valores válidos: * verdadeiro: executa o pacote de testes como um teste de desempenho. * falso: executa o pacote de testes com o comportamento padrão de um teste funcional padrão da instância. {#cicd-POST-testsuite-run__ul_lcr_c45_lbc} Padrão: falso | | os_name | Nome do sistema operacional no qual o pacote de testes será executado. Este valor deve corresponder ao especificado no executor de teste do cliente programado. Tipo de dados: cadeia de caracteres | | os_version | Valor inicial da versão do sistema operacional sob o qual o pacote de testes será executado. Por exemplo, se você inserir "8", isso habilitará todas as versões 8.xxx. Este valor deve corresponder ao especificado no executor de teste do cliente programado. Tipo de dados: cadeia de caracteres | | executar_em_nuvem | Opcional. Sinalizador que indica se o pacote de testes deve ser executado no Cloud Runner ou manualmente. Valores válidos: * verdadeiro: executa o pacote de testes usando o Cloud Runner. * falso: executa o pacote de testes usando o executor de teste manual. {#cicd-POST-testsuite-run__ul_jqw_145_lbc} Padrão: falso | | test_suite_sys_id | Obrigatório se test_suite_name não for especificado. O sys_id do pacote de testes a ser executado. Este valor está localizado na tabela Teste \[sys_atf_test_suite\]. Tipo de dados: cadeia de caracteres | | test_suite_name | Obrigatório se test_suite_sys_id não for especificado. O nome do pacote de testes a ser executado. Este valor está localizado na tabela Teste \[sys_atf_test_suite\]. Tipo de dados: cadeia de caracteres | [Tabela 116. Parâmetros de consulta] {#cicd-POST-testsuite-run__entry__24} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 117. Parâmetros do corpo da solicitação (XML ou JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-testsuite-run__entry__28}{#cicd-POST-testsuite-run__accept-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json | [Tabela 118. Cabeçalhos da solicitação] {#cicd-POST-testsuite-run__entry__32} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 119. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#cicd-POST-testsuite-run__entry__36}{#cicd-POST-testsuite-run__entry-200-status-code}{#cicd-POST-testsuite-run__row-401-status-code}{#cicd-POST-testsuite-run__row-403-status-code}{#cicd-POST-testsuite-run__row-404-status-code}{#cicd-POST-testsuite-run__row-405-status-code}{#cicd-POST-testsuite-run__row-409-status-code}{#cicd-POST-testsuite-run__row-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 401 | As credenciais do usuário estão incorretas. | | 403 | Proibido. O usuário não é um administrador ou não tem a função sn_cicd.sys_ci_automation. | | 404 | Não encontrado. O item solicitado não foi encontrado. | | 405 | Método inválido. A funcionalidade está inativa. | | 409 | Conflito. O item solicitado não é exclusivo. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. | [Tabela 120. Códigos de status] ### Parâmetros do corpo da resposta (JSON ou XML) {#cicd-POST-testsuite-run__entry__52}{#cicd-POST-testsuite-run__row-error}{#cicd-POST-testsuite-run__row-link}{#cicd-POST-testsuite-run__row-links_progress}{#cicd-POST-testsuite-run__row-links_progress_id}{#cicd-POST-testsuite-run__row-links_progress_url}{#cicd-POST-testsuite-run__row-links_results}{#cicd-POST-testsuite-run__row-links_results_id}{#cicd-POST-testsuite-run__row-links_results_url}{#cicd-POST-testsuite-run__row-percent_complete}{#cicd-POST-testsuite-run__row-status}{#cicd-POST-testsuite-run__row-status_detail}{#cicd-POST-testsuite-run__row-status_label}{#cicd-POST-testsuite-run__row-status_message} | Nome | Descrição | |-|-| | erro | Mensagens de erro Tipo de dados: cadeia de caracteres | | links | Todos os links e sys_ids associados à resposta. Tipo de dados: objeto "links": { "progress": {Object} } | | links.progress | Descreve as informações do link de andamento. Tipo de dados: objeto "progress": { "id": "String", "url": "String" } | | links.progress.id | Identificador exclusivo a ser usado para obter os detalhes do andamento da operação. Use este valor ao chamar o endpoint /sn_cicd/progress/{progress_id}. Tipo de dados: cadeia de caracteres | | links.progress.url | URL a ser usada para recuperar os detalhes do andamento. Tipo de dados: cadeia de caracteres | | links.resultados | Informações dos resultados. Tipo de dados: objeto "results": { "id": "String", "url": "String" } | | links.results.id | Identificador exclusivo das informações de resultados. Use este valor ao chamar o endpoint de resultados associados. Tipo de dados: cadeia de caracteres | | links.resultados.URL | URL a ser usada para obter os resultados da execução do endpoint, como resultados. Tipo de dados: cadeia de caracteres | | percent_complete | Porcentagem da solicitação que está concluída. Tipo de dados: número | | status | Estado de execução numérica. Usado com status_label. Valores: * 0 (Pendente) * 1 (em execução) * 2 (Bem-sucedido) * 3 (com falha) * 4 (Cancelado) Tipo de dados: cadeia de caracteres | | status_detail | Informações adicionais sobre o estado atual. Tipo de dados: cadeia de caracteres | | status_label | Descrição do estado de execução. Usado com status. Valores: * Cancelado(a) * Reprovado * Pendente * Em Execução * Bem-sucedido Tipo de dados: cadeia de caracteres | | status_message | Descrição do estado atual. Tipo de dados: cadeia de caracteres | [ ] ### Solicitação de cURL curl 'https://instance.servicenow.com/api/sn_cicd/testsuite/run?test_suite_sys_id=632e43900b20220050192f15d6673a7e' \ --request POST \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "links": { "progress": { "id": "0578a8d91bdc00103d374087bc4bcbcc", "url": "https://instance.service-now.com/api/sn_cicd/progress/0578a8d91bdc00103d374087bc4bcbcc" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "", "percent_complete": 0 } } Resposta de falha: { "result": { "status": "3", "status_label": "Failed", "status_message": "", "status_detail": "", "error": "Scheduled test/suite execution is disabled. Change the value of property 'sn_atf.schedule.enabled' to true to enable it" } }