Integração e entrega contínuas (CICD) API do conjunto de atualizações
A API CICD Update Set fornece métodos para criar, recuperar, visualizar, confirmar e reverter um conjunto de atualizações.
Esta API está associada às ações que você pode executar em conjuntos de atualizações do sistema e requer a função sn_cicd.sys_ci_automation e o plug-in REST API de integração e entrega contínuas (CICD) (com.glide.continualdelivery) para acessá-la.
Conjunto de atualizações CICD - POST /api/sn_cicd/update_set/retrieve
Recupera um conjunto de atualizações com um determinado sys_id e permite que você remova o conjunto de atualizações recuperado existente da instância.
Formato da URL
URL com controle de versão: /api/sn_cicd/{api_version}/update_set/retrieve
URL padrão: /api/sn_cicd/update_set/retrieve
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| update_set_id | Obrigatório. Sys_id do conjunto de atualizações na instância de origem de onde o conjunto de atualizações foi recuperado. Tabela: conjuntos de atualizações [sys_update_set] Tipo de dados: cadeia de caracteres |
| update_source_id | Sys_id do registro de instância remota. Tabela: instâncias remotas [sys_update_set_source] Tipo de dados: cadeia de caracteres |
| update_source_instance_id | ID da instância remota. Tabela: instâncias remotas [sys_update_set_source] Tipo de dados: cadeia de caracteres |
| auto_preview | Sinalizador que indica se o conjunto de atualizações deve ser visualizado automaticamente após a recuperação. Valores válidos:
Tipo de dados: booliano Padrão: falso |
| limpeza_recuperada | Sinalizador que indica se o conjunto de atualizações recuperado existente deve ser removido da instância. Valores válidos:
Tipo de dados: booliano Padrão: falso |
| 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.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 403 | Proibido. O usuário não tem direitos de acesso ao registro especificado. |
| 404 | Não encontrado. O item solicitado não foi encontrado. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
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 | Informações de andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: objeto |
| 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 - GET /sn_cicd/progress/{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 |
| percent_complete | Porcentagem da solicitação que está concluída. Tipo de dados: número |
| status | Número que representa o estado de execução da ação realizada no conjunto de atualizações. Corresponde ao descritor status_label. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| status_detail | Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detalhado_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 número status. Valores possíveis:
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 recupera um conjunto de atualizações específico com um determinado sys_id e ID de instância.
curl
"https://instance.servicenow.com/api/sn_cicd/update_set/retrieve?update_set_id=2ce715950d619e10f87785462179bd67&update_source_id=e66613a49d011210f877036c70ae59f7" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'
Corpo da resposta. Mostra detalhes sobre o status atual do conjunto de atualizações e o andamento da execução.
{
"result": {
"links": {
"progress": {
"id": "e2ea3eedc92dde10f877184664aecd90",
"url": "https://instance.servicenow.com/api/sn_cicd/progress/e2ea3eedc92dde10f877184664aecd90"
}
},
"status": "0",
"status_label": "Pending",
"status_message": "",
"status_detail": "",
"error": "",
"percent_complete": 0
}
}
Conjunto de atualizações CICD - POST /api/sn_cicd/update_set/commitMultiple
Confirma vários conjuntos de atualizações em uma única solicitação de acordo com a ordem em que são fornecidos.
Formato da URL
URL com controle de versão: /api/sn_cicd/{api_version}/update_set/commitMutiple
URL padrão: /api/sn_cicd/update_set/commitMutiple
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| remote_update_set_ids | Obrigatório. Lista de sys_ids associados a quaisquer conjuntos de atualizações a serem confirmados. Sys_ids são confirmados na ordem fornecida na solicitação. Nota: Você pode usar o endpoint IC/CD - GET /sn_cicd/progress/{progress_id} para obter o ID do conjunto de atualizações remoto. Tipo de dados: cadeia de caracteres Tabela: conjuntos de atualizações recuperados [sys_remote_update_set] |
| Nome | Descrição |
|---|---|
| force_commit | Sinalizador que indica se a confirmação do conjunto de atualizações deve ser forçada. Este recurso é útil quando alguns conjuntos de atualizações remotos especificados na entrada já foram confirmados em uma operação anterior. Esse recurso também garante que a ordem de confirmação seja obedecida na ordem em que os conjuntos de atualizações são fornecidos. Valores válidos:
Tipo de dados: cadeia de caracteres Padrão: falso |
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.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Tipo de conteúdo | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
Códigos de status
| Nome | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 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. |
| 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 | Informações de andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: objeto |
| 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 - GET /sn_cicd/progress/{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 |
| percent_complete | Porcentagem da solicitação que está concluída. Tipo de dados: número |
| status | Número que representa o estado de execução da ação realizada no conjunto de atualizações. Corresponde ao descritor status_label. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| status_detail | Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detalhado_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 número status. Valores possíveis:
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 confirmar uma atualização com um determinado sys_id.
curl
"https://instance.servicenow.com/api/sn_cicd/update_set/commitMultiple?remote_update_set_ids=0a9f45ab9d415e10f877036c70ae5968%2Cc2e89999c9e19e10f877184664aecd40" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"force_commit\":\"true\"}" \
--user 'username':'password'
Corpo da resposta.
{
"result": {
"links": {
"progress": {
"id": "3d174aa1c969de10f877184664aecdc0",
"url": "https://instance.servicenow.com/api/sn_cicd/progress/3d174aa1c969de10f877184664aecdc0"
}
},
"status": "0",
"status_label": "Pending",
"status_message": "",
"status_detail": "",
"error": "",
"percent_complete": 0
}
}Conjunto de atualizações CICD - POST /api/sn_cicd/update_set/preview/{remote_update_set_id}
Exibe um conjunto de atualizações para verificar se há conflitos e recuperar informações de andamento sobre a operação de conjunto de atualizações.
Formato da URL
URL com controle de versão: /api/sn_cicd/{api_version}/update_set/preview/{remote_update_set_id}
URL padrão: /api/sn_cicd/update_set/preview/{remote_update_set_id}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| remote_update_set_id | Sys_id do conjunto de atualizações a ser visualizado. Tabela: conjuntos de atualizações recuperados [sys_remote_update_set] Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| 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.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Tipo de conteúdo | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 403 | Proibido. O usuário não tem direitos de acesso ao registro especificado. |
| 404 | Não encontrado. O item solicitado não foi encontrado. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
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 | Informações de andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: objeto |
| 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 - GET /sn_cicd/progress/{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 |
| percent_complete | Porcentagem da solicitação que está concluída. Tipo de dados: número |
| status | Número que representa o estado de execução da ação realizada no conjunto de atualizações. Corresponde ao descritor status_label. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| status_detail | Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detalhado_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 número status. Valores possíveis:
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 visualizar um conjunto de atualizações remoto usando um determinado ID.
curl
curl "https://instance.servicenow.com/api/sn_cicd/update_set/preview/8f4608d39d89da10f877036c70ae5998" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'Corpo da resposta.
{
"result": {
"links": {
"progress": {
"id": "54e9c665c969de10f877184664aecd72",
"url": "https://instance.servicenow.com/api/sn_cicd/progress/54e9c665c969de10f877184664aecd72"
}
},
"status": "0",
"status_label": "Pending",
"status_message": "",
"status_detail": "",
"error": "",
"percent_complete": 0
}
}Conjunto de atualizações CICD - POST /api/sn_cicd/update_set/back_out
Reverte uma operação de instalação que foi realizada em um conjunto de atualizações com um determinado sys_id.
Para obter mais informações sobre como a operação de reversão afeta um conjunto de atualizações, consulte Back out an update set.
Formato da URL
URL com controle de versões: /api/sn_cicd/{api_version}/update_set/back_out
URL padrão: /api/sn_cicd/update_set/back_out
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| rollback_installs | Sinalizador que indica se a instalação em lote realizada durante a confirmação do conjunto de atualizações deve ser revertida. Valores possíveis:
Tipo de dados: booliano Padrão: verdadeiro |
| update_set_id | Obrigatório. Sys_id do conjunto de atualizações. Tabela: conjuntos de atualizações [sys_update_set] Tipo de dados: cadeia de caracteres |
| 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.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 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 | Informações sobre links e sys_ids associados ao conjunto de atualizações. Tipo de dados: objeto |
| links.progress | Informações de andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: objeto |
| 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 - GET /sn_cicd/progress/{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 |
| percent_complete | Porcentagem da solicitação que está concluída. Tipo de dados: número |
| status | Número que representa o estado de execução da ação realizada no conjunto de atualizações. Corresponde ao descritor status_label. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| status_detail | Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detalhado_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 número status. Valores possíveis:
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 reverter uma operação de instalação em um sys_id de atualização específico.
curl
"https://instance.servicenow.com/api/sn_cicd/update_set/back_out?update_set_id=73dd24e39dcd1e10f877036c70ae59ae&rollback_installs=false" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'Resposta:
{
"result": {
"links": {
"progress": {
"id": "036bf811c9619e10f877184664aecdcb",
"url": "https://instance.servicenow.com/api/sn_cicd/progress/036bf811c9619e10f877184664aecdcb"
}
},
"status": "0",
"status_label": "Pending",
"status_message": "",
"status_detail": "",
"error": "",
"percent_complete": 0
}
} Conjunto de atualizações CICD - POST /api/sn_cicd/update_set/commit/{remote_update_set_id}
Confirma um conjunto de atualizações com um determinado sys_id.
Depois de visualizar um conjunto de atualizações e resolver todos os problemas, você pode confirmar o conjunto de atualizações usando este endpoint. A confirmação de um conjunto de atualizações aplica todas as mudanças à instância e cria uma cópia local do conjunto de atualizações que contém um registro de atualização para cada mudança. Para obter mais informações sobre como confirmar um conjunto de atualizações, consulte Commit an update set.
Formato da URL
URL com controle de versões: /api/sn_cicd/{api_version}/update_set/commit/{remote_update_set_id}
URL padrão: /api/sn_cicd/update_set/ confirmação/{remote_update_set_id}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| remote_update_set_id | Sys_id do conjunto de atualizações a ser confirmado. Nota: Você pode usar o endpoint IC/CD - GET /sn_cicd/progress/{progress_id} para obter o ID do conjunto de atualizações remoto. Tabela: conjuntos de atualizações recuperados [sys_remote_update_set] Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| force_commit | Sinalizador que indica se a confirmação do conjunto de atualizações deve ser forçada. Valores válidos:
Tipo de dados: cadeia de caracteres Padrão: falso |
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.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Tipo de conteúdo | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Nome | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | As credenciais do usuário estão incorretas. |
| 403 | Proibido. O usuário não tem direitos de acesso ao registro especificado. |
| 404 | Não encontrado. O item solicitado não foi encontrado. |
| 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 | Informações de andamento sobre a operação realizada no conjunto de atualizações. Tipo de dados: objeto |
| 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 - GET /sn_cicd/progress/{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 |
| percent_complete | Porcentagem da solicitação que está concluída. Tipo de dados: número |
| status | Número que representa o estado de execução da ação realizada no conjunto de atualizações. Corresponde ao descritor status_label. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| status_detail | Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detalhado_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 número status. Valores possíveis:
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 confirma o conjunto de atualizações com o sys_id associado.
curl
"https://instance.servicenow.com/api/sn_cicd/update_set/commit/4ee89999c9e19e10f877184664aecd42" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'Corpo da resposta.
{
"result": {
"links": {
"progress": {
"id": "bf380a11c9e59e10f877184664aecd0e",
"url": "https://instance.servicenow.com/api/sn_cicd/progress/bf380a11c9e59e10f877184664aecd0e"
}
},
"status": "0",
"status_label": "Pending",
"status_message": "",
"status_detail": "",
"error": "",
"percent_complete": 0
}
}Conjunto de atualizações CICD - POST /api/sn_cicd/update_set/create
Cria um novo conjunto de atualizações e insere o novo registro na tabela Conjuntos de atualizações [sys_update_set].
Formato da URL
URL com controle de versão: /api/sn_cicd/{api_version}/update_set/create
URL padrão: /api/sn_cicd/update_set/create
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| descrição | Descrição do conjunto de atualizações. Tipo de dados: cadeia de caracteres Padrão: nulo |
| scope | Obrigatório se o parâmetro sys_id não for passado. O nome do escopo da aplicação na qual o novo conjunto de atualizações será criado. Tabela: Aplicações [sys_scope] Tipo de dados: cadeia de caracteres |
| sys_id | Obrigatório se o parâmetro scope não for passado. Sys_id da aplicação na qual o novo conjunto de atualizações será criado. Tabela: Aplicações [sys_scope] Tipo de dados: cadeia de caracteres |
| update_set_name | Obrigatório. Nome a ser fornecido ao conjunto de atualizações. Tipo de dados: cadeia de caracteres |
| 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.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Tipo de conteúdo | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| 201 | O conjunto de atualizações foi criado com sucesso. |
| 400 | Solicitação incorreta. O nome do conjunto de atualizações é nulo ou vazio, ou a entrada sys_id e o escopo são nulos ou vazios. |
| 403 | Proibido. O usuário não é um administrador ou não tem a função sn_cicd.sys_ci_automation. |
| 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 |
| status | Número que representa o estado de execução da ação realizada no conjunto de atualizações. Corresponde ao descritor status_label. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| status_detail | Mensagem detalhada sobre o status da execução, se disponível. Corresponde ao campo detalhado_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 número status. Valores possíveis:
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 |
| update_set_id | Sys_id do conjunto de atualizações criado. Tabela: conjuntos de atualizações [sys_update_set] Tipo de dados: cadeia de caracteres |
Solicitação de cURL
O exemplo a seguir demonstra como criar um novo conjunto de atualizações com o nome Testupdateset e o escopo definido como sn_test.
curl
"https://instance.servicenow.com/api/sn_cicd/update_set/create?update_set_name=Testupdateset&scope=sn_test" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'Corpo da resposta.
{
"result": {
"status": "2",
"status_label": "",
"status_message": "Successfully created update set: Test update set 1",
"status_detail": "",
"error": "",
"update_set_id": "a9a485d1c9a19e10f877184664aecd11"
}
}