API de Integração contínua/Entrega contínua (CICD)

. CICD A API fornece endpoints que permitem a integração com o comum DevOps ferramentas para criar pipelines. Essas ferramentas incluem Jenkins, Azure Pipelines, GitLab, GitHub Actions, Atlassian Bambus/pipelines e muito mais.

Ele fornece aos integradores a capacidade de criar CICD pipelines para ServiceNow AI Platform aplicações orientadas por fluxos de trabalho de solicitação de extração/mesclagem típicos no desenvolvimento orientado por origem. Ele aproveita o Controle de código-fonte, o Repositório de aplicações e o Automated Test Framework recursos.

. IC/CD A API fornece as seguintes áreas de produto e recurso:

• Controle de código-fonte

  Aplique mudanças remotas a 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 especificado e o nome da ramificação.

• Repositório de aplicações: Disponível para aplicações com escopo, aplicação global, personalizações de aplicações para aplicações com escopo no ServiceNow Store e 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 rollback.
• Lote
  • Defina um arquivo de manifesto JSON para instalar em lote várias aplicações juntas.
  • Reverta toda a instalação em lote por meio do contexto de rollback.
  • 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 rollback.
• Automated Test Framework (ATF)
  • Iniciar um pacote de testes ATF.
  • Obtenha o resultado de aprovação/reprovação 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.
• Andamento

  Obtenha a porcentagem de conclusão em uma instância para processos iniciados por outras chamadas de endpoint. Você pode usar esse recurso para pesquisar até a conclusão do andamento antes de prosseguir com a próxima etapa.

Esta API usa um modelo de resposta assíncrona. 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. Em seguida, 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 andamento, origem, resultados e/ou 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:

• Ligue para /sn_cicd/progress/progress_id endpoint usando links.progress.idparâmetro retornado pelo endpoint de inicialização.
• Ligue para /sn_cicd/testsuite/results/(result_id) endpoint usando links.result.idparâmetro retornado pelo endpoint de inicialização.
• Ligue para /sn_cicd/instance_scan/result/(progress_id) endpoint usando links.progress.idparâmetro retornado pelo endpoint de inicialização.
• Ligue para /sn_cicd/sc/apply_stash/ endpoint usando links.stash.idparâmetro retornado pelo /sn_cicd/progress/progress_id endpoint.
• Link para links.<progress/result/source/findings>.urlparâmetro retornado pelo endpoint de inicialização.

Nota:

Para instalar uma aplicação de um repositório, a aplicação deve primeiro ser publicada no repositório usando o. /sn_cicd/app_repo/publish endpoint. Uma vez publicada, 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 sn_cicd.sys_ci_automation ou admin é necessária para usar esta API.

A partir de Tokyo. CICD Endpoints de API que precisam obter o. bloqueio/mutex de largura da instância para executar a operação solicitada, usará uma fila, em vez de rejeitar solicitações enquanto bloqueio/mutex de largura da instância ocupado. Vários CICD os pipelines fazem solicitações simultaneamente sem detectar a rejeição e tentar novamente 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ção da aplicação . A partir daqui, a fila pode ser pausada e retomada pelo administrador para permitir outras operações manuais que podem exigir o. bloqueio/mutex de largura da instância .

Nota:

Quando pausada, 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. Qualquer operação em andamento seja concluída antes do início do upgrade.

Nota:

A fila é retomada 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://plugins.jenkins.io/servicenow-cicd/
• https://marketplace.visualstudio.com/items?itemName=ServiceNow.vss-services-servicenow-cicd
• https://github.com/marketplace?type=actions&query=servicenow
• https://hub.docker.com/r/servicenowdevx/sncicd-gitlab-docker

IC/cd - OBTER /sn_cicd/app/batch/results/(result_id)

Retorna os resultados de uma instalação em lote com base em um identificador de resultado especificado.

Chame este método depois de chamar /sn_cicd/app/batch/install endpoint para obter os resultados da instalação em lote. Use o valor retornado em links.results.idparâmetro dos resultados de retorno de /sn_cicd/app/batch/install endpoint como result_idpara este endpoint. Você também pode ligar para /api/sn_cicd/progress/ endpoint para obter informações sobre o andamento da instalação, caso ela ainda não tenha sido concluída.

Formato de URL

URL com controle de versão: /api/sn_cid//app/batch/results/(result_id)

URL padrão: /api/sn_cicd/app/batch/results/

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente 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 retornar informações de resultados. Este valor é retornado em links.results.idparâmetro do /sn_cicd/app/batch/install endpoint. Tipo de dados: Cadeia de caracteres

Tabela 2. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 3. Solicitar parâmetros do corpo (XML ou JSON)

Nome	Descrição
Nenhum(a)

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 .

Tabela 4. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 5. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 6. Códigos de status

Código do 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.

Parâmetros do corpo da resposta (JSON ou XML)

Nome	Descrição
erro	Mensagem de erro com detalhes sobre o 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 batch_items.typeo parâmetro está definido como aplicação ou plug-in e o. requested_customization_versiono parâmetro é passado na solicitação de instalação em lote. Versão da aplicação da loja ou com escopo ServiceNow pacote de personalização de plug-in a ser instalado, como 1.0.2 ou 2,3. Tipo de dados: Cadeia de caracteres
batch_items.id	Sys_id da aplicação ou identificador do plug-in a ser instalado. Igual a packages.idparâmetro em iniciando /sn_cicd/app/batch/install chamada de endpoint. Tipo de dados: Cadeia de caracteres
batch_items.install_date	Data e hora em que o pacote foi instalado. Vazio se a solicitação ainda estiver em andamento. Tipo de dados: Cadeia de caracteres
batch_items.name	Nome do pacote. Tipo de dados: Cadeia de caracteres
batch_items.notes	Anotações especificadas pelo usuário sobre o pacote. Igual a packages.notesparâmetro em iniciando /sn_cicd/app/batch/install chamada de endpoint. Tipo de dados: Cadeia de caracteres
batch_items.state	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 que ocorreram durante a instalação do pacote e/ou personalizações. Tipo de dados: Cadeia de caracteres
batch_items.type	Tipo de aplicação. Igual a packages.typeparâmetro em iniciando /sn_cicd/app/batch/install chamada de endpoint. Valores válidos: aplicação plug-in Tipo de dados: Cadeia de caracteres
batch_items.url	URL do registro de instalação do pacote associado em seu ServiceNow instância. Tipo de dados: Cadeia de caracteres
batch_items.version	Versão do pacote a ser instalada, como 1.0.2 ou 2,3. Igual a packages.requested_versionparâmetro em iniciando /sn_cicd/app/batch/install chamada de endpoint. 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" }
batch_plan.id	Sys_id das informações de resultados de retorno. Mesmo valor que foi passado em result_idparâmetro da solicitação. Tipo de dados: Cadeia de caracteres
batch_plan.name	Nome descritivo especificado pelo usuário para esta solicitação em lote. Igual a nameparâmetro em iniciando /sn_cicd/app/batch/install chamada de endpoint. Tipo de dados: Cadeia de caracteres
batch_plan.notes	Anotações que foram passadas quando a instalação em lote foi invocada. Igual a notesparâmetro em iniciando /sn_cicd/app/batch/install chamada de endpoint. Tipo de dados: Cadeia de caracteres
batch_plan.state	Estado atual da instalação geral em lote. Valores possíveis: Reprovado Em andamento Instalado Inválida Instalação parcial Pronto Revertido Tipo de dados: Cadeia de caracteres
batch_plan.url	URL do registro do plano de instalação em lote no seu ServiceNow instância. Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo verifica o status de um plano de instalação em lote chamado Operações DE TI da versão 2,0.

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 - OBTÉM /sn_cicd/instance_scan/result/(progress_id)

Retorna o andamento atual e o status 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 do Serviço de execução de verificação de instância CICD API e é usada em sn_cicd namespace.

Formato de URL

URL com controle de versão: /api/sn_cid//instance_scan/result/(progress_id)

URL padrão: /api/sn_cicd/instance_scan/result/

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

Parâmetros de solicitação compatíveis

Tabela 7. Parâmetros

Parâmetro	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente 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 retornar informações de andamento. Este valor é retornado em links.progress.idparâmetro 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

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 .

Tabela 8. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 9. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

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 .

Tabela 10. Códigos de status

Código do 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.

Corpo da solicitação

A API aceita esses elementos JSON ou XML no corpo da solicitação.

Tabela 11. Elementos aceitos no corpo da solicitação

Elemento	Descrição
Nenhum(a)

Corpo da resposta

A API retorna esses elementos JSON ou XML no corpo da resposta.

Tabela 12. Elementos retornados no corpo da resposta

Elemento	Descrição
erro	Mensagem de erro com detalhes sobre o erro. Tipo de dados: Cadeia de caracteres
links	Informações sobre links e sys_ids associados ao conjunto de atualizações. Tipo de dados: Objeto "links": { "progress": {Object} }
links.descobertas	Objeto que contém informações sobre as descobertas da verificação da instância.
rótulo.descobertas.links	Informações adicionais sobre as descobertas da verificação da instância.
links.findings.url	URL a ser usado para recuperar uma lista de registros que violaram as verificações.
links.progress	Informações de andamento sobre a operação realizada no conjunto de atualizações. 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 sobre a operação realizada no conjunto de atualizações. Tipo de dados: Cadeia de caracteres
resultados.links	ID e URL dos resultados da execução. 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.results.url	URL a ser usada para obter os resultados da verificação da instância.
status	Número que representa o estado de execução da ação executada no conjunto de atualizações. Corresponde ao status_labeldescritor. Valores possíveis: 0: Pendente 1: Em execução 2: Bem-sucedido 3: Falha 4: Cancelado Tipo de dados: Cadeia de caracteres
status_detail	Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detailed_message na tabela Rastreador de execução [sys_execution_tracker]. Tipo de dados: Cadeia de caracteres
status_label	Status de execução da ação do conjunto de atualizações. Corresponde ao statusnúmero. Valores possíveis: Cancelado Reprovado Pendente(s) Em execução Bem-sucedido Tipo de dados: Cadeia de caracteres
status_message	Informações adicionais sobre o motivo da falha da operação. Retorna uma cadeia de caracteres vazia se a operação for bem-sucedida. Tipo de dados: Cadeia de caracteres

Solicitação de cURL de amostra

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 - OBTER /sn_cicd/progress/

Retorna o andamento atual e o status do Integração e entrega contínuas (CICD) Função 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/run ou /sn_cicd/sc/apply_stash .

Formato de URL

URL com controle de versão: /api/sn_cid//progress/

URL padrão: /api/sn_cicd/progress/

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

Parâmetros de solicitação compatíveis

Tabela 13. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente 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 retornar informações de andamento. Este valor é retornado em links.progress.idparâmetro do endpoint que iniciou a ação, como /sn_cicd/app_repo/publish , /sn_cicd/app_repo/install , /sn_cicd/testsuite/run ou /sn_cicd/sc/apply_stash . Tipo de dados: Cadeia de caracteres

Tabela 14. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 15. Solicitar parâmetros do corpo (XML ou JSON)

Nome	Descrição
Nenhum(a)

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 .

Tabela 16. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 17. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 18. Códigos de status

Código do 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.

Parâmetros do corpo da resposta (JSON ou XML)

Nome	Descrição
erro	Mensagem de erro com detalhes sobre o erro. Tipo de dados: Cadeia de caracteres
links	Informações sobre links e sys_ids associados ao conjunto de atualizações. Tipo de dados: Objeto "links": { "progress": {Object} }
links.progress	Informações de andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Objeto "progress": { "id": "String", "url": "String" }
links.progress.id	Sys_id que contém detalhes do andamento da operação. Você pode usar este valor ao chamar o endpoint IC/cd - OBTER /sn_cicd/progress/. Tipo de dados: Cadeia de caracteres
links.progress.url	URL a ser usada para recuperar os detalhes do andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Cadeia de caracteres
resultados.links	ID e URL dos resultados da execução. Tipo de dados: Objeto "results": { "id": "String", "url": "String" }
links.results.id	Sys_id das informações de resultados. Use este valor ao chamar o endpoint de resultados associado. Tipo de dados: Cadeia de caracteres
links.results.url	URL a ser usada para obter os resultados da execução do endpoint. Tipo de dados: Cadeia de caracteres
links.source	Sys_id e informações de URL sobre o registro de origem na tabela Rastreador de execução [sys_execution_tracker]. Tipo de dados: Objeto "source": { "id": "String", "url": "String" }
links.source.id	Identificador exclusivo do registro de origem. Tabela: Tabela Rastreador de execução [sys_execution_tracker] Tipo de dados: Cadeia de caracteres
links.source.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 um apply_changes este objeto contém 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 /Sn_cicd/sc/apply_stash/ endpoint para aplicar o stash. Tipo de dados: Cadeia de caracteres
stash.url	URL do stash associado. Tipo de dados: Cadeia de caracteres
percent_complete	Porcentagem da solicitação concluída. Tipo de dados: Número
status	Número que representa o estado de execução da ação executada no conjunto de atualizações. Corresponde ao status_labeldescritor. Valores possíveis: 0: Pendente 1: Em execução 2: Bem-sucedido 3: Falha 4: Cancelado Tipo de dados: Cadeia de caracteres
status_detail	Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detailed_message na tabela Rastreador de execução [sys_execution_tracker]. Tipo de dados: Cadeia de caracteres
status_label	Status de execução da ação do conjunto de atualizações. Corresponde ao statusnúmero. Valores possíveis: Cancelado Reprovado Pendente(s) Em execução Bem-sucedido Tipo de dados: Cadeia de caracteres
status_message	Descrição adicional do estado atual da ação, se disponível. Tipo de dados: Cadeia de caracteres

Obtenha 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 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 Aplicar mudanças. Nesse caso, houve mudanças não salvas/não confirmadas na instância no Studio, portanto, um stash foi criado para conter as mudanças não salvas

curl 'instance.servicenow.com/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd' \
--request GET \
--header 'Accept: application/json' \
--user 'username':'password'

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

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 - OBTÉM /sn_cicd/testsuite/results/(result_id)

Retorna os resultados de uma execução de pacote de testes com base em um identificador de resultados especificado.

Chame este endpoint após a chamada /sn_cicd/progress/progress_id para obter o resultado do pacote de testes executado.

Formato de URL

URL com controle de versão: /api/sn_cid//testsuite/results/(result_id)

URL padrão: /api/sn_cicd/testsuite/results/

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

Parâmetros de solicitação compatíveis

Tabela 19. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente 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. Correspondente /sn_cicd/progress/progress_id a chamada de endpoint retorna essas informações. Tipo de dados: Cadeia de caracteres

Tabela 20. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 21. Solicitar parâmetros do corpo (XML ou JSON)

Nome	Descrição
Nenhum(a)

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 .

Tabela 22. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 23. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 24. Códigos de status

Código do 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.

Parâmetros do corpo da resposta (JSON ou XML)

Nome	Descrição
child_suite_results	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
resultados.links	Objeto que contém as informações de resultados. Tipo de dados: Objeto
links.results.id	Identificador exclusivo das informações dos resultados. Use este valor ao chamar o endpoint /sn_cicd/testsuite/results/(result_id) . Tipo de dados: Cadeia de caracteres
links.results.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 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 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érico. Usado com status_label, Como 0: Pendente. Valores: 0 (pendente) 1 (em execução) 2 (bem-sucedido) 3 (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, Como 0: Pendente. Valores: Pendente Em execução Bem-sucedido Reprovado Cancelado Tipo de dados: Cadeia de caracteres
status_message	Descrição do estado atual. Tipo de dados: Cadeia de caracteres
test_suite_duration	Tempo necessário 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

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 da Store no repositório de aplicações
• ServiceNow plug-in:

  Personalizações de aplicações com escopo que foram empacotadas em um plug-in e publicadas no repositório de aplicações.

Nota:

Este endpoint usa um modelo de resposta assíncrono. Quando você chama um endpoint, ele inicia a função associada, como iniciar a execução do plano de instalação em lote. Em seguida, 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 de URL

URL com controle de versão: /api/sn_cid//app/batch/install

URL padrão: /api/sn_cicd/app/batch/install

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

Parâmetros de solicitação compatíveis

Tabela 25. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres

Tabela 26. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 27. Solicitar parâmetros do corpo (XML ou JSON)

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	Anotações adicionais especificadas pelo usuário 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" }]
packages.id	Obrigatório. Sys_id da aplicação ou identificador do plug-in a ser instalado. Tipo de dados: Cadeia de caracteres
packages.load_demo_data	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
packages.notes	Anotações especificadas pelo usuário sobre o pacote. Tipo de dados: Cadeia de caracteres Padrão: Nulo
packages.requested_customization_version	Versão da personalização da aplicação para a aplicação da loja ou para o escopo ServiceNow plug-in 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.
packages.requested_version	Necessário se packages.typeestá definido como aplicação ignorado se definido como plug-in . Versão do pacote a ser instalada, como 1.0.2 ou 2,3. Tipo de dados: Cadeia de caracteres
packages.type	Obrigatório. Tipo de pacote. Valores válidos: aplicação plug-in Tipo de dados: Cadeia de caracteres

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 .

Tabela 28. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 29. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 30. Códigos de status

Código do 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.

Parâmetros do corpo da resposta (JSON ou XML)

Nome	Descrição
erro	Mensagem de erro com detalhes sobre o 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	Informações de andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Objeto "progress": { "id": "String", "url": "String" }
links.progress.id	Sys_id que contém detalhes do andamento da operação. Você pode usar este valor ao chamar o endpoint IC/cd - OBTER /sn_cicd/progress/. Tipo de dados: Cadeia de caracteres
links.progress.url	URL a ser usada para recuperar os detalhes do andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Cadeia de caracteres
resultados.links	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.urlpara consultar os resultados da instalação em lote. Tipo de dados: Cadeia de caracteres
links.results.url	URL a ser usado para recuperar os resultados da instalação em lote. Tipo de dados: Cadeia de caracteres
links.rollback	Descreve as informações de rollback da instalação em lote. Tipo de dados: Objeto "rollback": { "id": "String" }
links.rollback.id	Sys_id dos detalhes de rollback dos pacotes instalados. Use este parâmetro para reverter a instalação dos pacotes especificados para suas versões anteriores usando /sn_cicd/app/batch/rollback/ endpoint. Nota: O recurso de rollback só estará disponível após a conclusão da instalação. Tipo de dados: Cadeia de caracteres
percent_complete	Porcentagem da solicitação concluída. Tipo de dados: Número
status	Número que representa o estado de execução da ação executada no conjunto de atualizações. Corresponde ao status_labeldescritor. Valores possíveis: 0: Pendente 1: Em execução 2: Bem-sucedido 3: Falha 4: Cancelado Tipo de dados: Cadeia de caracteres
status_detail	Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detailed_message na tabela Rastreador de execução [sys_execution_tracker]. Tipo de dados: Cadeia de caracteres
status_label	Status de execução da ação do conjunto de atualizações. Corresponde ao statusnúmero. Valores possíveis: Cancelado Reprovado Pendente(s) Em execução Bem-sucedido Tipo de dados: Cadeia de caracteres
status_message	Descrição adicional do estado atual da ação, se disponível. Tipo de dados: Cadeia de caracteres

Solicitação de curl

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

/Sn_cicd/app/batch/rollback/

Reverte todos os pacotes associados a uma instalação em lote específica para suas versões anteriores.

Este endpoint funciona em conjunto com /sn_cicd/app/batch/install endpoint. . rollback_idé fornecido nos resultados de retorno deste endpoint. 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íncrono. Quando você chama um endpoint, ele inicia a função associada, como iniciar a execução do plano de instalação em lote. Em seguida, 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 de URL

URL com controle de versão: /api/sn_cid//app/batch/rollback/

URL padrão: /api/sn_cicd/app/batch/rollback/

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

Parâmetros de solicitação compatíveis

Tabela 31. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente 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 reverter os pacotes instalados para suas versões anteriores. Este valor é retornado em links.rollback.idparâmetro do /sn_cicd/app/batch/install endpoint. Tipo de dados: Cadeia de caracteres

Tabela 32. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 33. Solicitar parâmetros do corpo (XML ou JSON)

Nome	Descrição
Nenhum(a)

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 .

Tabela 34. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 35. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 36. Códigos de status

Código do 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.

Parâmetros do corpo da resposta (JSON ou XML)

Nome	Descrição
erro	Mensagem de erro com detalhes sobre o 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	Informações de andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Objeto "progress": { "id": "String", "url": "String" }
links.progress.id	Sys_id que contém detalhes do andamento da operação. Você pode usar este valor ao chamar o endpoint IC/cd - OBTER /sn_cicd/progress/. Tipo de dados: Cadeia de caracteres
links.progress.url	URL a ser usada para recuperar os detalhes do andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Cadeia de caracteres
percent_complete	Porcentagem da solicitação concluída. Tipo de dados: Número
status	Número que representa o estado de execução da ação executada no conjunto de atualizações. Corresponde ao status_labeldescritor. Valores possíveis: 0: Pendente 1: Em execução 2: Bem-sucedido 3: Falha 4: Cancelado Tipo de dados: Cadeia de caracteres
status_detail	Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detailed_message na tabela Rastreador de execução [sys_execution_tracker]. Tipo de dados: Cadeia de caracteres
status_label	Status de execução da ação do conjunto de atualizações. Corresponde ao statusnúmero. Valores possíveis: Cancelado Reprovado Pendente(s) Em execução Bem-sucedido Tipo de dados: Cadeia de caracteres
status_message	Descrição adicional do estado atual da ação, se disponível. Tipo de dados: Cadeia de caracteres

Solicitação de curl

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

Instala a aplicação especificada do repositório de aplicações na instância que faz a chamada de endpoint.

Usando este endpoint, você pode instalar inalterados e personalizados ServiceNow sistema de base e. ServiceNow Store aplicações, personalizadas ServiceNow e seus próprios plug-ins ServiceNow aplicações.

A seguir, você descreve os parâmetros que 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 de base e não as personalizações correspondentes da aplicação.
  • Sys_id: Sys_id da aplicação de base que foi personalizada.
  • Base_app_version: Versão da aplicação de base a ser instalada.
• Para instalar uma versão especificada das personalizações da aplicação e instalar automaticamente a versão de base recomendada da aplicação. A versão da aplicação de base recomendada é a versão da aplicação de base que foi 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 de aplicação de base recomendada correspondente.
  • Sys_id: Sys_id da aplicação que foi personalizada.
  • auto_upgrade_base_app: verdadeiro
  • Versão: Versão das personalizações da aplicação a serem instaladas.
• Para instalar a versão mais recente das personalizações da aplicação e sua versão de base recomendada correspondente.
  • Sys_id: Sys_id da aplicação que foi personalizada.
  • auto_upgrade_base_app: verdadeiro
• Para instalar a versão mais recente das personalizações da aplicação, mas não fazer upgrade da aplicação de base para a versão da aplicação de base recomendada para personalizações da aplicação.
  • Sys_id: Sys_id da aplicação que foi personalizada.
  • auto_upgrade_base_app: falso
• Para instalar personalizações da aplicação junto com o escopo ServiceNow plug-in 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.
  • Versão: Versão das personalizações da aplicação a serem instaladas.
• Para instalar personalizações da 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
  • Versão: Versão das personalizações da aplicação a serem instaladas.

Como os plug-ins de base podem ter apenas uma versão por versão de família, o. auto_upgrade_base_appe. base_app_versionos parâmetros não se aplicam a instalações de personalização de aplicações para plug-ins. Para ativar um plug-in pela primeira vez em uma instância, use /sn_cicd/plug-in//activate em vez disso, endpoint.

Nota:

Este endpoint usa um modelo de resposta assíncrono. Quando você chama um endpoint, ele inicia a função associada, como iniciar a execução do plano de instalação em lote. Em seguida, 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 de URL

URL com controle de versão: /api/sn_cid//app_repo/install

URL padrão: /api/sn_cicd/app_repo/install

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

Parâmetros de solicitação compatíveis

Tabela 37. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres

Tabela 38. Parâmetros de consulta

Nome	Descrição
auto_upgrade_base_app	Aplicável somente se você pretende instalar personalizações da aplicação e a aplicação de base foi criada em uma versão posterior à versão instalada no momento. Sinalizador que indica se a aplicação de base associada deve ser atualizada automaticamente para uma versão posterior. Valores válidos: Verdadeiro: Faça upgrade automaticamente da aplicação de base associada. Falso: Deixe a aplicação de base como a versão atualmente instalada na instância. Tipo de dados: Booliano Padrão: falso
base_app_version	Versão da aplicação de base a ser instalada. Uma aplicação de base é qualquer aplicação de terceiros disponível no ServiceNow Store. Se a aplicação não tiver personalizações da aplicação ou se a aplicação tiver personalizações da aplicação e você estiver atualizando apenas a aplicação de 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 passe o. versionparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Nulo
scope	Necessário se sys_idnão foi especificado. Nome do escopo da aplicação, como x_aah_custom_app . Tipo de dados: Cadeia de caracteres Tabela: No campo Escopo na tabela Aplicação personalizada [sys_app] ou Aplicação da loja [sys_store_app].
sys_id	Necessário se scopenão foi especificado. Sys_id da aplicação a ser instalada. Tipo de dados: Cadeia de caracteres Tabela: No campo SYS ID na tabela Aplicação personalizada [sys_app] ou Aplicação da loja [sys_store_app].
versão	Versão da aplicação a ser instalada. Tipo de dados: Cadeia de caracteres Padrão: Se base_app_versiono parâmetro está vazio e auto_upgrade_base_appo parâmetro está definido como verdadeiro, instala as personalizações mais recentes da aplicação e sua versão de base recomendada (desde que não faça downgrade da aplicação de base.) . auto_upgrade_base_appo parâmetro é falso, instala as personalizações da aplicação, mas a aplicação de base não é atualizada. . base_app_versiono parâmetro é definido, instala somente a aplicação de base.

Tabela 39. Solicitar parâmetros do corpo (XML ou JSON)

Nome	Descrição
Nenhum(a)

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 .

Tabela 40. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 41. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 42. Códigos de status

Código do 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.

Parâmetros do corpo da resposta (JSON ou XML)

Nome	Descrição
erro	Mensagem de erro com detalhes sobre o erro. Tipo de dados: Cadeia de caracteres
links	Informações sobre links e sys_ids associados ao conjunto de atualizações. Tipo de dados: Objeto "links": { "progress": {Object} }
links.progress	Informações de andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Objeto "progress": { "id": "String", "url": "String" }
links.progress.id	Sys_id que contém detalhes do andamento da operação. Você pode usar este valor ao chamar o endpoint IC/cd - OBTER /sn_cicd/progress/. Tipo de dados: Cadeia de caracteres
links.progress.url	URL a ser usada para recuperar os detalhes do andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Cadeia de caracteres
percent_complete	Porcentagem da solicitação concluída. Tipo de dados: Número
rollback_version	Se disponível, a versão instalada anteriormente. Se não estiver disponível, nulo. Tipo de dados: Cadeia de caracteres
status	Número que representa o estado de execução da ação executada no conjunto de atualizações. Corresponde ao status_labeldescritor. Valores possíveis: 0: Pendente 1: Em execução 2: Bem-sucedido 3: Falha 4: Cancelado Tipo de dados: Cadeia de caracteres
status_detail	Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detailed_message na tabela Rastreador de execução [sys_execution_tracker]. Tipo de dados: Cadeia de caracteres
status_label	Status de execução da ação do conjunto de atualizações. Corresponde ao statusnúmero. Valores possíveis: Cancelado Reprovado Pendente(s) Em execução Bem-sucedido Tipo de dados: Cadeia de caracteres
status_message	Descrição adicional do estado atual da ação, se disponível. 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

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 de solicitação incorreta 400. Você pode confirmar as mudanças manualmente em Studio ou ligue para POST /sn_cicd/sc/apply_changes endpoint 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.

Formato de URL

URL com controle de versão: /api/sn_cid//app_repo/publish

URL padrão: /api/sn_cicd/app_repo/publish

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

Parâmetros de solicitação compatíveis

Tabela 43. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres

Tabela 44. Parâmetros de consulta

Nome	Descrição
dev_notes	Anotações do desenvolvedor a serem armazenadas com a aplicação . Tipo de dados: Cadeia de caracteres
scope	Necessário se sys_idnão foi especificado. O escopo da aplicação. Tipo de dados: Cadeia de caracteres Tabela: No campo Escopo da tabela Aplicação personalizada [sys_app].
sys_id	Necessário se scopenão foi especificado. O sys_id da aplicação a ser armazenada no repositório. Tipo de dados: Cadeia de caracteres Tabela: No campo SYS ID da tabela Aplicação personalizada [sys_app].
versão	Versão na 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 da aplicação. Tipo de dados: Cadeia de caracteres

Tabela 45. Solicitar parâmetros do corpo (XML ou JSON)

Nome	Descrição
Nenhum(a)

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 .

Tabela 46. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 47. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 48. Códigos de status

Código do 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.

Parâmetros do corpo da resposta (JSON ou XML)

Nome	Descrição
erro	Mensagem de erro com detalhes sobre o erro. Tipo de dados: Cadeia de caracteres
links	Informações sobre links e sys_ids associados ao conjunto de atualizações. Tipo de dados: Objeto "links": { "progress": {Object} }
links.progress	Informações de andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Objeto "progress": { "id": "String", "url": "String" }
links.progress.id	Sys_id que contém detalhes do andamento da operação. Você pode usar este valor ao chamar o endpoint IC/cd - OBTER /sn_cicd/progress/. Tipo de dados: Cadeia de caracteres
links.progress.url	URL a ser usada para recuperar os detalhes do andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Cadeia de caracteres
percent_complete	Porcentagem da solicitação concluída. Tipo de dados: Número
status	Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detailed_message na tabela Rastreador de execução [sys_execution_tracker]. Tipo de dados: Cadeia de caracteres
status_detail	Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detailed_message na tabela Rastreador de execução [sys_execution_tracker]. Tipo de dados: Cadeia de caracteres
status_label	Status de execução da ação do conjunto de atualizações. Corresponde ao statusnúmero. Valores possíveis: Cancelado Reprovado Pendente(s) Em execução Bem-sucedido Tipo de dados: Cadeia de caracteres
status_message	Descrição adicional do estado atual da ação, se disponível. 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

Inicia uma reversão de uma aplicação especificada para uma versão especificada.

Nota:

A funcionalidade de rollback só estará disponível após a conclusão da instalação.

Formato de URL

URL com controle de versão: /api/sn_cid//app_repo/rollback

URL padrão: /api/sn_cicd/app_repo/rollback

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

Parâmetros de solicitação compatíveis

Tabela 49. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres

Tabela 50. Parâmetros de consulta

Nome	Descrição
scope	Necessário se sys_idnão foi especificado. O nome do escopo da aplicação a ser revertida. Tipo de dados: Cadeia de caracteres
sys_id	Necessário se scopenão foi especificado. O sys_id da aplicação a ser revertida. Tipo de dados: Cadeia de caracteres
versão	Obrigatório. Versão da aplicação esperada após a operação de rollback. Se a solicitação for reverter uma instalação de Personalização da aplicação, defina este campo como a versão da aplicação de base que o sistema deve ter após a operação de reversão. Tipo de dados: Cadeia de caracteres

Tabela 51. Solicitar parâmetros do corpo (XML ou JSON)

Nome	Descrição
Nenhum(a)

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 .

Tabela 52. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 53. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 54. Códigos de status

Código do 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.

Parâmetros do corpo da resposta (JSON ou XML)

Nome	Descrição
erro	Mensagem de erro com detalhes sobre o erro. Tipo de dados: Cadeia de caracteres
links	Informações sobre links e sys_ids associados ao conjunto de atualizações. Tipo de dados: Objeto "links": { "progress": {Object} }
links.progress	Informações de andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Objeto "progress": { "id": "String", "url": "String" }
links.progress.id	Sys_id que contém detalhes do andamento da operação. Você pode usar este valor ao chamar o endpoint IC/cd - OBTER /sn_cicd/progress/. Tipo de dados: Cadeia de caracteres
links.progress.url	URL a ser usada para recuperar os detalhes do andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Cadeia de caracteres
percent_complete	Porcentagem da solicitação concluída. Tipo de dados: Número
status	Número que representa o estado de execução da ação executada no conjunto de atualizações. Corresponde ao status_labeldescritor. Valores possíveis: 0: Pendente 1: Em execução 2: Bem-sucedido 3: Falha 4: Cancelado Tipo de dados: Cadeia de caracteres
status_detail	Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detailed_message na tabela Rastreador de execução [sys_execution_tracker]. Tipo de dados: Cadeia de caracteres
status_label	Status de execução da ação do conjunto de atualizações. Corresponde ao statusnúmero. Valores possíveis: Cancelado Reprovado Pendente(s) Em execução Bem-sucedido Tipo de dados: Cadeia de caracteres
status_message	Descrição adicional do estado atual da ação, se disponível. 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
  }
}

POST /sn_cicd/instance_scan/full_scan

Executa todas as verificações ativas presentes em sua instância.

Você pode executar verificações fornecidas com Instance Scan ou você pode criar suas próprias verificações. Para obter mais informações, consulte Verificação de instância .

Nota:

Este endpoint faz parte do Serviço de execução de verificação de instância CICD API e é usada em sn_cicd namespace.

Formato de URL

URL com controle de versão: /api/sn_cid//instance_scan/full_scan

URL padrão: /api/sn_cicd/instance_scan/full_scan

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

Parâmetros de solicitação compatíveis

Tabela 55. Parâmetros

Parâmetro	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres

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 .

Tabela 56. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 57. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

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 .

Tabela 58. Códigos de status

Código do 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.

Corpo da solicitação

A API aceita esses elementos JSON ou XML no corpo da solicitação.

Tabela 59. Elementos aceitos no corpo da solicitação

Elemento	Descrição
Nenhum(a)

Corpo da resposta

A API retorna esses elementos JSON ou XML no corpo da resposta.

Tabela 60. Elementos retornados no corpo da resposta

Elemento	Descrição
erro	Mensagem de erro com detalhes sobre o erro. Tipo de dados: Cadeia de caracteres
links	Informações sobre links e sys_ids associados ao conjunto de atualizações. Tipo de dados: Objeto "links": { "progress": {Object} }
links.progress	Informações de andamento sobre a operação realizada no conjunto de atualizações. 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 sobre a operação realizada no conjunto de atualizações. Tipo de dados: Cadeia de caracteres
status	Número que representa o estado de execução da ação executada no conjunto de atualizações. Corresponde ao status_labeldescritor. Valores possíveis: 0: Pendente 1: Em execução 2: Bem-sucedido 3: Falha 4: Cancelado Tipo de dados: Cadeia de caracteres
status_detail	Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detailed_message na tabela Rastreador de execução [sys_execution_tracker]. Tipo de dados: Cadeia de caracteres
status_label	Status de execução da ação do conjunto de atualizações. Corresponde ao statusnúmero. Valores possíveis: Cancelado Reprovado Pendente(s) Em execução Bem-sucedido Tipo de dados: Cadeia de caracteres
status_message	Informações adicionais sobre o motivo da falha da operação. Retorna uma cadeia de caracteres vazia se a operação for bem-sucedida. Tipo de dados: Cadeia de caracteres

Solicitação de cURL de amostra

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": ""
  }
}

POST /sn_cicd/instance_scan/point_scan

Executa todas as verificações aplicáveis em 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 você pode criar suas próprias verificações. Para obter mais informações, consulte Verificação de instância .

Nota:

Este endpoint faz parte do Serviço de execução de verificação de instância CICD API e é usada em sn_cicd namespace.

Formato de URL

URL com controle de versão: /api/sn_cid//instance_scan/point_scan

URL padrão: /api/sn_cicd/instance_scan/point_scan

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

Parâmetros de solicitação compatíveis

Tabela 61. Parâmetros

Parâmetro	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente 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 verificado. Tipo de dados: Cadeia de caracteres

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 .

Tabela 62. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 63. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

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 .

Tabela 64. Códigos de status

Código do 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.

Corpo da solicitação

A API aceita esses elementos JSON ou XML no corpo da solicitação.

Tabela 65. Elementos aceitos no corpo da solicitação

Elemento	Descrição
Nenhum(a)

Corpo da resposta

A API retorna esses elementos JSON ou XML no corpo da resposta.

Tabela 66. Elementos retornados no corpo da resposta

Elemento	Descrição
erro	Mensagem de erro com detalhes sobre o erro. Tipo de dados: Cadeia de caracteres
links	Informações sobre links e sys_ids associados ao conjunto de atualizações. Tipo de dados: Objeto "links": { "progress": {Object} }
links.progress	Informações de andamento sobre a operação realizada no conjunto de atualizações. 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 sobre a operação realizada no conjunto de atualizações. Tipo de dados: Cadeia de caracteres
status	Número que representa o estado de execução da ação executada no conjunto de atualizações. Corresponde ao status_labeldescritor. Valores possíveis: 0: Pendente 1: Em execução 2: Bem-sucedido 3: Falha 4: Cancelado Tipo de dados: Cadeia de caracteres
status_detail	Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detailed_message na tabela Rastreador de execução [sys_execution_tracker]. Tipo de dados: Cadeia de caracteres
status_label	Status de execução da ação do conjunto de atualizações. Corresponde ao statusnúmero. Valores possíveis: Cancelado Reprovado Pendente(s) Em execução Bem-sucedido Tipo de dados: Cadeia de caracteres
status_message	Informações adicionais sobre o motivo da falha da operação. Retorna uma cadeia de caracteres vazia se a operação for bem-sucedida. Tipo de dados: Cadeia de caracteres

Solicitação de cURL de amostra

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": ""
  }
}

POST /sn_cicd/instance_scan/suite_scan/combo/

Executa uma verificação usando um pacote e destino (apps com escopo ou conjuntos de atualizações) que já foram executados anteriormente.

Antes de chamar este endpoint, você deve chamar /sn_cicd/instance_scan/suite_scan/ ou /sn_cicd/instance_scan/suite_scan//update_sets endpoints, ou execute uma verificação de pacote Na IU.

Nota:

Este endpoint faz parte do Serviço de execução de verificação de instância CICD API e é usada em sn_cicd namespace.

Formato de URL

URL com controle de versão: /api/sn_cid//instance_scan/suite_scan/combo/

URL padrão: /api/sn_cicd/instance_scan/suite_scan/combo/

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

Parâmetros de solicitação compatíveis

Tabela 67. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres
combo_sys_id	Sys_id da verificação a ser executada. A verificação deve ser uma verificação existente que você deseja executar novamente. Tipo de dados: Cadeia de caracteres Tabela: Combo [scan_combo]

Tabela 68. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 69. Solicitar parâmetros do corpo (XML ou JSON)

Nome	Descrição
Nenhum(a)

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 .

Tabela 70. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 71. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 72. Códigos de status

Código do 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.

Parâmetros do corpo da resposta (JSON ou XML)

Elemento	Descrição
erro	Mensagem de erro com detalhes sobre o erro. Tipo de dados: Cadeia de caracteres
links	Informações sobre links e sys_ids associados ao conjunto de atualizações. Tipo de dados: Objeto "links": { "progress": {Object} }
links.progress	Informações de andamento sobre a operação realizada no conjunto de atualizações. 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) . Tipo de dados: Cadeia de caracteres
links.progress.url	URL a ser usada para recuperar os detalhes do andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Cadeia de caracteres
status	Número que representa o estado de execução da ação executada no conjunto de atualizações. Corresponde ao status_labeldescritor. Valores possíveis: 0: Pendente 1: Em execução 2: Bem-sucedido 3: Falha 4: Cancelado Tipo de dados: Cadeia de caracteres
status_detail	Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detailed_message na tabela Rastreador de execução [sys_execution_tracker]. Tipo de dados: Cadeia de caracteres
status_label	Status de execução da ação do conjunto de atualizações. Corresponde ao statusnúmero. Valores possíveis: Cancelado Reprovado Pendente(s) Em execução Bem-sucedido Tipo de dados: Cadeia de caracteres
status_message	Informações adicionais sobre o motivo da falha da operação. Retorna uma cadeia de caracteres vazia 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": ""
  }
}

POST /sn_cicd/instance_scan/suite_scan//suite_scan//scoped_apps

Executa todas as verificações ativas em um pacote em uma lista de apps com escopo.

Nota:

Este endpoint faz parte do Serviço de execução de verificação de instância CICD API e é usada em sn_cicd namespace.

Formato de URL

URL com controle de versão: /api/sn_cid//instance_scan/suite_scan//suite_scan//scoped_apps

URL padrão: /api/sn_cicd/instance_scan/suite_scan/

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

Parâmetros de solicitação compatíveis

Tabela 73. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres
suite_sys_id	Sys_id do pacote para executar. Tipo de dados: Cadeia de caracteres Tabela: Pacote [scan_check_suite]

Tabela 74. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 75. Solicitar parâmetros do corpo (XML ou JSON)

Nome	Descrição
app_scope_sys_ids	Obrigatório. Uma lista de sys_ids das aplicações com escopo a serem verificadas. Não pode ser uma matriz vazia. Tipo de dados: Matriz app_scope_sys_ids: ["String", "String", "String"] Tabela: Aplicação [sys_scope]

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 .

Tabela 76. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou 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 77. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 78. Códigos de status

Código do 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.

Parâmetros do corpo da resposta (JSON ou XML)

Elemento	Descrição
erro	Mensagem de erro com detalhes sobre o erro. Tipo de dados: Cadeia de caracteres
links	Informações sobre links e sys_ids associados ao conjunto de atualizações. Tipo de dados: Objeto "links": { "progress": {Object} }
links.progress	Informações de andamento sobre a operação realizada no conjunto de atualizações. 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) . Tipo de dados: Cadeia de caracteres
links.progress.url	URL a ser usada para recuperar os detalhes do andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Cadeia de caracteres
status	Número que representa o estado de execução da ação executada no conjunto de atualizações. Corresponde ao status_labeldescritor. Valores possíveis: 0: Pendente 1: Em execução 2: Bem-sucedido 3: Falha 4: Cancelado Tipo de dados: Cadeia de caracteres
status_detail	Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detailed_message na tabela Rastreador de execução [sys_execution_tracker]. Tipo de dados: Cadeia de caracteres
status_label	Status de execução da ação do conjunto de atualizações. Corresponde ao statusnúmero. Valores possíveis: Cancelado Reprovado Pendente(s) Em execução Bem-sucedido Tipo de dados: Cadeia de caracteres
status_message	Informações adicionais sobre o motivo da falha da operação. Retorna uma cadeia de caracteres vazia 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 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": ""
  }
}

POST /sn_cicd/instance_scan/suite_scan//update_sets

Executa todas as verificações ativas dentro de um pacote em uma lista de conjuntos de atualizações.

Nota:

Este endpoint faz parte do Serviço de execução de verificação de instância CICD API e é usada em sn_cicd namespace.

Formato de URL

URL com controle de versão: /api/sn_cid//instance_scan/suite_scan//update_sets

URL padrão: /api/sn_cicd/instance_scan/suite_scan//update_sets

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

Parâmetros de solicitação compatíveis

Tabela 79. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres
suite_sys_id	Sys_id do pacote para executar. Tipo de dados: Cadeia de caracteres Tabela: Pacote [scan_check_suite]

Tabela 80. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 81. Solicitar parâmetros do corpo (XML ou JSON)

Nome	Descrição
update_set_sys_ids	Obrigatório. Lista de sys_ids dos conjuntos de atualizações a serem verificados. Não pode ser uma matriz vazia. Tipo de dados: Matriz update_set_sys_ids: ["String", "String", "String"] Tabela: Conjunto de atualizações [sys_update_set]

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 .

Tabela 82. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou 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 83. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 84. Códigos de status

Código do 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.

Parâmetros do corpo da resposta (JSON ou XML)

Elemento	Descrição
erro	Mensagem de erro com detalhes sobre o erro. Tipo de dados: Cadeia de caracteres
links	Informações sobre links e sys_ids associados ao conjunto de atualizações. Tipo de dados: Objeto "links": { "progress": {Object} }
links.progress	Informações de andamento sobre a operação realizada no conjunto de atualizações. 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) . Tipo de dados: Cadeia de caracteres
links.progress.url	URL a ser usada para recuperar os detalhes do andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Cadeia de caracteres
status	Número que representa o estado de execução da ação executada no conjunto de atualizações. Corresponde ao status_labeldescritor. Valores possíveis: 0: Pendente 1: Em execução 2: Bem-sucedido 3: Falha 4: Cancelado Tipo de dados: Cadeia de caracteres
status_detail	Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detailed_message na tabela Rastreador de execução [sys_execution_tracker]. Tipo de dados: Cadeia de caracteres
status_label	Status de execução da ação do conjunto de atualizações. Corresponde ao statusnúmero. Valores possíveis: Cancelado Reprovado Pendente(s) Em execução Bem-sucedido Tipo de dados: Cadeia de caracteres
status_message	Informações adicionais sobre o motivo da falha da operação. Retorna uma cadeia de caracteres vazia 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": ""
  }
}

/Sn_cid/plug-in//activate

Ativa o plug-in especificado.

Formato de URL

URL com controle de versão: /api/sn_cid//plug-in//activate

URL padrão: /api/sn_cicd/plug-in//activate

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

Parâmetros de solicitação compatíveis

Tabela 85. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente 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 esse identificador na página Plug-ins no cartão do plug-in desejado; identificado com o nome "ID". Tipo de dados: Cadeia de caracteres

Tabela 86. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 87. Solicitar parâmetros do corpo (XML ou JSON)

Nome	Descrição
Nenhum(a)

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 .

Tabela 88. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 89. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 90. Códigos de status

Código do 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.

Parâmetros do corpo da resposta (JSON ou XML)

Nome	Descrição
erro	Mensagem de erro com detalhes sobre o erro. Tipo de dados: Cadeia de caracteres
links	Informações sobre links e sys_ids associados ao conjunto de atualizações. Tipo de dados: Objeto "links": { "progress": {Object} }
links.progress	Informações de andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Objeto "progress": { "id": "String", "url": "String" }
links.progress.id	Sys_id que contém detalhes do andamento da operação. Você pode usar este valor ao chamar o endpoint IC/cd - OBTER /sn_cicd/progress/. Tipo de dados: Cadeia de caracteres
links.progress.url	URL a ser usada para recuperar os detalhes do andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Cadeia de caracteres
resultados.links	ID e URL dos resultados da execução. Tipo de dados: Objeto "results": { "id": "String", "url": "String" }
links.results.id	Sys_id das informações de resultados. Use este valor ao chamar o endpoint de resultados associado. Tipo de dados: Cadeia de caracteres
links.results.url	URL a ser usada para obter os resultados da execução do endpoint. Tipo de dados: Cadeia de caracteres
percent_complete	Porcentagem da solicitação concluída. Tipo de dados: Número
status	Número que representa o estado de execução da ação executada no conjunto de atualizações. Corresponde ao status_labeldescritor. Valores possíveis: 0: Pendente 1: Em execução 2: Bem-sucedido 3: Falha 4: Cancelado Tipo de dados: Cadeia de caracteres
status_detail	Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detailed_message na tabela Rastreador de execução [sys_execution_tracker]. Tipo de dados: Cadeia de caracteres
status_label	Status de execução da ação do conjunto de atualizações. Corresponde ao statusnúmero. Valores possíveis: Cancelado Reprovado Pendente(s) Em execução Bem-sucedido Tipo de dados: Cadeia de caracteres
status_message	Descrição adicional do estado atual da ação, se disponível. 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/plug-in//rollback

Reverte o plug-in especificado para a versão instalada anterior. Se nenhuma versão anterior tiver sido instalada, retornará um erro.

Formato de URL

URL com controle de versão: /api/sn_cid/

URL padrão: /api/sn_cicd/plug-in//rollback

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

Parâmetros de solicitação compatíveis

Tabela 91. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente 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 esse identificador na página Plug-ins no cartão do plug-in desejado; identificado com o nome "ID". Tipo de dados: Cadeia de caracteres

Tabela 92. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 93. Solicitar parâmetros do corpo (XML ou JSON)

Nome	Descrição
Nenhum(a)

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 .

Tabela 94. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 95. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 96. Códigos de status

Código do 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.

Parâmetros do corpo da resposta (JSON ou XML)

Nome	Descrição
erro	Mensagem de erro com detalhes sobre o erro. Tipo de dados: Cadeia de caracteres
links	Informações sobre links e sys_ids associados ao conjunto de atualizações. Tipo de dados: Objeto "links": { "progress": {Object} }
links.progress	Informações de andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Objeto "progress": { "id": "String", "url": "String" }
links.progress.id	Sys_id que contém detalhes do andamento da operação. Você pode usar este valor ao chamar o endpoint IC/cd - OBTER /sn_cicd/progress/. Tipo de dados: Cadeia de caracteres
links.progress.url	URL a ser usada para recuperar os detalhes do andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Cadeia de caracteres
percent_complete	Porcentagem da solicitação concluída. Tipo de dados: Número
status	Número que representa o estado de execução da ação executada no conjunto de atualizações. Corresponde ao status_labeldescritor. Valores possíveis: 0: Pendente 1: Em execução 2: Bem-sucedido 3: Falha 4: Cancelado Tipo de dados: Cadeia de caracteres
status_detail	Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detailed_message na tabela Rastreador de execução [sys_execution_tracker]. Tipo de dados: Cadeia de caracteres
status_label	Status de execução da ação do conjunto de atualizações. Corresponde ao statusnúmero. Valores possíveis: Cancelado Reprovado Pendente(s) Em execução Bem-sucedido Tipo de dados: Cadeia de caracteres
status_message	Descrição adicional do estado atual da ação, se disponível. 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
  }
}

POST /sn_cicd/sc/apply_changes

Começa a aplicar mudanças de um controle de código-fonte remoto a uma aplicação local especificada ou personalização de aplicação.

Formato de URL

URL com controle de versão: /api/sn_cid//sc/apply_changes

URL padrão: /api/sn_cicd/sc/apply_changes

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

Parâmetros de solicitação compatíveis

Tabela 97. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres

Tabela 98. Parâmetros de consulta

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 de base que está instalada atualmente na instância local. Sinalizador que indica se o sistema deve fazer upgrade automático da aplicação de base para uma versão posterior. Tipo de dados: Booliano Padrão: verdadeiro
branch_name	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	Necessário se sys_idnão foi 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 em scopeCampo na tabela Aplicação personalizada [sys_app] ou Aplicação da loja [sys_store_app] para a personalização da aplicação. Tipo de dados: Cadeia de caracteres
sys_id	Necessário se scopenão foi especificado. O sys_id da aplicação para a qual as mudanças serão aplicadas. Você pode localizar este valor em Sys IDCampo na tabela Aplicação personalizada [sys_app] ou Aplicação da loja [sys_store_app] para a personalização da aplicação. Tipo de dados: Cadeia de caracteres

Tabela 99. Solicitar parâmetros do corpo (XML ou JSON)

Nome	Descrição
Nenhum(a)

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 .

Tabela 100. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 101. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 102. Códigos de status

Código do 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.

Parâmetros do corpo da resposta (JSON ou XML)

Nome	Descrição
erro	Mensagem de erro com detalhes sobre o erro. Tipo de dados: Cadeia de caracteres
links	Informações sobre links e sys_ids associados ao conjunto de atualizações. Tipo de dados: Objeto "links": { "progress": {Object} }
links.progress	Informações de andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Objeto "progress": { "id": "String", "url": "String" }
links.progress.id	Sys_id que contém detalhes do andamento da operação. Você pode usar este valor ao chamar o endpoint IC/cd - OBTER /sn_cicd/progress/. Tipo de dados: Cadeia de caracteres
links.progress.url	URL a ser usada para recuperar os detalhes do andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Cadeia de caracteres
percent_complete	Porcentagem da solicitação concluída. Tipo de dados: Número
status	Número que representa o estado de execução da ação executada no conjunto de atualizações. Corresponde ao status_labeldescritor. Valores possíveis: 0: Pendente 1: Em execução 2: Bem-sucedido 3: Falha 4: Cancelado Tipo de dados: Cadeia de caracteres
status_detail	Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detailed_message na tabela Rastreador de execução [sys_execution_tracker]. Tipo de dados: Cadeia de caracteres
status_label	Status de execução da ação do conjunto de atualizações. Corresponde ao statusnúmero. Valores possíveis: Cancelado Reprovado Pendente(s) Em execução Bem-sucedido Tipo de dados: Cadeia de caracteres
status_message	Informações adicionais sobre o motivo da falha da operação. Retorna uma cadeia de caracteres vazia 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
  }
}

/Sn_cicd/sc/apply_stash/

Começa a aplicar um "stash" gerado anteriormente de mudanças de um controle de código-fonte remoto a uma aplicação local especificada ou personalização de aplicação.

Este endpoint funciona em conjunto com POST/api/sn_cicd/sc/apply_changes e. IC/cd - OBTER /sn_cicd/progress/ endpoints. . PUBLICAR /api/sn_cicd/sc/apply_changes o endpoint é chamado, todas as mudanças não salvas ou não confirmadas em App Engine Studio na instância associada são salvos no banco de dados como stash .

A maneira de determinar se um stash foi criado quando as mudanças foram aplicadas inicialmente é chamar OBTENHA /sn_cicd/progress/progress_id endpoint. Se um stash foi criado, o sys_id ( stash_idE o URL do stash são retornados. Para aplicar as mudanças armazenadas à aplicação associada, chame esta opção apply_stash endpoint usando stash_idretornado por andamento endpoint.

Formato de URL

URL com controle de versão: /api/sn_cid//sc/apply_stash/

URL padrão: /api/sn_cicd/sc/apply_stash/

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

Parâmetros de solicitação compatíveis

Tabela 103. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente 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 em links.stash.idparâmetro no correspondente IC/cd - OBTER /sn_cicd/progress/ chamada de endpoint. Tipo de dados: Cadeia de caracteres

Tabela 104. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 105. Solicitar parâmetros do corpo (XML ou JSON)

Nome	Descrição
Nenhum(a)

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 .

Tabela 106. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json
Tipo de conteúdo	Formato de dados do corpo da solicitação. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 107. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 108. Códigos de status

Código do 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.

Parâmetros do corpo da resposta (JSON ou XML)

Nome	Descrição
erro	Mensagem de erro com detalhes sobre o erro. Tipo de dados: Cadeia de caracteres
links	Informações sobre links e sys_ids associados ao conjunto de atualizações. Tipo de dados: Objeto "links": { "progress": {Object} }
links.progress	Informações de andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Objeto "progress": { "id": "String", "url": "String" }
links.progress.id	Sys_id que contém detalhes do andamento da operação. Você pode usar este valor ao chamar o endpoint IC/cd - OBTER /sn_cicd/progress/. Tipo de dados: Cadeia de caracteres
links.progress.url	URL a ser usada para recuperar os detalhes do andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Cadeia de caracteres
percent_complete	Porcentagem da solicitação concluída. Tipo de dados: Número
status	Número que representa o estado de execução da ação executada no conjunto de atualizações. Corresponde ao status_labeldescritor. Valores possíveis: 0: Pendente 1: Em execução 2: Bem-sucedido 3: Falha 4: Cancelado Tipo de dados: Cadeia de caracteres
status_detail	Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detailed_message na tabela Rastreador de execução [sys_execution_tracker]. Tipo de dados: Cadeia de caracteres
status_label	Status de execução da ação do conjunto de atualizações. Corresponde ao statusnúmero. Valores possíveis: Cancelado Reprovado Pendente(s) Em execução Bem-sucedido Tipo de dados: Cadeia de caracteres
status_message	Descrição adicional do estado atual da ação, se disponível. Tipo de dados: Cadeia de caracteres

Solicitação de curl

O exemplo de código a seguir mostra como chamar apply_stash endpoint para stash_idfc2224e4e0429110f8771827f8fd3634.

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

POST /sn_cicd/sc/import

Importa uma aplicação usando o URL do repositório especificado e o nome da ramificação.

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

URL com controle de versão: /api/sn_cid//sc/import

URL padrão: /api/sn_cicd/sc/import

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

Parâmetros de solicitação compatíveis

Tabela 109. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres

Tabela 110. Parâmetros de consulta

Nome	Descrição
auto_upgrade_base_app	Aplicável somente quando a aplicação que está sendo importada é uma personalização de app e a confirmação mais recente no repositório Git é criada em uma versão posterior à da aplicação de base que está instalada atualmente na instância local. Sinalizador que indica se o sistema deve fazer upgrade automático da aplicação de base para uma versão posterior. Valores válidos: Verdadeiro: Upgrade automático da aplicação de base. Falso: Não faça upgrade automático da aplicação de base. Tipo de dados: Booliano Padrão: Verdadeiro
branch_name	Obrigatório. Nome da ramificação no sistema de controle de código-fonte do qual importar a aplicação. 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 de repo_urlum parâmetro é 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 desta aplicação. Tipo de dados: Cadeia de caracteres Cadeia de caracteres vazia/NULL
repo_url	Obrigatório. URL do repositório Git do qual importar a aplicação. Tipo de dados: Cadeia de caracteres

Tabela 111. Solicitar parâmetros do corpo (XML ou JSON)

Nome	Descrição
Nenhum(a)

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 .

Tabela 112. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 113. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 114. Códigos de status

Código do 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.

Parâmetros do corpo da resposta (JSON ou XML)

Nome	Descrição
erro	Mensagem de erro com detalhes sobre o erro. Tipo de dados: Cadeia de caracteres
links	Informações sobre links e sys_ids associados ao conjunto de atualizações. Tipo de dados: Objeto "links": { "progress": {Object} }
links.progress	Informações de andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Objeto "progress": { "id": "String", "url": "String" }
links.progress.id	Sys_id que contém detalhes do andamento da operação. Você pode usar este valor ao chamar o endpoint IC/cd - OBTER /sn_cicd/progress/. Tipo de dados: Cadeia de caracteres
links.progress.url	URL a ser usada para recuperar os detalhes do andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Cadeia de caracteres
percent_complete	Porcentagem da solicitação concluída. Tipo de dados: Número
status	Número que representa o estado de execução da ação executada no conjunto de atualizações. Corresponde ao status_labeldescritor. Valores possíveis: 0: Pendente 1: Em execução 2: Bem-sucedido 3: Falha 4: Cancelado Tipo de dados: Cadeia de caracteres
status_detail	Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detailed_message na tabela Rastreador de execução [sys_execution_tracker]. Tipo de dados: Cadeia de caracteres
status_label	Status de execução da ação do conjunto de atualizações. Corresponde ao statusnúmero. Valores possíveis: Cancelado Reprovado Pendente(s) Em execução Bem-sucedido Tipo de dados: Cadeia de caracteres
status_message	Descrição adicional do estado atual da ação, se disponível. 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
  }
}

POST /sn_cicd/testsuite/run

Inicia um pacote de testes automatizado especificado. O pacote de testes é executado na instância a partir da qual o endpoint foi chamado.

Nota:

Se o pacote que você está executando contiver testes de IU, você deverá ter um executor de testes de cliente agendado aberto ou ser capaz de configurar a execução do executor de testes sem interface. Para saber mais, consulte Navegador autônomo para Automated Test Framework .

Formato de URL

URL com controle de versão: /api/sn_cid//testsuite/run

URL padrão: /api/sn_cicd/testsuite/run

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

Parâmetros de solicitação compatíveis

Tabela 115. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres

Tabela 116. Parâmetros de consulta

Nome	Descrição
browser_name	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 de cliente agendados, consulte Executores de testes de cliente agendados . Tipo de dados: Cadeia de caracteres Valores válidos: (Devem ser todos minúsculos) qualquer chrome firefox borda ou seja safari Padrão: Qualquer
browser_version	Valor inicial da versão do navegador especificado em browser_namepara usar para executar o teste. Por exemplo, se você inserir "9", todas as versões 9.x.x.x.x. Este valor deve corresponder ao especificado no executor de teste do cliente programado. Tipo de dados: Cadeia de caracteres
is_performance_run	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. Padrão: falso
os_name	Nome do sistema operacional no qual executar o pacote de testes. 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 na qual executar o pacote de testes. Por exemplo, se você inserir "8", todas as versões 8.x.x.x.x. Este valor deve corresponder ao especificado no executor de teste do cliente programado. Tipo de dados: Cadeia de caracteres
run_in_cloud	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 testes manual. Padrão: falso
test_suite_sys_id	Necessário se test_suite_namenão foi especificado. O sys_id do pacote de testes a ser executado. Tipo de dados: Cadeia de caracteres Tabela: Teste [sys_atf_test_suite]
test_suite_name	Necessário se test_suite_sys_idnão foi especificado. O nome do pacote de testes a ser executado. Tipo de dados: Cadeia de caracteres Tabela: Teste [sys_atf_test_suite]

Tabela 117. Solicitar parâmetros do corpo (XML ou JSON)

Nome	Descrição
Nenhum(a)

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 .

Tabela 118. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 119. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 120. Códigos de status

Código do 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.

Parâmetros do corpo da resposta (JSON ou XML)

Nome	Descrição
erro	Mensagem de erro com detalhes sobre o erro. Tipo de dados: Cadeia de caracteres
links	Informações sobre links e sys_ids associados ao conjunto de atualizações. Tipo de dados: Objeto "links": { "progress": {Object} }
links.progress	Informações de andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Objeto "progress": { "id": "String", "url": "String" }
links.progress.id	Sys_id que contém detalhes do andamento da operação. Você pode usar este valor ao chamar o endpoint IC/cd - OBTER /sn_cicd/progress/. Tipo de dados: Cadeia de caracteres
links.progress.url	URL a ser usada para recuperar os detalhes do andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: Cadeia de caracteres
resultados.links	ID e URL dos resultados da execução. Tipo de dados: Objeto "results": { "id": "String", "url": "String" }
links.results.id	Sys_id das informações de resultados. Use este valor ao chamar o endpoint de resultados associado. Tipo de dados: Cadeia de caracteres
links.results.url	URL a ser usada para obter os resultados da execução do endpoint. Tipo de dados: Cadeia de caracteres
percent_complete	Porcentagem da solicitação concluída. Tipo de dados: Número
status	Número que representa o estado de execução da ação executada no conjunto de atualizações. Corresponde ao status_labeldescritor. Valores possíveis: 0: Pendente 1: Em execução 2: Bem-sucedido 3: Falha 4: Cancelado Tipo de dados: Cadeia de caracteres
status_detail	Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detailed_message na tabela Rastreador de execução [sys_execution_tracker]. Tipo de dados: Cadeia de caracteres
status_label	Status de execução da ação do conjunto de atualizações. Corresponde ao statusnúmero. Valores possíveis: Cancelado Reprovado Pendente(s) Em execução Bem-sucedido Tipo de dados: Cadeia de caracteres
status_message	Descrição adicional do estado atual da ação, se disponível. 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"
  }
}