---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference
Release :
- xanadu
ft:locale :
- pt-BR
ft:publication_title :
- Referência de API do Xanadu
ft:clusterId :
- crapiref
bundleId :
- crapiref
workflow :
- Creator
---
# APICdmChangesets
# APICdmChangesets {#ariaid-title1}
* Versão de lançamento: Xanadu
*
* Atualizado 1 de ago. de 2024
*
*  37 min. de leitura
A CdmChangesetsApi fornece endpoints que permitem gerenciar conjuntos de mudanças.
Usando esses endpoints, você pode:
* Crie novos conjuntos de mudanças.
* Implantar conjuntos de mudanças.
* Recupere listas de ou conjuntos de mudanças individuais.
* Recupera as mudanças de nó em um changeset.
* Recupere uma lista de aplicações ou implantáveis que são afetados por um changeset.
* Excluir conjuntos de mudanças.
* Retornar uma lista de componentes compartilhados que estão associados a um changeset especificado.
Os endpoints de criação de conjuntos de mudanças usam uma implementação de enfileiramento assíncrona. Com este tipo de implementação, você primeiro chama o endpoint de solicitação de criação de conjunto de mudanças. Este endpoint enfileira sua solicitação e retorna um identificador de confirmação. Em seguida, você usa este identificador de confirmação para chamar o endpoint de status apropriado para obter o status da solicitação de criação.
Você deve ter uma das seguintes funções para acessar esta API:
* ACL de exibição do CDM REST de script (sn_cdm.cdm.viewer)
* ACL do Editor do CDM de REST de script (sn_cdm.cdm_editor)
Além disso, o plug-in Gestão de dados de configuração (CDM) deve ser ativado para que esta API esteja disponível em uma instância.
Para obter informações adicionais sobre conjuntos de mudanças, consulte [Changesets e controle de versão no CDM](https://www.servicenow.com/docs/access?context=cdm-changesets-version-control&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US).
## CdmChangesetsApi - DELETE /sn_cdm/changesets {#ariaid-title2}
Exclui um changeset especificado.
O solicitante deve ter a função de Editor do CDM para acessar este endpoint.
### Formato da URL
URL com controle de versão: /api/sn_cdm/{api_version}/changesets
URL padrão: /api/sn_cdm/changesets
### Parâmetros de solicitação compatíveis
{#chngsets-DELETE-chgnsets__entry__2}{#chngsets-DELETE-chgnsets__version-RESTAPI}
| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
[Tabela 1. Parâmetros de caminho]
{#chngsets-DELETE-chgnsets__entry__6}{#chngsets-DELETE-chgnsets__changesetNumber-changeset-entry}
| Nome | Descrição |
|-|-|
| changesetNumber | Obrigatório. Identificador exclusivo do changeset associado, como "Chset-10". Localizado na tabela CDMChangeset \[sn_cdm_changeset\]. Tipo de dados: cadeia de caracteres |
[Tabela 2. Parâmetros de consulta]
{#chngsets-DELETE-chgnsets__entry__10}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 3. Parâmetros do corpo da solicitação]
### Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#chngsets-DELETE-chgnsets__entry__14}{#chngsets-DELETE-chgnsets__accept-JSON-only-entry-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
[Tabela 4. Cabeçalhos da solicitação]
{#chngsets-DELETE-chgnsets__entry__18}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 5. Cabeçalhos de resposta]
### Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#chngsets-DELETE-chgnsets__entry__22}{#chngsets-DELETE-chgnsets__entry-200-status-code}{#chngsets-DELETE-chgnsets__entry-400-status-code}{#chngsets-DELETE-chgnsets__entry-500-status-code}
| Código de 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. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 6. Códigos de status]
### Parâmetros do corpo da resposta
{#chngsets-DELETE-chgnsets__entry__30}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[ ]
### Solicitação de cURL
O exemplo de código a seguir mostra como remover um changeset.
curl "http://instance.servicenow.com/api/sn_cdm/changesets?changesetNumber=Chset-760" \
--request DELETE \
--header "Accept:application/json" \
--user 'username':'password'
Para uma exclusão bem-sucedida do changeset, nenhuma resposta é retornada além do código de status HTTP.
None - results defined by the HTTP status code
## CdmChangesetsApi - GET /sn_cdm/changesets {#ariaid-title3}
Recupera todos os conjuntos de mudanças associados a uma aplicação Gestão de dados de configuração (CDM) ou a um registro de conjunto de mudanças especificado.
### Formato da URL
URL com controle de versão: /api/sn_cdm/{api_version}/changesets
URL padrão: /api/sn_cdm/changesets
### Parâmetros de solicitação compatíveis
{#chngsets-GET-changesets__entry__2}{#chngsets-GET-changesets__version-RESTAPI}
| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
[Tabela 7. Parâmetros de caminho]
{#chngsets-GET-changesets__entry__6}
| Nome | Descrição |
|-|-|
| appName | Obrigatório. Nome da aplicação de CDM cujos conjuntos de mudanças você deseja retornar. Esta deve ser uma aplicação ativa. Localizado na tabela Aplicação de CDM \[sn_cdm_application\]. Tipo de dados: cadeia de caracteres |
| número | Número do changeset. Localizado na tabela CDMChangeset \[sn_cdm_changeset\]. Se você passar este valor, somente o changeset especificado será retornado. Deve ser um changeset associado à aplicação CDM especificada no parâmetro appName. Tipo de dados: cadeia de caracteres Padrão: nenhum - retorna todos os conjuntos de mudanças associados à aplicação CDM ou aqueles especificados pelo parâmetro state. |
| estado | Estado dos conjuntos de mudanças a serem retornados. Retorna somente os conjuntos de mudanças associados à aplicação de CDM especificada para o estado especificado. Valores válidos: * Bloqueado * Verificando possíveis conflitos * Falha na confirmação * Confirmação em andamento * Confirmado * Aberto Tipo de dados: cadeia de caracteres Padrão: retornar todos os changesets para todos os estados |
[Tabela 8. Parâmetros de consulta]
{#chngsets-GET-changesets__entry__14}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 9. Parâmetros do corpo da solicitação]
### Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#chngsets-GET-changesets__entry__18}{#chngsets-GET-changesets__accept-JSON-only-entry-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
[Tabela 10. Cabeçalhos da solicitação]
{#chngsets-GET-changesets__entry__22}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 11. Cabeçalhos de resposta]
### Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#chngsets-GET-changesets__entry__26}{#chngsets-GET-changesets__entry-200-status-code}{#chngsets-GET-changesets__entry-400-status-code}{#chngsets-GET-changesets__entry-500-status-code}
| Código de 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. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 12. Códigos de status]
### Parâmetros do corpo da resposta
{#chngsets-GET-changesets__entry__34}{#chngsets-GET-changesets__cdm_apps-autoValidate-row}{#chngsets-GET-changesets__committed_at-changeset-entry}{#chngsets-GET-changesets__sys_created_by-changeset-entry}{#chngsets-GET-changesets__sys_created_on-changeset-entry}{#chngsets-GET-changesets__sys_id-changeset-entry}{#chngsets-GET-changesets__sys_updated_by-changeset-entry}{#chngsets-GET-changesets__sys_updated_on-changeset-entry}
| Nome | Descrição |
|-|-|
| auto_validate | Sinalizador que indica se os conjuntos de mudanças criados na confirmação são validados. Valores válidos: * verdadeiro: valida os conjuntos de mudanças. * falso: não valida os conjuntos de mudanças. Tipo de dados: booliano |
| aplicação_cdm | Detalhes da aplicação de CDM associada ao changeset. Tipo de dados: objeto "cdm_application": { "link": "String", "value": "String" } |
| aplicação_cdm.link | Consulta a ser usada para chamar o endpoint REST de tabela para recuperar a aplicação de CDM associada. Tipo de dados: cadeia de caracteres |
| cdm_aplicação.valor | Sys_id da aplicação CDM associada. Localizado na tabela Aplicação de CDM \[sn_cdm_application\]. Tipo de dados: cadeia de caracteres |
| confirmado_em | Data e hora em que o changeset foi confirmado pela última vez. Tipo de dados: cadeia de caracteres Formato: AAAA-mm-DD hh:mm:ss |
| confirmado_por | Detalhes sobre o usuário que confirmou o changeset. Tipo de dados: objeto "committed_by": { "link": "String", "value": "String" } |
| confirmado_por.link | Chamada para obter o registro do usuário que confirmou o changeset usando a REST Table API. Tipo de dados: cadeia de caracteres |
| confirmado_por.valor | Sys_id do usuário que confirmou o changeset. Tipo de dados: cadeia de caracteres |
| descrição | Breve descrição da finalidade do changeset. Tipo de dados: cadeia de caracteres |
| erro | Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem de erro gerada ao tentar processar a solicitação. Tipo de dados: cadeia de caracteres |
| last_conflict_detection_time | Quantidade de tempo desde a última detecção de conflitos executada. A detecção de conflitos é realizada sempre que um changeset é confirmado. Tipo de dados: número Unidade: Milissegundos |
| last_updated | Data e hora em que uma mudança foi feita nos dados de configuração associados por meio deste changeset. Formato: AAAA-mm-DD hh:mm:ss Tipo de dados: cadeia de caracteres |
| número | Número exclusivo do changeset. Tipo de dados: cadeia de caracteres |
| publish_option | Opção de publicação para os snapshots configurados associados. Valores válidos: * publicar_none: não publicar nenhum snapshot. * Public_valid: publique somente os snapshots aprovados na validação após a confirmação. Para obter informações adicionais sobre como publicar snapshots, consulte [Publicar ou cancelar a publicação de um snapshot](https://www.servicenow.com/docs/access?context=cdm-snapshot-publish&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres Padrão: publicar_none |
| estado | Estado atual do changeset. Valores possíveis: * Bloqueado * Verificando possíveis conflitos * Falha na confirmação * Confirmação em andamento * Confirmado * Aberto Tipo de dados: cadeia de caracteres |
| sys_created_by | Nome de usuário do usuário que criou o changeset. Por exemplo, "able.tuter". Tipo de dados: cadeia de caracteres |
| sys_created_on | Data e hora em que o changeset foi criado. Formato: AAAA-mm-DD hh:mm:ss Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id do changeset. Localizado na tabela CDMChangeset \[sn_cdm_changeset\]. Tipo de dados: cadeia de caracteres |
| sys_updated_by | Nome de usuário do usuário que atualizou o changeset pela última vez. Por exemplo, "able.tuter". Tipo de dados: cadeia de caracteres |
| sys_updated_on | Data e hora em que o changeset foi atualizado pela última vez. Formato: AAAA-mm-DD hh:mm:ss Tipo de dados: cadeia de caracteres |
| título | Título do changeset. Tipo de dados: cadeia de caracteres |
[ ]
### Solicitação de cURL
Este exemplo de código mostra como recuperar um changeset específico.
curl "http://instance.servicenow.com/api/sn_cdm/changesets?appName=testApp&changesetNumber=Chset-946&state=committed" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Retornar resultados:
{
"result": [
{
"description": "Auto generated for deletion of CDM Deployable Dep-12022-06-29 13:09:46",
"cdm_application": {
"value": "62b517a953b70110a1d3ddeeff7b128c",
"link": "http://instance.servicenow.com/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c"
},
"sys_updated_on": "2022-06-29 13:09:47",
"title": "Auto generated for deletion of CDM Deployable Dep-12022-06-29 13:09:46",
"number": "Chset-946",
"sys_id": "955d6c0f53141110a1d3ddeeff7b1233",
"sys_updated_by": "admin",
"committed_at": "2022-06-29 13:09:46",
"sys_created_on": "2022-06-29 13:09:46",
"committed_by": {
"value": "6816f79cc0a8016401c5a33be04be441",
"link": "http://instance.servicenow.com/api/now/table/sys_user/6816f79cc0a8016401c5a33be04be441"
},
"state": "committed",
"auto_validate": true,
"publish_option": "publish_none",
"last_conflict_detection_time": "1656508187450",
"sys_created_by": "admin",
"last_updated": "2022-06-29 13:09:46"
}
]
}
## CdmChangesetsApi - GET /sn_cdm/changesets/activity {#ariaid-title4}
Recupera as mudanças de nó em um changeset especificado.
### Formato da URL
URL com controle de versão: /api/sn_cdm/{api_version}/changesets/activity
URL padrão: /api/sn_cdm/changesets/activity
### Parâmetros de solicitação compatíveis
{#chngsets-GET-activity__entry__2}{#chngsets-GET-activity__version-RESTAPI}
| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
[Tabela 13. Parâmetros de caminho]
{#chngsets-GET-activity__entry__6}{#chngsets-GET-activity__changesetNumber-changeset-entry}{#chngsets-GET-activity__cdm_apps-returnFields-entry}
| Nome | Descrição |
|-|-|
| changesetNumber | Obrigatório. Identificador exclusivo do changeset associado, como "Chset-10". Localizado na tabela CDMChangeset \[sn_cdm_changeset\]. Tipo de dados: cadeia de caracteres |
| returnFields | Lista de campos a serem retornados como parte da resposta. Passe os nomes da coluna de registro, como sys_id, sys_updated_by ou state. Tipo de dados: matriz Padrão: todos os campos determinados pelo endpoint |
[Tabela 14. Parâmetros de consulta]
{#chngsets-GET-activity__entry__12}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 15. Parâmetros do corpo da solicitação]
### Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#chngsets-GET-activity__entry__16}{#chngsets-GET-activity__accept-JSON-only-entry-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
[Tabela 16. Cabeçalhos da solicitação]
{#chngsets-GET-activity__entry__20}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 17. Cabeçalhos de resposta]
### Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#chngsets-GET-activity__entry__24}{#chngsets-GET-activity__entry-200-status-code}{#chngsets-GET-activity__entry-400-status-code}{#chngsets-GET-activity__entry-500-status-code}
| Código de 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. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 18. Códigos de status]
### Parâmetros do corpo da resposta
{#chngsets-GET-activity__entry__32}
| Nome | Descrição |
|-|-|
| changeset_id | Detalhes do changeset solicitado. Tipo de dados: objeto "changeset_id": { "link": "String", "value": "String" } |
| changeset_id.link | Consulta a ser usada para chamar o endpoint REST de tabela para recuperar o changeset associado. Tipo de dados: cadeia de caracteres |
| changeset_id.valor | Sys_id do changeset associado. Localizado na tabela CDM Changeset \[sn_cdm_changeset\]. Tipo de dados: cadeia de caracteres |
| conflito | Sinalizador que indica se há um conflito no changeset associado. Valores válidos: * verdadeiro: conflito detectado. * falso: nenhum conflito encontrado. Tipo de dados: booliano |
| criado | Data e hora em que o nó foi criado. Formato: AAAA-mm-DD hh:mm:ss Tipo de dados: cadeia de caracteres |
| criado_por | Nome de usuário do usuário que cria o nó. Por exemplo, "able.tuter". Tipo de dados: cadeia de caracteres |
| erro | Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem de erro gerada ao tentar processar a solicitação. Tipo de dados: cadeia de caracteres |
| name_path | Nome do caminho do nó. Tipo de dados: cadeia de caracteres |
| new_name | Nome atual do nó. Tipo de dados: cadeia de caracteres |
| new_value | Valor atual do nó. Para nós folha e literais de matriz. Tipo de dados: cadeia de caracteres |
| old_name | Nome anterior do nó. Tipo de dados: cadeia de caracteres |
| old_value | Valor anterior do nó. Para nós folha e literais de matriz. Tipo de dados: cadeia de caracteres |
| atualizado | Data e hora em que o nó foi atualizado pela última vez. Formato: AAAA-mm-DD hh:mm:ss Tipo de dados: cadeia de caracteres |
| atualizado_por | Nome de usuário do usuário que atualizou o nó pela última vez. Por exemplo, "able.tuter". Tipo de dados: cadeia de caracteres |
| seguro | Sinalizador que indica se o nó folha associado foi protegido. Valores válidos: * verdadeiro: o nó foi protegido. * falso: o nó não foi protegido. Tipo de dados: booliano |
| tipo | Tipo de nó. Valores possíveis: * sn_cdm_node_collection * sn_cdm_node_component * sn_cdm_node_folder * sn_cdm_node_cdi * sn_cdm_node_variable {#chngsets-GET-activity__ul_mlj_vdm_c5b} Tipo de dados: cadeia de caracteres |
[ ]
### Solicitação de cURL
Este exemplo de código mostra como recuperar as mudanças de nó para um changeset específico.
curl "http://instance.servicenow.com/api/sn_cdm/changesets/activity?changesetNumber=Chset-783" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Retornar resultados:
{
"result": [
{
"sys_id": "ed5d6c0f53141110a1d3ddeeff7b1233",
"changeset_id": "955d6c0f53141110a1d3ddeeff7b1233",
"new_value": null,
"new_state": "Deleted",
"new_name": "Dep-1",
"new_type": "Deployable",
"new_encrypted": false,
"updated_on": "2022-06-29 13:09:46",
"updated_by": "admin",
"resolution_method": "",
"conflict": null,
"path": "deployables/Dep-1",
"created_by": null,
"created_on": null,
"old_value": null,
"old_state": "Superseded",
"old_name": "Dep-1",
"old_type": "Deployable",
"old_encrypted": false
}
]
}
## CdmChangesetsApi -- GET /sn_cdm/changesets/commit-status/{commit_id} {#ariaid-title5}
Retorna o status atual da solicitação de confirmação do conjunto de mudanças especificado.
### Formato da URL
URL com controle de versão: /api/sn_cdm/{api_version}/changesets/commit-status/{commit_id}
URL padrão: /api/sn_cdm/changesets/commit-status/{commit_id}
### Parâmetros de solicitação compatíveis
{#chngsets-GET-commit-status__entry__2}{#chngsets-GET-commit-status__version-RESTAPI}
| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| confirmar_id | Sys_id da solicitação de confirmação cujo status será retornado. Este valor é retornado pelo endpoint [CdmChangesetsApi -- POST /sn_cdm/changesets/{changeset_id}/commit](https://servicenow-prod.fluidtopics.net/8rKTcLZo2xNNikGfpyfm5w#chngsets-POST-commit "Confirma o changeset especificado. Depois de confirmado, o conjunto de mudanças é persistente nas tabelas do CDM na instância associada."). |
[Tabela 19. Parâmetros de caminho]
{#chngsets-GET-commit-status__entry__8}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 20. Parâmetros de consulta]
{#chngsets-GET-commit-status__entry__12}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 21. Parâmetros do corpo da solicitação (XML ou JSON)]
### Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#chngsets-GET-commit-status__entry__16}{#chngsets-GET-commit-status__accept-JSON-only-entry-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
[Tabela 22. Cabeçalhos da solicitação]
{#chngsets-GET-commit-status__entry__20}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 23. Cabeçalhos de resposta]
### Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#chngsets-GET-commit-status__entry__24}{#chngsets-GET-commit-status__entry-200-status-code}{#chngsets-GET-commit-status__entry-400-status-code}{#chngsets-GET-commit-status__entry-500-status-code}
| Código de 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. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 24. Códigos de status]
### Parâmetros do corpo da resposta
{#chngsets-GET-commit-status__entry__32}{#chngsets-GET-commit-status__cdm_apps-request_id-row}{#chngsets-GET-commit-status__cdm_apps-export_id-row}{#chngsets-GET-commit-status__cdm_apps-state-row}
| Nome | Descrição |
|-|-|
| confirmar_id | sys_id do registro de solicitação de confirmação. Igual ao passado para o endpoint. Tipo de dados: cadeia de caracteres |
| erros | Descrição dos erros encontrados durante o upload. Tipo de dados: cadeia de caracteres |
| saída | Descrição dos dados carregados ou, se ocorreu um erro durante o carregamento, uma mensagem de erro descrevendo o erro encontrado. Tipo de dados: objeto "output": { "auto_validate": "String", "cdm_application": "String", "committed_at": "String", "committed_by": "String", "description": "String", "last_conflict_detection_time": "String", "number": "String", "publish_option": "String", "snapshot_description": "String", "snapshot_name": "String", "state": "String", "sys_created_by": "String", "sys_id": "String", "title": "String" } |
| saída.auto_validate | Indica se a validação deve ser invocada após a confirmação. Tipo de dados: cadeia de caracteres |
| saída.cdm_aplicação | Nome da aplicação sob a qual o upload foi realizado. Tipo de dados: cadeia de caracteres |
| saída.comprometida_em | Data e hora em que o conteúdo carregado foi confirmado. Tipo de dados: cadeia de caracteres |
| saída.comprometida_por | Sys_id do registro da entidade que realizou a confirmação. Tipo de dados: cadeia de caracteres |
| saída.descrição | Não usado no momento. Tipo de dados: cadeia de caracteres |
| output.last_conflict_detection_time | Invocação de detecção de conflitos de data e hora. Tipo de dados: cadeia de caracteres |
| saída.número | Número exclusivo do changeset. Tipo de dados: cadeia de caracteres |
| saída.publish_option | Opção de publicação para os snapshots configurados associados. Valores válidos: * publicar_none: não publicar nenhum snapshot. * Public_valid: publique somente os snapshots aprovados na validação após a confirmação. Para obter informações adicionais sobre como publicar snapshots, consulte [Publicar ou cancelar a publicação de um snapshot](https://www.servicenow.com/docs/access?context=cdm-snapshot-publish&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres Padrão: publicar_none |
| output.snapshot_description | Descrição do snapshot associado. Tipo de dados: cadeia de caracteres |
| saída.snapshot_name | Nome do snapshot associado. Tipo de dados: cadeia de caracteres |
| saída.estado | Estado do conteúdo de carregamento. Valores possíveis: * confirmado * concluído * erro * em_andamento * novo * pronto {#chngsets-GET-commit-status__ul_qhn_w4p_psb} Tipo de dados: cadeia de caracteres |
| saída.sys_created_by | Sys_id da entidade que criou o registro. Tipo de dados: cadeia de caracteres |
| saída.sys_id | Sys_id do registro que contém o changeset. Tipo de dados: cadeia de caracteres |
| saída.título | Título do changeset criado como parte do upload. Tipo de dados: cadeia de caracteres |
| processando_estado | Estado de processamento atual da solicitação de confirmação. Valores possíveis: * NÃO_PROCREADO * PROCESSADO {#chngsets-GET-commit-status__ul_gmt_2pp_psb} Tipo de dados: cadeia de caracteres |
| request_id | ID da solicitação. Igual ao passado para o endpoint e commit_id. Tipo de dados: cadeia de caracteres |
| estado | Estado atual da confirmação especificada. Valor da coluna de estado na tabela Fila de solicitações do CDM \[sn_cdm_request_queue\]. Valores possíveis: * concluído * erro * em_andamento * novo * pronto Tipo de dados: cadeia de caracteres |
| tipo | Tipo de solicitação. Valores possíveis: * confirmar * exportar * carregar_e_confirmar Tipo de dados: cadeia de caracteres |
[ ]
### Solicitação de cURL
O exemplo a seguir mostra como chamar este endpoint para obter o status da confirmação especificada.
curl "http://instance.servicenow.com/api/sn_cdm/changesets/commit-status/bf506e69537c3010a1d3ddeeff7b12c0"\
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Veja a seguir exemplos de respostas de sucesso e erro.
// Successful response
{
"result": {
"type": "commit",
"state": "completed",
"output": {
"sys_id": "4a4407e953124110da35ddeeff7b1235",
"number": "Chset-1207",
"title": "admin064407e953124110da35ddeeff7b1235",
"description": "A description of my changeset provided during creation",
"committed_at": "2022-03-17 22:19:33",
"committed_by": "6816f79cc0a8016401c5a33be04be441",
"sys_created_by": "admin",
"state": "committed",
"publish_option": "publish_none",
"auto_validate": false,
"snapshot_name": null,
"snapshot_description": null,
"cdm_application": "DemoApp",
"last_conflict_detection_time": null
},
"processing_state": "PROCESSED",
"commit_id": "9cd583e953124110da35ddeeff7b128a"
}
}
// Example of an error response
{
"result": {
"state": "error",
"errors": "Invalid requestId '9cd583e953124110da35ddeeff7b128'",
"commit_id": "9cd583e953124110da35ddeeff7b128"
}
}
## CdmChangesetsApi -- GET /sn_cdm/changesets/impacted-deployables {#ariaid-title6}
Retorna a lista de implantáveis associados a um changeset especificado.
A função de Visualizador do CDM é necessária para acessar este endpoint.
### Formato da URL
URL com controle de versões: /api/sn_cdm/{api_version}/changesets/impacted-deployables
URL padrão: /api/sn_cdm/changesets/impacted-deployables
### Parâmetros de solicitação compatíveis
{#chngsets-GET-impact-deploys__entry__2}{#chngsets-GET-impact-deploys__version-RESTAPI}
| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
[Tabela 25. Parâmetros de caminho]
{#chngsets-GET-impact-deploys__entry__6}{#chngsets-GET-impact-deploys__changesetNumber-changeset-entry}{#chngsets-GET-impact-deploys__cdm_apps-returnFields-entry}
| Nome | Descrição |
|-|-|
| changesetNumber | Obrigatório. Identificador exclusivo do changeset associado, como "Chset-10". Localizado na tabela CDMChangeset \[sn_cdm_changeset\]. Tipo de dados: cadeia de caracteres |
| returnFields | Lista de campos a serem retornados como parte da resposta. Passe os nomes da coluna de registro, como sys_id, sys_updated_by ou state. Tipo de dados: matriz Padrão: todos os campos determinados pelo endpoint |
[Tabela 26. Parâmetros de consulta]
{#chngsets-GET-impact-deploys__entry__12}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 27. Parâmetros do corpo da solicitação]
### Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#chngsets-GET-impact-deploys__entry__16}{#chngsets-GET-impact-deploys__accept-JSON-only-entry-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
[Tabela 28. Cabeçalhos da solicitação]
{#chngsets-GET-impact-deploys__entry__20}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 29. Cabeçalhos de resposta]
### Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#chngsets-GET-impact-deploys__entry__24}{#chngsets-GET-impact-deploys__entry-200-status-code}{#chngsets-GET-impact-deploys__entry-400-status-code}{#chngsets-GET-impact-deploys__entry-500-status-code}
| Código de 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. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 30. Códigos de status]
### Parâmetros do corpo da resposta
{#chngsets-GET-impact-deploys__id_lcm_5dn_qtb__entry__2}{#chngsets-GET-impact-deploys__cdm_app_link-app-entry}{#chngsets-GET-impact-deploys__cdm_app_value-app-entry}{#chngsets-GET-impact-deploys__cdm_apps-error-entry}{#chngsets-GET-impact-deploys__cdm_dep-sys_created_by-row}{#chngsets-GET-impact-deploys__cdm_deps-sys_created_on-row}{#chngsets-GET-impact-deploys__cdm_dep-sys_updated_by-row}{#chngsets-GET-impact-deploys__cdm_dep-sys_updated_on-row}
| Nome | Descrição |
|-|-|
| cdi_count | Número de itens de dados de configuração (CDIs) contidos na aplicação de CDM associada. Tipo de dados: inteiro |
| cdi_usage | Porcentagem dos CDIs usados pelo implantável. Tipo de dados: inteiro |
| cdm_app | Objeto de aplicação do CDM associado ao implantável. Tipo de dados: objeto "cdm_app": { "link": "String", "value": "String" } |
| cdm_app.link | Chamada para usar para acessar o registro da aplicação CDM usando a REST Table API. Tipo de dados: cadeia de caracteres |
| cdm_app.value | Sys_id do registro da aplicação CDM associado. Localizado na tabela Aplicação de CDM \[sn_cdm_application\]. Tipo de dados: cadeia de caracteres |
| cdm_ci | Objeto de serviço de aplicações associado ao implantável. Tipo de dados: objeto "cdm_ci": { "link": "String", "value": "String" } |
| cdm_ci.link | Chamada para usar para acessar o registro de serviço de aplicativos usando a REST Table API. Tipo de dados: cadeia de caracteres |
| cdm_ci.value | Sys_id do registro de serviço de aplicações associado. Localizado na tabela Item de configuração \[cmdb_ci\]. Tipo de dados: cadeia de caracteres |
| descrição | Descrição do implantável do CDM gerado. Tipo de dados: cadeia de caracteres |
| tipo_ambiente | Tipo de ambiente do implantável. Valores possíveis: * Desenvolvimento * Produção * Teste Tipo de dados: cadeia de caracteres |
| erro | Retornado somente se ocorreu um erro durante o processamento. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem de erro gerada ao tentar processar a solicitação. Tipo de dados: cadeia de caracteres |
| nome | Nome do implantável do CDM. Tipo de dados: cadeia de caracteres |
| node | Detalhes sobre o nó implantável. Tipo de dados: objeto "node": { "link": "String", "value": "String" } |
| nó.link | Chamada para usar para acessar o registro de nó implantável usando a REST Table API. Tipo de dados: cadeia de caracteres |
| nó.valor | Sys_id do registro de nó implantável. Localizado na tabela CDM implantável \[sn_cdm_deployable\]. Tipo de dados: cadeia de caracteres |
| snapshot_version_counter | Número de snapshots criados para o implantável. Tipo de dados: inteiro |
| estado | Estado atual do implantável. Valores possíveis: * ativo * excluído Tipo de dados: cadeia de caracteres |
| sys_created_by | Nome de usuário do usuário que criou o implantável do CDM. Por exemplo, "able.tuter". Tipo de dados: cadeia de caracteres |
| sys_created_on | Data e hora em que o implantável do CDM foi criado. Formato: AAAA-mm-DD hh:mm:ss Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id do implantável criado. Localizado na tabela CDM implantável \[sn_cdm_deployable\]. Tipo de dados: cadeia de caracteres |
| sys_updated_by | Nome de usuário do usuário que atualizou pela última vez o implantável do CDM. Por exemplo, "able.tuter". Tipo de dados: cadeia de caracteres |
| sys_updated_on | Data e hora em que o implantável do CDM foi atualizado pela última vez. Formato: AAAA-mm-DD hh:mm:ss Tipo de dados: cadeia de caracteres |
[ ]
{#chngsets-GET-impact-deploys__id_lcm_5dn_qtb}
### Solicitação de cURL
O exemplo de código a seguir mostra como recuperar os implantáveis afetados para um conjunto de mudanças especificado.
curl "http://instance.servicenow.com/api/sn_cdm/changesets/impacted-deployables?changesetNumber=Chset-783" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Retornar resultados:
{
"result": [
{
"cmdb_ci": {
"value": "75c5d7a953b70110a1d3ddeeff7b12a2",
"link": "http://instance.servicenow.com/api/now/table/cmdb_ci_service_auto/75c5d7a953b70110a1d3ddeeff7b12a2"
},
"cdi_count": "2",
"snapshot_version_counter": "3",
"description": null,
"sys_updated_on": "2022-06-29 16:19:05",
"environment_type": "Development",
"node": {
"value": "a1c517a953b70110a1d3ddeeff7b129b",
"link": "http://instance.servicenow.com/api/now/table/sn_cdm_node/a1c517a953b70110a1d3ddeeff7b129b"
},
"sys_id": "6dc517a953b70110a1d3ddeeff7b129b",
"sys_updated_by": "admin",
"cdm_app": {
"value": "62b517a953b70110a1d3ddeeff7b128c",
"link": "http://instance.servicenow.com/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c"
},
"sys_created_on": "2022-05-31 13:03:23",
"cdi_usage": "0.02",
"name": "Development_1",
"state": "active",
"sys_created_by": "admin"
}
]
}
## CdmChangesetsApi -- GET /sn_cdm/changesets/impacted-shared-components {#ariaid-title7}
Retorna uma lista de componentes compartilhados que estão associados a um changeset especificado.
A função de Visualizador do CDM é necessária para acessar este endpoint.
### Formato da URL
URL com controle de versão: /api/sn_cdm/{api_version}/changesets/impacted-shared-components
URL padrão: /api/sn_cdm/changesets/impacted-shared-components
### Parâmetros de solicitação compatíveis
{#chngsets-GET-impact_shared_comp__entry__2}{#chngsets-GET-impact_shared_comp__version-RESTAPI}
| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
[Tabela 31. Parâmetros de caminho]
{#chngsets-GET-impact_shared_comp__entry__6}{#chngsets-GET-impact_shared_comp__changesetNumber-changeset-entry}{#chngsets-GET-impact_shared_comp__cdm_apps-returnFields-entry}
| Nome | Descrição |
|-|-|
| changesetNumber | Obrigatório. Identificador exclusivo do changeset associado, como "Chset-10". Localizado na tabela CDMChangeset \[sn_cdm_changeset\]. Tipo de dados: cadeia de caracteres |
| returnFields | Lista de campos a serem retornados como parte da resposta. Passe os nomes da coluna de registro, como sys_id, sys_updated_by ou state. Tipo de dados: matriz Padrão: todos os campos determinados pelo endpoint |
[Tabela 32. Parâmetros de consulta]
{#chngsets-GET-impact_shared_comp__entry__12}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 33. Parâmetros do corpo da solicitação]
### Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#chngsets-GET-impact_shared_comp__entry__16}{#chngsets-GET-impact_shared_comp__accept-JSON-only-entry-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
[Tabela 34. Cabeçalhos da solicitação]
{#chngsets-GET-impact_shared_comp__entry__20}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 35. Cabeçalhos de resposta]
### Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#chngsets-GET-impact_shared_comp__entry__24}{#chngsets-GET-impact_shared_comp__entry-200-status-code}{#chngsets-GET-impact_shared_comp__entry-500-status-code}
| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. O changeset aprovado não existe. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 36. Códigos de status]
### Parâmetros do corpo da resposta
{#chngsets-GET-impact_shared_comp__entry__32}{#chngsets-GET-impact_shared_comp__cdm_apps-error-entry}{#chngsets-GET-impact_shared_comp__cdm_apps-error_detail-entry}{#chngsets-GET-impact_shared_comp__cdm_apps-error_message-entry}{#chngsets-GET-impact_shared_comp__cdm_dep-sys_created_by-row}{#chngsets-GET-impact_shared_comp__cdm_deps-sys_created_on-row}{#chngsets-GET-impact_shared_comp__cdm_dep-sys_updated_by-row}{#chngsets-GET-impact_shared_comp__cdm_dep-sys_updated_on-row}
| Nome | Descrição |
|-|-|
| cdm_shared__library | Sys_id da biblioteca compartilhada na qual o componente reside. Tipo de dados: cadeia de caracteres |
| descrição | Descrição do componente compartilhado do CDM. Tipo de dados: cadeia de caracteres |
| erro | Retornado somente se ocorreu um erro durante o processamento. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Detalhes sobre o erro ocorrido. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem que fornece uma visão geral do erro. Tipo de dados: cadeia de caracteres |
| nome | Nome do componente compartilhado do CDM. Tipo de dados: cadeia de caracteres |
| node | Sys_id do nó do componente compartilhado. Localizado na tabela Nó do CDM \[sn_cdm_node\]. Tipo de dados: cadeia de caracteres |
| nó_principal | Sys_id do main_id do registro do nó do componente compartilhado. Localizado na tabela principal do nó do CDM \[sn_cdm_node_main\]. Tipo de dados: cadeia de caracteres |
| estado | Estado atual do componente compartilhado. Valores possíveis: * ativo * excluído Tipo de dados: cadeia de caracteres |
| sys_created_by | Nome de usuário do usuário que cria o componente compartilhado do CDM. Por exemplo, "able.tuter". Tipo de dados: cadeia de caracteres |
| sys_created_on | Data e hora em que o componente compartilhado do CDM foi criado. Formato: AAAA-mm-DD hh:mm:ss Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id do componente compartilhado. Localizado na tabela Componente compartilhado do CDM \[sn_cdm_shared_component\]. Tipo de dados: cadeia de caracteres |
| sys_updated_by | Nome de usuário do usuário que atualizou pela última vez o componente compartilhado do CDM. Por exemplo, "able.tuter". Tipo de dados: cadeia de caracteres |
| sys_updated_on | Data e hora em que o componente compartilhado do CDM foi atualizado pela última vez. Formato: AAAA-mm-DD hh:mm:ss Tipo de dados: cadeia de caracteres |
| contador_versão | Número de versões criadas para o componente compartilhado. Tipo de dados: inteiro |
[ ]
### Solicitação de cURL
O exemplo de código a seguir mostra como recuperar os componentes compartilhados afetados para changeset = "Chset-20".
curl "https://instance.servicenow.com/sn_cdm/changesets/impacted-shared-components?changesetNumber=Chset-20" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Resposta:
{
"result": [
{
"version_counter": "1",
"description": null,
"cdm_shared_library": "acb905e097b3991052687b890353afcd",
"sys_updated_on": "2022-12-12 20:28:49",
"node": "3cb945e097b3991052687b890353af0d",
"sys_id": "34b945e097b3991052687b890353af20",
"sys_updated_by": "john.jones",
"node_main": "74b945e097b3991052687b890353af0d",
"sys_created_on": "2022-12-12 20:28:39",
"name": "logonService-V2.1",
"state": "active",
"sys_created_by": "john.jones"
},
{
"version_counter": "1",
"description": null,
"cdm_shared_library": "acb905e097b3991052687b890353afcd",
"sys_updated_on": "2022-12-12 20:28:49",
"node": "b0b945e097b3991052687b890353af11",
"sys_id": "30b945e097b3991052687b890353af21",
"sys_updated_by": "john.jones",
"node_main": "f8b945e097b3991052687b890353af10",
"sys_created_on": "2022-12-12 20:28:39",
"name": "logonService-V2.2",
"state": "active",
"sys_created_by": "john.jones"
},
{
"version_counter": "1",
"description": null,
"cdm_shared_library": "acb905e097b3991052687b890353afcd",
"sys_updated_on": "2022-12-12 20:28:49",
"node": "6cb905e097b3991052687b890353afd3",
"sys_id": "b4b945e097b3991052687b890353af21",
"sys_updated_by": "john.jones",
"node_main": "a4b905e097b3991052687b890353afd3",
"sys_created_on": "2022-12-12 20:28:39",
"name": "paymentService-V1.0",
"state": "active",
"sys_created_by": "john.jones"
},
{
"version_counter": "1",
"description": null,
"cdm_shared_library": "acb905e097b3991052687b890353afcd",
"sys_updated_on": "2022-12-12 20:28:49",
"node": "e0b905e097b3991052687b890353aff1",
"sys_id": "3cb945e097b3991052687b890353af21",
"sys_updated_by": "john.jones",
"node_main": "2cb905e097b3991052687b890353aff0",
"sys_created_on": "2022-12-12 20:28:39",
"name": "paymentService-V1.1",
"state": "active",
"sys_created_by": "john.jones"
}
]
}
## CdmChangesetsApi -- GET /sn_cdm/changesets/{changeset_id}/impacted-deployables {#ariaid-title8}
Retorna a lista de implantáveis associados a um changeset especificado.
### Formato da URL
URL com controle de versão: /api/sn_cdm/{api_version}/changesets/{changeset_id}/impacted-deployables
URL padrão: /api/sn_cdm/changesets/{changeset_id}/impacted-deployables
### Parâmetros de solicitação compatíveis
{#chngsets-GET-impacted-deployables__entry__2}{#chngsets-GET-impacted-deployables__version-RESTAPI}
| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| changeset_id | Sys_id do registro do changeset a ser processado. Localizado na tabela CDM Changeset \[sn_cdm_changeset\]. Tipo de dados: cadeia de caracteres |
[Tabela 37. Parâmetros de caminho]
{#chngsets-GET-impacted-deployables__entry__8}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 38. Parâmetros de consulta]
{#chngsets-GET-impacted-deployables__entry__12}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 39. Parâmetros do corpo da solicitação (XML ou JSON)]
### Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#chngsets-GET-impacted-deployables__entry__16}{#chngsets-GET-impacted-deployables__accept-JSON-only-entry-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
[Tabela 40. Cabeçalhos da solicitação]
{#chngsets-GET-impacted-deployables__entry__20}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 41. Cabeçalhos de resposta]
### Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#chngsets-GET-impacted-deployables__entry__24}{#chngsets-GET-impacted-deployables__entry-200-status-code}{#chngsets-GET-impacted-deployables__entry-400-status-code}{#chngsets-GET-impacted-deployables__entry-500-status-code}
| Código de 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. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 42. Códigos de status]
### Parâmetros do corpo da resposta
{#chngsets-GET-impacted-deployables__entry__32}
| Nome | Descrição |
|-|-|
| changeset_id | Sys_id do último changeset associado ao nó implantável. Tipo de dados: cadeia de caracteres |
| conflito | Sinalizador que indica se o implantável associado está em conflito. Valores válidos: * 0: não está em conflito. * 1: Conflito - consulte o resultado de retorno conflict_type para obter informações adicionais. {#chngsets-GET-impacted-deployables__ul_enr_rxd_btb} Tipo de dados: número |
| tipo_conflito | Tipo de conflito implantável. Valores possíveis: * nó_corrompido * nó_excluído * nó_duplicado * incompleto_deleted_parent * ref_excluído_incompleto * incompleto_renamed_ref * invalid_include * descendente_órfão * relacionado_conflito * unlinked_include * unrenamed_include * update_node {#chngsets-GET-impacted-deployables__ul_okw_dyd_btb} Tipo de dados: cadeia de caracteres |
| descrição | Descrição do nó implantável. Tipo de dados: cadeia de caracteres |
| eficaz_de | Carimbo de data/hora de quando o nó é válido. Este valor é nulo até que você confirme um changeset no qual o nó foi criado. Tipo de dados: número |
| eficaz_para | Carimbo de data/hora de quando o nó não é mais válido. Se este valor for nulo, o nó permanecerá afetado até que seja substituído por uma nova versão. Tipo de dados: número |
| erro | Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem de erro gerada ao tentar processar a solicitação. Tipo de dados: cadeia de caracteres |
| nível | Profundidade do nó a partir do nível da aplicação, que é 0. Tipo de dados: número |
| vinculado_a | ID do nó de referência em uma coleção e componente. Por exemplo, o snippet de nó a seguir mostra um link entre a coleção collA e o componente compA. Para este exemplo, o valor linkedTo é 1: { components : {compA:{} //MainId: 1}, Collections : { collA : { compA :{} //Include, linkedTo: 1 } } } Tipo de dados: cadeia de caracteres |
| main_id | Identificador exclusivo do nó implantável. Este valor é gerado quando o nó é criado e usado para identificar o nó implantável. Tipo de dados: número |
| main_id_encoded | O valor codificado dos resultados de retorno mainId, usando a representação de cadeia de caracteres Radix 57. Tipo de dados: cadeia de caracteres |
| nome | Nome do implantável. Tipo de dados: cadeia de caracteres |
| nó_classificador | Classificação de nó, como Desenvolvimento, Produção ou Teste. No formato: * /application/deployables/env:Desenvolvimento * /aplicação/implantáveis/ambiente:produção * /application/deployables/env:Test {#chngsets-GET-impacted-deployables__ul_fg5_ghd_btb} Tipo de dados: cadeia de caracteres |
| posição | Posição do nó implantável. Aplicável somente a matrizes. Por exemplo, para a matriz: node1:{ arrayNode: [{}, "literal1", "literal2", []] } {} está na posição 1000, "literal1" é a posição 2000, "literal2" é a posição 3000, \[\] é a posição 4000 Tipo de dados: número |
| versão_anterior | Sys_id da versão anterior do nó implantável associado. Tipo de dados: cadeia de caracteres |
| restrito_a | Lista de sys_ids dos usuários que têm permissão para acessar o nó implantável associado. Essas informações vêm da tabela Grupos restritos do CDM \[sn_cdm_restricted_groups\]. Este valor será nulo se todos os grupos puderem acessar o implantável. Tipo de dados: cadeia de caracteres |
| valor_seguro | Valor seguro do CDI ou variável. Retornado somente para nós folha e literais de matriz. Este é o mesmo que o resultado de retorno value, mas é criptografado. Tipo de dados: cadeia de caracteres |
| status | Status do nó implantável ou o status de uma solicitação com falha. Valores possíveis: * excluído * falha (aprovada se a chamada do endpoint falhar). * novo * substituído * atualizado * válido {#chngsets-GET-impacted-deployables__ul_yjp_3gd_btb} Tipo de dados: cadeia de caracteres |
| pasta_do_sistema | Sinalizador que indica se a pasta associada é uma pasta do sistema. Valores válidos: * 0: não é uma pasta do sistema. * 1: pasta do sistema. {#chngsets-GET-impacted-deployables__ul_e3d_hwd_btb} Tipo de dados: número |
| sys_id | Sys_id do implantável afetado. Tipo de dados: cadeia de caracteres |
| tipo | Tipo de nó, como sn_cdm_node_deployable. Este valor permite que você determine se o nó é um componente, item de dados de configuração (CDI) ou implantável. Este valor é gerado quando o nó é criado. Tipo de dados: cadeia de caracteres |
| valor | Valor do CDI ou variável. Retornado somente para nós folha e literais de matriz. Se essas informações forem criptografadas, elas serão retornadas no resultado de retorno secure_value. Por exemplo, se este nó for o CDI `nodeA:{cdi1: 1}`, o resultado de retorno value será 1. Se for um nó de matriz, como `node1: {arrayNode: [{}, "literal1", "literal2", []]}`, o resultado de retorno value será literal1. Tipo de dados: cadeia de caracteres |
[ ]
### Solicitação de cURL
O exemplo a seguir mostra como solicitar os implantáveis associados ao changeset cujo sys_id é bf506e69537c3010a1d3ddeeff7b12c0.
curl "http://instance.servicenow.com/api/sn_cdm/changesets/bf506e69537c3010a1d3ddeeff7b12c0/impacted-deployables"\
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Veja a seguir uma resposta de sucesso e de erro para este endpoint.
// Successful response
{
"result": [
{
"sys_id": "833527a953924110da35ddeeff7b12c1",
"type": "sn_cdm_node_deployable",
"main_id": "150",
"main_id_encoded": "&M",
"node_path": "!&@!&D!&M",
"level": 2,
"status": "valid",
"node_classifier": "/application/deployables/env:Development",
"position": null,
"restricted_to": null,
"changeset_id": "cb3527a953924110da35ddeeff7b12c0",
"previous_version": "e8946f6953924110da35ddeeff7b1264",
"effective_from": "1647563806950",
"effective_to": null,
"name": "Development_1",
"description": "dev deployable decription",
"value": null,
"secure_value": null,
"system_folder": "0",
"linked_to": null,
"conflict": "0",
"conflict_type": null
},
{
"sys_id": "a245e7a953924110da35ddeeff7b1223",
"type": "sn_cdm_node_deployable",
"main_id": "153",
"main_id_encoded": "&P",
"node_path": "!&@!&D!&P",
"level": 2,
"status": "valid",
"node_classifier": "/application/deployables/env:Test",
"position": null,
"restricted_to": null,
"changeset_id": "ea45e7a953924110da35ddeeff7b1222",
"previous_version": "9505ef6953924110da35ddeeff7b121a",
"effective_from": "1647563821422",
"effective_to": null,
"name": "Test_1",
"description": "test deployable decription",
"value": null,
"secure_value": null,
"system_folder": "0",
"linked_to": null,
"conflict": "0",
"conflict_type": null
}
]
}
// Example of an error response
{
"error": {
"message": "Error: Unexpected error occurred in create request.Error:Application not found",
"detail": ""
},
"status": "failure"
}
## CdmChangesetsApi -- POST /sn_cdm/changesets/{changeset_id}/commit {#ariaid-title9}
Confirma o changeset especificado. Depois de confirmado, o conjunto de mudanças é persistente nas tabelas do CDM na instância associada.
O sistema atualiza a aplicação para persistir nas mudanças nos dados de configuração no changeset. O estado do changeset muda para Confirmado. O sistema gera um snapshot de cada implantável afetado pelo changeset.
Este endpoint retorna o ID da solicitação de confirmação. Use este ID para chamar o endpoint [CdmChangesetsApi -- GET /sn_cdm/changesets/commit-status/{commit_id}](https://servicenow-prod.fluidtopics.net/8rKTcLZo2xNNikGfpyfm5w#chngsets-GET-commit-status "Retorna o status atual da solicitação de confirmação do conjunto de mudanças especificado.") para obter o status atual da confirmação do conjunto de mudanças.
### Formato da URL
URL com controle de versão: /api/sn_cdm/{api_version}/changesets/{changeset_id}/commit
URL padrão: /api/sn_cdm/changesets/{changeset_id}/commit
### Parâmetros de solicitação compatíveis
{#chngsets-POST-commit__entry__2}{#chngsets-POST-commit__version-RESTAPI}
| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| changeset_id | Sys_id do registro do changeset a ser processado. Localizado na tabela CDM Changeset \[sn_cdm_changeset\]. Tipo de dados: cadeia de caracteres |
[Tabela 43. Parâmetros de caminho]
{#chngsets-POST-commit__entry__8}
| Nome | Descrição |
|-|-|
| autoValidate | Sinalizador que indica se os snapshots criados na confirmação são validados, o que significa que todas as políticas associadas são executadas no snapshot. Valores válidos: * verdadeiro: valida os snapshots. * falso: não valida os snapshots. {#chngsets-POST-commit__ul_aqt_zmb_psb} Padrão: falso |
| publicarOpção | Opção de publicação para os snapshots de configuração associados. Valores válidos: * publicar_none: não publica nenhum snapshot. * Public_valid: publique somente os snapshots aprovados na validação após a confirmação. Nota: Esta opção só estará disponível se o valor do parâmetro autoCommit for verdadeiro. Para obter informações adicionais sobre como publicar snapshots, consulte [Publicar ou cancelar a publicação de um snapshot](https://www.servicenow.com/docs/access?context=cdm-snapshot-publish&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres Padrão: publicar_none |
[Tabela 44. Parâmetros de consulta]
{#chngsets-POST-commit__entry__14}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 45. Parâmetros do corpo da solicitação]
### Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#chngsets-POST-commit__entry__18}{#chngsets-POST-commit__accept-JSON-only-entry-RESTAPI}{#chngsets-POST-commit__content_type-JSON-only-entry-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
[Tabela 46. Cabeçalhos da solicitação]
{#chngsets-POST-commit__entry__24}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 47. Cabeçalhos de resposta]
### Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#chngsets-POST-commit__entry__28}{#chngsets-POST-commit__entry-200-status-code}
| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Erro:\ Valide se o parâmetro changeset_id que você passou está correto. Verifique se você tem as funções necessárias para acessar este endpoint. |
| 500 | Erro interno do servidor Erro: valor booliano inválido. Se você passou o parâmetro autoValidate, verifique se é um valor booliano. |
[Tabela 48. Códigos de status]
### Parâmetros do corpo da resposta
{#chngsets-POST-commit__id_bgt_byy_ztb__entry__2}
| Nome | Descrição |
|-|-|
| confirmar_id | Sys_id da solicitação de confirmação. Use este ID ao chamar o endpoint [CdmChangesetsApi -- GET /sn_cdm/changesets/commit-status/{commit_id}](https://servicenow-prod.fluidtopics.net/8rKTcLZo2xNNikGfpyfm5w#chngsets-GET-commit-status "Retorna o status atual da solicitação de confirmação do conjunto de mudanças especificado.") para verificar o status da solicitação de confirmação. Tipo de dados: cadeia de caracteres |
| erro | Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem de erro gerada ao tentar processar a solicitação. Tipo de dados: cadeia de caracteres |
| status | Status da confirmação. Retornado somente quando ocorre um erro. Valores possíveis: falha Tipo de dados: cadeia de caracteres |
[ ]
{#chngsets-POST-commit__id_bgt_byy_ztb}
### Solicitação de cURL
O exemplo a seguir mostra como chamar este endpoint para confirmar um registro de changeset.
curl "http://instance.servicenow.com/api/sn_cdm/changesets/29e24001533030104bacddeeff7b120c/commit?publishOption=publish_valid"\
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--user 'username':'password'
Veja a seguir a resposta de uma solicitação de confirmação de conjunto de mudanças bem-sucedida.
// Successful response
{
"result": {
"commit_id": "64b5f79f5379301096edddeeff7b12eb"
}
}
// Example of an error response
{
"error": {
"message": "Error: Unexpected error occurred in commit request.Error:Failed to insert request in queue",
"detail": ""
},
"status": "failure"
}
## CdmChangesetsApi -- POST /sn_cdm/changesets/create {#ariaid-title10}
Cria um novo conjunto de mudanças no estado aberto para uma aplicação de CDM ou biblioteca compartilhada especificada.
A função de Editor do CDM é necessária para acessar este endpoint.
### Formato da URL
URL com controle de versão: /api/sn_cdm/{api_version}/changesets/create/
URL padrão: /api/sn_cdm/changesets/create/
### Parâmetros de solicitação compatíveis
{#chngsets-POST-create__entry__2}{#chngsets-POST-create__version-RESTAPI}
| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
[Tabela 49. Parâmetros de caminho]
{#chngsets-POST-create__entry__6}{#chngsets-POST-create__appName-changesets-entry}
| Nome | Descrição |
|-|-|
| appName | Obrigatório. Nome da aplicação de CDM ou biblioteca compartilhada a ser associada a este changeset. Deve ser uma aplicação ativa ou biblioteca compartilhada. Tipo de dados: cadeia de caracteres |
| descrição | Descrição do changeset. Insira algo que permita que outras pessoas entendam a finalidade do changeset. Tipo de dados: cadeia de caracteres Padrão: nenhum |
| returnFields | Lista separada por vírgulas de campos na tabela Changeset do CDM \[sn_cdm_changeset\] a serem retornados como parte da resposta. Tipo de dados: cadeia de caracteres |
[Tabela 50. Parâmetros de consulta]
{#chngsets-POST-create__entry__14}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 51. Parâmetros do corpo da solicitação]
### Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#chngsets-POST-create__entry__18}{#chngsets-POST-create__accept-JSON-only-entry-RESTAPI}{#chngsets-POST-create__content_type-JSON-only-entry-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
[Tabela 52. Cabeçalhos da solicitação]
{#chngsets-POST-create__entry__24}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 53. Cabeçalhos de resposta]
### Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#chngsets-POST-create__entry__28}{#chngsets-POST-create__entry-200-status-code}{#chngsets-POST-create__entry-500-status-code}
| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Erro:\ Certifique-se de que a aplicação de CDM ou a biblioteca compartilhada especificada exista e esteja no estado ativo. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 54. Códigos de status]
### Parâmetros do corpo da resposta
{#chngsets-POST-create__entry__36}
| Nome | Descrição |
|-|-|
| auto_validate | Sinalizador que indica se a validação automática foi realizada. Valores possíveis: * verdadeiro: a validação automática foi realizada. * falso: a validação automática não foi realizada. Tipo de dados: booliano |
| aplicação_cdm | Detalhes sobre a aplicação de CDM associada ao changeset. Tipo de dados: objeto "cdm_application": { "link": "String", "value": "String" } Por exemplo: `{"value": "`\ ", "link": "http://localhost:8081/api/now/table/\*'}" |
| aplicação_cdm.link | URL da aplicação CDM associada. Tipo de dados: cadeia de caracteres |
| cdm_aplicação.valor | Sys_id da aplicação CDM associada. Tipo de dados: cadeia de caracteres |
| confirmado_em | Data e hora em que o changeset foi confirmado no repositório associado. Tipo de dados: cadeia de caracteres |
| confirmado_por | Sys_id da entidade que criou o changeset. Tipo de dados: cadeia de caracteres |
| descrição | Descrição do changeset aprovado quando o endpoint foi chamado. Tipo de dados: cadeia de caracteres |
| erro | Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem de erro gerada ao tentar processar a solicitação. Tipo de dados: cadeia de caracteres |
| last_conflict_detection_time | Última vez em que a detecção de conflitos foi executada. Tipo de dados: número Unidade: Milissegundos |
| número | Identificador exclusivo do novo changeset. Tipo de dados: cadeia de caracteres |
| publish_option | Opção de publicação para os snapshots configurados associados. Valores válidos: * publicar_none: não publicar nenhum snapshot. * Public_valid: publique somente os snapshots aprovados na validação após a confirmação. Para obter informações adicionais sobre como publicar snapshots, consulte [Publicar ou cancelar a publicação de um snapshot](https://www.servicenow.com/docs/access?context=cdm-snapshot-publish&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres Padrão: publicar_none |
| snapshot_description | Descrição do snapshot associado ao changeset. Tipo de dados: cadeia de caracteres |
| estado | Estado da criação do changeset. Valores possíveis: * Bloqueado * Verificando possíveis conflitos * Falha na confirmação * Confirmação em andamento * Confirmado * Aberto Tipo de dados: cadeia de caracteres |
| status | Status da criação do changeset. Retornado somente quando ocorre um erro. Valores possíveis: falha Tipo de dados: cadeia de caracteres |
| sys_created_by | Sys_id da entidade que criou o registro do changeset. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id do novo changeset. Tipo de dados: cadeia de caracteres |
| título | Título do changeset associado à aplicação. Normalmente gerado automaticamente pelo sistema. Tipo de dados: cadeia de caracteres |
[ ]
### Solicitação de cURL
O exemplo a seguir mostra como criar um changeset associado à aplicação CDM do Serviço de aplicações1.
curl "http://instance.servicenow.com/api/sn_cdm/changesets/create?appName=App%20Service1&description=Sample%20Description \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--user 'username':'password'
Veja a seguir a resposta para uma criação bem-sucedida do changeset.
// Example of a successful response
{
"result": {
"sys_id": "42748779c370301054c1582e1340ddcd",
"number": "Chset-8",
"title": "admin2021-06-18 10:06:46",
"description": null,
"committed_at": "",
"committed_by": null,
"sys_created_by": "admin",
"state": "open",
"publish_option": "publish_none",
"auto_validate": false,
"snapshot_name": null,
"snapshot_description": null,
"cdm_application": "App%20Service1"
}
}
// Example of an error response
{
"error": {
"message": "Error: Unexpected error occurred in create request.Error:Application not found",
"detail": ""
},
"status": "failure"
}
### Solicitação de cURL
O exemplo a seguir mostra como criar um changeset para a biblioteca compartilhada "javalib".
curl "http://instance.servicenow.com/api/sn_cdm/changesets/create?sharedLibraryName=javalib&description=description of changeset" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'
Resposta:
```
```
## CdmChangesetsApi -- PUT /sn_cdm/changesets/commit {#ariaid-title11}
Atualiza e confirma um changeset especificado.
O sistema atualiza a aplicação para persistir nas mudanças nos dados de configuração no changeset. O estado do changeset muda para Confirmado. O sistema gera um snapshot de cada implantável afetado pelo changeset.
Este endpoint retorna o ID da solicitação de confirmação. Use este ID para chamar o endpoint [CdmChangesetsApi -- GET /sn_cdm/changesets/commit-status/{commit_id}](https://servicenow-prod.fluidtopics.net/8rKTcLZo2xNNikGfpyfm5w#chngsets-GET-commit-status "Retorna o status atual da solicitação de confirmação do conjunto de mudanças especificado.") para obter o status atual da confirmação do conjunto de mudanças.
### Formato da URL
URL com controle de versão: /api/sn_cdm/{api_version}/changesets/{changeset_id}/commit
URL padrão: /api/sn_cdm/changesets/{changeset_id}/commit
### Parâmetros de solicitação compatíveis
{#chngsets-PUT-commit__entry__2}{#chngsets-PUT-commit__version-RESTAPI}
| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
[Tabela 55. Parâmetros de caminho]
{#chngsets-PUT-commit__entry__6}{#chngsets-PUT-commit__autoValidate-changeset-entry}{#chngsets-PUT-commit__changesetNumber-changeset-entry}
| Nome | Descrição |
|-|-|
| autoValidate | Sinalizador que indica se os snapshots criados durante a confirmação são validados, o que significa que todas as políticas associadas são executadas no snapshot. Valores válidos: * verdadeiro: valida os snapshots. * falso: não valida os snapshots. Tipo de dados: booliano Padrão: falso |
| changesetNumber | Obrigatório. Identificador exclusivo do changeset associado, como "Chset-10". Localizado na tabela CDMChangeset \[sn_cdm_changeset\]. Tipo de dados: cadeia de caracteres |
| publicarOpção | Opção de publicação para os snapshots configurados associados. Valores válidos: * publicar_none: não publicar nenhum snapshot. * Public_valid: publique somente os snapshots aprovados na validação após a confirmação. Para obter informações adicionais sobre como publicar snapshots, consulte [Publicar ou cancelar a publicação de um snapshot](https://www.servicenow.com/docs/access?context=cdm-snapshot-publish&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres Padrão: publicar_none |
[Tabela 56. Parâmetros de consulta]
{#chngsets-PUT-commit__entry__14}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 57. Parâmetros do corpo da solicitação]
### Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#chngsets-PUT-commit__entry__18}{#chngsets-PUT-commit__accept-JSON-only-entry-RESTAPI}{#chngsets-PUT-commit__content_type-JSON-only-entry-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
[Tabela 58. Cabeçalhos da solicitação]
{#chngsets-PUT-commit__entry__24}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 59. Cabeçalhos de resposta]
### Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#chngsets-PUT-commit__entry__28}{#chngsets-PUT-commit__entry-200-status-code}
| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Erro:\ Valide se o parâmetro changeset_id que você passou está correto. Verifique se você tem as funções necessárias para acessar este endpoint. |
| 500 | Erro interno do servidor: valor booliano inválido. Se você passou o parâmetro autoValidate, verifique se é um valor booliano. |
[Tabela 60. Códigos de status]
### Parâmetros do corpo da resposta
{#chngsets-PUT-commit__id_cjx_1yy_ztb__entry__2}
| Nome | Descrição |
|-|-|
| confirmar_id | Sys_id da solicitação de confirmação. Use este ID ao chamar o endpoint [CdmChangesetsApi -- GET /sn_cdm/changesets/commit-status/{commit_id}](https://servicenow-prod.fluidtopics.net/8rKTcLZo2xNNikGfpyfm5w#chngsets-GET-commit-status "Retorna o status atual da solicitação de confirmação do conjunto de mudanças especificado.") para verificar o status da solicitação de confirmação. Tipo de dados: cadeia de caracteres |
| erro | Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem de erro gerada ao tentar processar a solicitação. Tipo de dados: cadeia de caracteres |
| status | Status da confirmação. Retornado somente quando ocorre um erro. Valores possíveis: falha Tipo de dados: cadeia de caracteres |
[ ]
{#chngsets-PUT-commit__id_cjx_1yy_ztb}
### Solicitação de cURL
O exemplo de código a seguir mostra como usar este endpoint para atualizar um changeset.
curl "http://instance.servicenow.com/api/sn_cdm/changesets/commit?changesetNumber=Chset-146" \
--request PUT \
--header "Accept:application/json" \
--user 'username':'password'
Retornar resultados:
{
"result": {
"commit_id": "cca8190f53141110a1d3ddeeff7b129e"
}
}