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


---

# CdmSnapshotApi

# CdmSnapshotApi {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 20 min. de leitura

A CdmSnapshotApi fornece endpoints que permitem publicar, cancelar a publicação e revalidar snapshots em Gestão de dados de configuração (CDM).
Você publica um snapshot para que ele possa ser exportado, permitindo que o pipeline Integração e entrega contínuas (CICD) acesse e use os dados de configuração associados. Os exportadores só podem executar em snapshots publicados. Quando os snapshots não forem mais necessários, você poderá cancelar a publicação deles para reduzir a confusão sobre se o snapshot é mais viável.  
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 snapshots, consulte [Exibir snapshots](https://www.servicenow.com/docs/access?context=cdm-snapshots-view-list&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US).

## CdmSnapshotAPI -- POST /sn_cdm/snapshots/{snapshot_id}/publish {#ariaid-title2}

Publica um snapshot não publicado especificado.
Antes que um snapshot possa ser publicado, ele deve ser validado. Você pode usar o endpoint [CdmSnapshotAPI -- POST /sn_cdm/snapshots/{snapshot_id}/validate](https://servicenow-prod.fluidtopics.net/qEjxg8XUnd37tmDuniFPsA#snapshot-POST-validate "Valida um snapshot não publicado especificado.") para validar snapshots ou fazer com que eles sejam validados automaticamente ao fazer uma confirmação. Um implantável deve estar conectado a um serviço para publicar seus snapshots. Além disso, se o snapshot já tiver sido publicado, a solicitação falhará.

### Formato da URL

URL com controle de versão: /api/sn_cdm/{api_version}/snapshots/{snapshot_id}/publish

URL padrão: /api/sn_cdm/snapshots/{snapshot_id}/publish

### Parâmetros de solicitação compatíveis

{#snapshot-POST-publish__entry__2}{#snapshot-POST-publish__version-RESTAPI}

| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| snapshot_id | Sys_id do registro de snapshot a ser processado. Localizado na tabela Snapshot do CDM \[sn_cdm_snapshot\]. Tipo de dados: cadeia de caracteres |
[Tabela 1. Parâmetros de caminho]

{#snapshot-POST-publish__entry__8}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 2. Parâmetros de consulta]

{#snapshot-POST-publish__entry__12}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)]

### Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#snapshot-POST-publish__entry__16}{#snapshot-POST-publish__accept-JSON-only-entry-RESTAPI}{#snapshot-POST-publish__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 4. Cabeçalhos da solicitação]

{#snapshot-POST-publish__entry__22}

| 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.").
{#snapshot-POST-publish__entry__26}{#snapshot-POST-publish__entry-200-status-code}{#snapshot-POST-publish__entry-400-status-code}{#snapshot-POST-publish__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 (JSON ou XML)

{#snapshot-POST-publish__entry__34}

| Nome | Descrição |
|-|-|
| 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 de erro da solicitação. Valores possíveis: falha Tipo de dados: cadeia de caracteres |
[ ]

### Solicitação de cURL

O exemplo a seguir mostra como publicar o snapshot com o sys_id de 3a168d9dc342301054c1582e1340dd68.

    curl "http://instance.servicenow.com/api/sn_cdm/snapshots/3a168d9dc342301054c1582e1340dd68/publish"\ 
    --request POST \ 
    --header "Accept:application/json" \ 
    --header "Content-Type:application/json" \
    --user 'username':'password' 

O seguinte mostra uma resposta de sucesso e falha para a solicitação de publicação.

    // Example of a successful response
    { 
      "" 
    }

    // Example of an error response
    {
      "error": {
        "message": "Error: Unexpected error occurred in publish request.Error:Snapshot not found",
        "detail": ""
      },
      "status": "failure"
    }

## CdmSnapshotAPI -- POST /sn_cdm/snapshots/{snapshot_id}/unpublish {#ariaid-title3}

Cancela a publicação de um snapshot publicado anteriormente.

### Formato da URL

URL com controle de versão: /api/sn_cdm/{api_version}/snapshots/{snapshot_id}/unpublish

URL padrão: /api/sn_cdm/snapshots/{snapshot_id}/unpublish

### Parâmetros de solicitação compatíveis

{#snapshot-POST-unpublish__entry__2}{#snapshot-POST-unpublish__version-RESTAPI}

| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| snapshot_id | Sys_id do registro de snapshot a ser processado. Localizado na tabela Snapshot do CDM \[sn_cdm_snapshot\]. Tipo de dados: cadeia de caracteres |
[Tabela 7. Parâmetros de caminho]

{#snapshot-POST-unpublish__entry__8}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 8. Parâmetros de consulta]

{#snapshot-POST-unpublish__entry__12}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 9. 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.").
{#snapshot-POST-unpublish__entry__16}{#snapshot-POST-unpublish__accept-JSON-only-entry-RESTAPI}{#snapshot-POST-unpublish__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 10. Cabeçalhos da solicitação]

{#snapshot-POST-unpublish__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.").
{#snapshot-POST-unpublish__entry__26}{#snapshot-POST-unpublish__entry-200-status-code}{#snapshot-POST-unpublish__entry-400-status-code}{#snapshot-POST-unpublish__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 (JSON ou XML)

{#snapshot-POST-unpublish__entry__34}

| Nome | Descrição |
|-|-|
| 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 de erro da solicitação. Valores possíveis: falha Tipo de dados: cadeia de caracteres |
[ ]

### Solicitação de cURL

O exemplo a seguir mostra como cancelar a publicação do snapshot com o sys_id de 3a168d9dc342301054c1582e1340dd68.

    curl "http://instance.servicenow.com/api/sn_cdm/snapshots/3a168d9dc342301054c1582e1340dd68/unpublish"\ 
    --request POST \ 
    --header "Accept:application/json" \ 
    --header "Content-Type:application/json" \
    --user 'username':'password' 

O seguinte mostra uma resposta de sucesso e falha à solicitação de cancelamento de publicação.

    // Example of a successful response
    { 
      "" 
    }

    // Example of an error response
    {
      "error": {
        "message": "Error: Unexpected error occurred in publish request.Error:Snapshot not found",
        "detail": ""
      },
      "status": "failure"
    }

## CdmSnapshotAPI -- POST /sn_cdm/snapshots/{snapshot_id}/validate {#ariaid-title4}

Valida um snapshot não publicado especificado.
A validação é realizada como um processo assíncrono. Chamar este endpoint apenas inicia o processo de validação. Os resultados de retorno desta chamada indicam apenas se o processo de validação foi iniciado, não os resultados da validação em si. Para descobrir se o snapshot foi validado, use a API da tabela para localizar o snapshot e verificar seu status de validação.  
Nota:  
Você não pode validar um snapshot publicado.

### Formato da URL

URL com controle de versões: /api/sn_cdm/{api_version}/snapshots/{snapshot_id}/validate

URL padrão: /api/sn_cdm/snapshots/{snapshot_id}/validate

### Parâmetros de solicitação compatíveis

{#snapshot-POST-validate__entry__2}{#snapshot-POST-validate__version-RESTAPI}

| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| snapshot_id | Sys_id do registro de snapshot a ser processado. Localizado na tabela Snapshot do CDM \[sn_cdm_snapshot\]. Tipo de dados: cadeia de caracteres |
[Tabela 13. Parâmetros de caminho]

{#snapshot-POST-validate__entry__8}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 14. Parâmetros de consulta]

{#snapshot-POST-validate__entry__12}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 15. Parâmetros do corpo da solicitação (XML ou JSON)]

### Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#snapshot-POST-validate__entry__16}{#snapshot-POST-validate__accept-JSON-only-entry-RESTAPI}{#snapshot-POST-validate__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 16. Cabeçalhos da solicitação]

{#snapshot-POST-validate__entry__22}

| 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.").
{#snapshot-POST-validate__entry__26}{#snapshot-POST-validate__entry-200-status-code}{#snapshot-POST-validate__entry-400-status-code}{#snapshot-POST-validate__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 snapshot especificado já está publicado ou não pode ser localizado. |
| 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 (JSON ou XML)

{#snapshot-POST-validate__entry__34}

| Nome | Descrição |
|-|-|
| 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 de erro da solicitação. Valores possíveis: falha Tipo de dados: cadeia de caracteres |
[ ]

### Solicitação de cURL

O exemplo a seguir mostra como validar o snapshot com o sys_id de 3a168d9dc342301054c1582e1340dd68.

    curl "http://instance.servicenow.com/api/sn_cdm/snapshots/3a168d9dc342301054c1582e1340dd68/validate"\ 
    --request POST \ 
    --header "Accept:application/json" \ 
    --header "Content-Type:application/json" \
    --user 'username':'password' 

O seguinte mostra uma resposta de sucesso e falha para a solicitação de validação.

    // Example of a successful response
    { 
      "" 
    }

    // Example of an error response
    {
      "error": {
        "message": "Invalid Snapshot id:test",
        "detail": ""
      },
      "status": "failure"
    }

## CdmSnapshotApi -- PUT /sn_cdm/snapshots/publish {#ariaid-title5}

Publica um snapshot não publicado especificado.
Antes que um snapshot possa ser publicado, ele deve ser validado. Você pode usar o endpoint [CdmSnapshotApi -- PUT /sn_cdm/snapshots/validate](https://servicenow-prod.fluidtopics.net/qEjxg8XUnd37tmDuniFPsA#snapshot-PUT-validate "Valida um snapshot não publicado especificado em relação às políticas mapeadas.") para validar snapshots ou fazer com que eles sejam validados automaticamente ao fazer uma confirmação. Um implantável deve estar conectado a um serviço para publicar seus snapshots. Além disso, se o snapshot já tiver sido publicado, a solicitação falhará.

O solicitante deste endpoint deve ter a função de Editor do CDM.

### Formato da URL

URL com controle de versão: /api/sn_cdm/{api_version}/snapshots/publish

URL padrão: /api/sn_cdm/snapshots/publish

### Parâmetros de solicitação compatíveis

{#snapshot-PUT-publish__entry__2}{#snapshot-PUT-publish__version-RESTAPI}

| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
[Tabela 19. Parâmetros de caminho]

{#snapshot-PUT-publish__id_evn_23g_15b__entry__2}{#snapshot-PUT-publish__cdm_apps-returnFields-entry}

| Nome | Descrição |
|-|-|
| appName | Obrigatório. Nome da aplicação Gestão de dados de configuração (CDM) para a qual o snapshot será criado. Localizado na tabela Aplicação de CDM \[sn_cdm_application\]. Tipo de dados: cadeia de caracteres |
| implantávelNome | Obrigatório. Nome do implantável do CDM para o qual o snapshot será criado. Localizado na tabela CDM implantável \[sn_cdm_deployable\]. Tipo de dados: cadeia de caracteres |
| nome | Obrigatório. Nome do snapshot. Localizado na tabela Snapshot do CDM \[sn_cdm_snapshot\]. 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 20. Parâmetros de consulta]

{#snapshot-PUT-publish__id_evn_23g_15b} {#snapshot-PUT-publish__entry__16}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 21. 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.").
{#snapshot-PUT-publish__entry__20}{#snapshot-PUT-publish__accept-JSON-only-entry-RESTAPI}{#snapshot-PUT-publish__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 22. Cabeçalhos da solicitação]

{#snapshot-PUT-publish__entry__26}

| 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.").
{#snapshot-PUT-publish__entry__30}{#snapshot-PUT-publish__entry-200-status-code}{#snapshot-PUT-publish__entry-400-status-code}{#snapshot-PUT-publish__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

{#snapshot-PUT-publish__id_lrr_frg_15b__entry__2}

| Nome | Descrição |
|-|-|
| cdm_application_id | Detalhes sobre a aplicação de CDM associada ao snapshot. Tipo de dados: objeto "cdm_application_id": { "link": "String", "value": "String" } |
| cdm_id_da_aplicação.link | Chamada para usar para acessar o registro da aplicação CDM usando a REST Table API. Tipo de dados: cadeia de caracteres |
| cdm_id_da_aplicação.valor | 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_deployable_id | Detalhes sobre o implantável do CDM associado ao snapshot. Tipo de dados: objeto "cdm_deployable_id": { "link": "String", "value": "String" } |
| cdm_deployable_id.link | Sintaxe de chamada para consultar este registro implantável usando a REST API de tabela. Tipo de dados: cadeia de caracteres |
| cdm_deployable_id.value | Sys_id do registro implantável. Localizado na tabela CDM implantável \[sn_cdm_deployable\]. Tipo de dados: cadeia de caracteres |
| changeset_id | Detalhes sobre o changeset associado ao snapshot. Tipo de dados: objeto "changeset_id": { "link": "String", "value": "String" } |
| changeset_id.link | Sintaxe de chamada para consultar este registro de changeset usando a API REST de tabela. Tipo de dados: cadeia de caracteres |
| changeset_id.valor | Identificador exclusivo do registro do changeset. Localizado na tabela CDM Changeset \[sn_cdm_changeset\]. Tipo de dados: cadeia de caracteres |
| descrição | Breve descrição do snapshot. 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_published | Data e hora em que o snapshot foi publicado pela última vez. Tipo de dados: cadeia de caracteres Formato: aaaa-mm-dd hh:mm:ss |
| last_validated | Data e hora em que o snapshot foi validado pela última vez. Tipo de dados: cadeia de caracteres Formato: aaaa-mm-dd hh:mm:ss |
| nome | Nome do snapshot. Tipo de dados: cadeia de caracteres |
| número | Número exclusivo que identifica o snapshot. Este valor fornece um identificador legível para o mapeamento. Tipo de dados: cadeia de caracteres |
| publicado | Sinalizador que indica se o snapshot foi publicado. Valores possíveis: * verdadeiro: o snapshot foi publicado. * falso: o snapshot não foi publicado. Tipo de dados: booliano |
| sys_created_by | Nome do usuário que criou o snapshot. Tipo de dados: cadeia de caracteres |
| sys_created_on | Data e hora em que o snapshot foi criado. Tipo de dados: cadeia de caracteres Formato: aaaa-mm-dd hh:mm:ss |
| sys_id | Sys_id do snapshot. Localizado na tabela Snapshot do CDM \[sn_cdm_snapshot\]. Tipo de dados: cadeia de caracteres |
| sys_updated_by | Nome do usuário que atualizou o snapshot. Tipo de dados: cadeia de caracteres |
| sys_updated_on | Data e hora em que o snapshot foi atualizado pela última vez. Tipo de dados: cadeia de caracteres Formato: aaaa-mm-dd hh:mm:ss |
| validação | Estado de validação atual do snapshot. Valores possíveis: * Execução_erro * falha * em_andamento * not_validated * aprovado * passou_com_exceção * solicitado Tipo de dados: cadeia de caracteres |
[ ]

{#snapshot-PUT-publish__id_lrr_frg_15b}  

### Solicitação de cURL

Este exemplo de código mostra como publicar um snapshot.

    curl "http://instance.servicenow.com/api/sn_cdm/snapshots/publish?deployableName=Development_1&name=Development_1-v1.dpl&appName=testApp" \ 
    --request PUT \ 
    --header "Accept:application/json" \ 
    --user 'username':'password'

Retornar resultados:

     
    { 
      "result": { 
        "changeset_id": { 
          "value": "d4b9446e53001110a1d3ddeeff7b126c", 
          "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/d4b9446e53001110a1d3ddeeff7b126c" 
        }, 
        "cdm_deployable_id": { 
          "value": "6dc517a953b70110a1d3ddeeff7b129b", 
          "link": "http://instance.servicenow.com/api/now/table/sn_cdm_deployable/6dc517a953b70110a1d3ddeeff7b129b" 
        }, 
        "description": null, 
        "cdm_application_id": { 
          "value": "62b517a953b70110a1d3ddeeff7b128c", 
          "link": "http://instance.servicenow.com/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" 
        }, 
        "published": true, 
        "sys_updated_on": "2022-06-30 12:57:02", 
        "last_published": "2022-06-30 12:57:02", 
        "number": "SNAP0001002", 
        "sys_id": "9017fc2e53801110a1d3ddeeff7b12d7", 
        "sys_updated_by": "admin", 
        "sys_created_on": "2022-06-15 14:19:38", 
        "name": "Development_1-v2.dpl", 
        "last_validated": "2022-06-30 12:56:07", 
        "validation": "passed", 
        "sys_created_by": "admin" 
      } 
    }

## CdmSnapshotApi -- PUT /sn_cdm/snapshots/unpublish {#ariaid-title6}

Cancela a publicação de um snapshot publicado anteriormente.
<br />

### Formato da URL

URL com controle de versão: /api/sn_cdm/{api_version}/snapshots/unpublish

URL padrão: /api/sn_cdm/snapshots/unpublish

### Parâmetros de solicitação compatíveis

{#snapshot-PUT-unpublish__entry__2}{#snapshot-PUT-unpublish__version-RESTAPI}

| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. 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]

{#snapshot-PUT-unpublish__entry__6}{#snapshot-PUT-unpublish__cdm_apps-returnFields-entry}

| Nome | Descrição |
|-|-|
| appName | Obrigatório. Nome da aplicação Gestão de dados de configuração (CDM) para a qual o snapshot será criado. Localizado na tabela Aplicação de CDM \[sn_cdm_application\]. Tipo de dados: cadeia de caracteres |
| implantávelNome | Obrigatório. Nome do implantável do CDM para o qual o snapshot será criado. Localizado na tabela CDM implantável \[sn_cdm_deployable\]. Tipo de dados: cadeia de caracteres |
| nome | Obrigatório. Nome do snapshot. Localizado na tabela Snapshot do CDM \[sn_cdm_snapshot\]. 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]

{#snapshot-PUT-unpublish__entry__16}

| 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.").
{#snapshot-PUT-unpublish__entry__20}{#snapshot-PUT-unpublish__accept-JSON-only-entry-RESTAPI}{#snapshot-PUT-unpublish__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 28. Cabeçalhos da solicitação]

{#snapshot-PUT-unpublish__entry__26}

| 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.").
{#snapshot-PUT-unpublish__entry__30}{#snapshot-PUT-unpublish__entry-200-status-code}{#snapshot-PUT-unpublish__entry-400-status-code}{#snapshot-PUT-unpublish__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

{#snapshot-PUT-unpublish__entry__38}

| Nome | Descrição |
|-|-|
| cdm_application_id | Detalhes sobre a aplicação de CDM associada ao snapshot. Tipo de dados: objeto "cdm_application_id": { "link": "String", "value": "String" } |
| cdm_id_da_aplicação.link | Chamada para usar para acessar o registro da aplicação CDM usando a REST Table API. Tipo de dados: cadeia de caracteres |
| cdm_id_da_aplicação.valor | 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_deployable_id | Detalhes sobre o implantável do CDM associado ao snapshot. Tipo de dados: objeto "cdm_deployable_id": { "link": "String", "value": "String" } |
| cdm_deployable_id.link | Sintaxe de chamada para consultar este registro implantável usando a REST API de tabela. Tipo de dados: cadeia de caracteres |
| cdm_deployable_id.value | Sys_id do registro implantável. Localizado na tabela CDM implantável \[sn_cdm_deployable\]. Tipo de dados: cadeia de caracteres |
| changeset_id | Detalhes sobre o changeset associado ao snapshot. Tipo de dados: objeto "changeset_id": { "link": "String", "value": "String" } |
| changeset_id.link | Sintaxe de chamada para consultar este registro de changeset usando a API REST de tabela. Tipo de dados: cadeia de caracteres |
| changeset_id.valor | Identificador exclusivo do registro do changeset. Localizado na tabela CDM Changeset \[sn_cdm_changeset\]. Tipo de dados: cadeia de caracteres |
| descrição | Breve descrição do snapshot. 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_published | Data e hora em que o snapshot foi publicado pela última vez. Tipo de dados: cadeia de caracteres Formato: aaaa-mm-dd hh:mm:ss |
| last_validated | Data e hora em que o snapshot foi validado pela última vez. Tipo de dados: cadeia de caracteres Formato: aaaa-mm-dd hh:mm:ss |
| nome | Nome do snapshot. Tipo de dados: cadeia de caracteres |
| número | Número exclusivo que identifica o snapshot. Este valor fornece um identificador legível para o mapeamento. Tipo de dados: cadeia de caracteres |
| publicado | Sinalizador que indica se o snapshot foi publicado. Valores possíveis: * verdadeiro: o snapshot foi publicado. * falso: o snapshot não foi publicado. Tipo de dados: booliano |
| sys_created_by | Nome do usuário que criou o snapshot. Tipo de dados: cadeia de caracteres |
| sys_created_on | Data e hora em que o snapshot foi criado. Tipo de dados: cadeia de caracteres Formato: aaaa-mm-dd hh:mm:ss |
| sys_id | Sys_id do snapshot. Localizado na tabela Snapshot do CDM \[sn_cdm_snapshot\]. Tipo de dados: cadeia de caracteres |
| sys_updated_by | Nome do usuário que atualizou o snapshot. Tipo de dados: cadeia de caracteres |
| sys_updated_on | Data e hora em que o snapshot foi atualizado pela última vez. Tipo de dados: cadeia de caracteres Formato: aaaa-mm-dd hh:mm:ss |
| validação | Estado de validação atual do snapshot. Valores possíveis: * Execução_erro * falha * em_andamento * not_validated * aprovado * passou_com_exceção * solicitado Tipo de dados: cadeia de caracteres |
[ ]

### Solicitação de cURL

Este exemplo de código mostra como cancelar a publicação de um snapshot.

```

```

Retornar resultados:

```

```

## CdmSnapshotApi -- PUT /sn_cdm/snapshots/validate {#ariaid-title7}

Valida um snapshot não publicado especificado em relação às políticas mapeadas.
A validação é realizada como um processo assíncrono. Chamar este endpoint apenas inicia o processo de validação. Os resultados de retorno desta chamada indicam apenas se o processo de validação foi iniciado, não os resultados da validação em si. Para descobrir se o snapshot foi validado, use a API da tabela para localizar o snapshot e verificar seu status de validação.  
Nota:  
Você não pode validar um snapshot publicado.

O solicitante deste endpoint deve ter a função de Editor do CDM.

### Formato da URL

URL com controle de versões: /api/sn_cdm/{api_version}/snapshots/validate

URL padrão: /api/sn_cdm/snapshots/validate

### Parâmetros de solicitação compatíveis

{#snapshot-PUT-validate__entry__2}{#snapshot-PUT-validate__version-RESTAPI}

| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. 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]

{#snapshot-PUT-validate__id_x2b_qvg_15b__entry__2}{#snapshot-PUT-validate__cdm_apps-returnFields-entry}

| Nome | Descrição |
|-|-|
| appName | Obrigatório. Nome da aplicação Gestão de dados de configuração (CDM) para a qual o snapshot será criado. Localizado na tabela Aplicação de CDM \[sn_cdm_application\]. Tipo de dados: cadeia de caracteres |
| implantávelNome | Obrigatório. Nome do implantável do CDM para o qual o snapshot será criado. Localizado na tabela CDM implantável \[sn_cdm_deployable\]. Tipo de dados: cadeia de caracteres |
| nome | Obrigatório. Nome do snapshot. Localizado na tabela Snapshot do CDM \[sn_cdm_snapshot\]. 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]

{#snapshot-PUT-validate__id_x2b_qvg_15b} {#snapshot-PUT-validate__entry__16}

| 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.").
{#snapshot-PUT-validate__entry__20}{#snapshot-PUT-validate__accept-JSON-only-entry-RESTAPI}{#snapshot-PUT-validate__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 34. Cabeçalhos da solicitação]

{#snapshot-PUT-validate__entry__26}

| 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.").
{#snapshot-PUT-validate__entry__30}{#snapshot-PUT-validate__entry-200-status-code}{#snapshot-PUT-validate__entry-400-status-code}{#snapshot-PUT-validate__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 snapshot especificado já está publicado ou não pode ser localizado. |
| 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

{#snapshot-PUT-validate__id_dsl_5vg_15b__entry__2}

| Nome | Descrição |
|-|-|
| cdm_application_id | Detalhes sobre a aplicação de CDM associada ao snapshot. Tipo de dados: objeto "cdm_application_id": { "link": "String", "value": "String" } |
| cdm_id_da_aplicação.link | Chamada para usar para acessar o registro da aplicação CDM usando a REST Table API. Tipo de dados: cadeia de caracteres |
| cdm_id_da_aplicação.valor | 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_deployable_id | Detalhes sobre o implantável do CDM associado ao snapshot. Tipo de dados: objeto "cdm_deployable_id": { "link": "String", "value": "String" } |
| cdm_deployable_id.link | Sintaxe de chamada para consultar este registro implantável usando a REST API de tabela. Tipo de dados: cadeia de caracteres |
| cdm_deployable_id.value | Sys_id do registro implantável. Localizado na tabela CDM implantável \[sn_cdm_deployable\]. Tipo de dados: cadeia de caracteres |
| changeset_id | Detalhes sobre o changeset associado ao snapshot. Tipo de dados: objeto "changeset_id": { "link": "String", "value": "String" } |
| changeset_id.link | Sintaxe de chamada para consultar este registro de changeset usando a API REST de tabela. Tipo de dados: cadeia de caracteres |
| changeset_id.valor | Identificador exclusivo do registro do changeset. Localizado na tabela CDM Changeset \[sn_cdm_changeset\]. Tipo de dados: cadeia de caracteres |
| descrição | Breve descrição do snapshot. 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_published | Data e hora em que o snapshot foi publicado pela última vez. Tipo de dados: cadeia de caracteres Formato: aaaa-mm-dd hh:mm:ss |
| last_validated | Data e hora em que o snapshot foi validado pela última vez. Tipo de dados: cadeia de caracteres Formato: aaaa-mm-dd hh:mm:ss |
| nome | Nome do snapshot. Tipo de dados: cadeia de caracteres |
| número | Número exclusivo que identifica o snapshot. Este valor fornece um identificador legível para o mapeamento. Tipo de dados: cadeia de caracteres |
| publicado | Sinalizador que indica se o snapshot foi publicado. Valores possíveis: * verdadeiro: o snapshot foi publicado. * falso: o snapshot não foi publicado. Tipo de dados: booliano |
| sys_created_by | Nome do usuário que criou o snapshot. Tipo de dados: cadeia de caracteres |
| sys_created_on | Data e hora em que o snapshot foi criado. Tipo de dados: cadeia de caracteres Formato: aaaa-mm-dd hh:mm:ss |
| sys_id | Sys_id do snapshot. Localizado na tabela Snapshot do CDM \[sn_cdm_snapshot\]. Tipo de dados: cadeia de caracteres |
| sys_updated_by | Nome do usuário que atualizou o snapshot. Tipo de dados: cadeia de caracteres |
| sys_updated_on | Data e hora em que o snapshot foi atualizado pela última vez. Tipo de dados: cadeia de caracteres Formato: aaaa-mm-dd hh:mm:ss |
| validação | Estado de validação atual do snapshot. Valores possíveis: * Execução_erro * falha * em_andamento * not_validated * aprovado * passou_com_exceção * solicitado Tipo de dados: cadeia de caracteres |
[ ]

{#snapshot-PUT-validate__id_dsl_5vg_15b}  

### Solicitação de cURL

Este exemplo de código mostra como validar um snapshot.

    curl "http://instance.servicenow.com/api/sn_cdm/snapshots/validate?name=Development_1-v2.dpl&deployableName=Development_1&appName=testApp" \ 
    --request PUT \ 
    --header "Accept:application/json" \ 
    --user 'username':'password' 

Retornar resultados:

    { 
      "result": { 
        "changeset_id": { 
          "value": "d4b9446e53001110a1d3ddeeff7b126c", 
          "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/d4b9446e53001110a1d3ddeeff7b126c" 
        }, 
        "cdm_deployable_id": { 
          "value": "6dc517a953b70110a1d3ddeeff7b129b", 
          "link": "http://instance.servicenow.com/api/now/table/sn_cdm_deployable/6dc517a953b70110a1d3ddeeff7b129b" 
        }, 
        "description": null, 
        "cdm_application_id": { 
          "value": "62b517a953b70110a1d3ddeeff7b128c", 
          "link": "http://instance.servicenow.com/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" 
        }, 
        "published": false, 
        "sys_updated_on": "2022-06-30 12:57:02", 
        "last_published": "2022-06-30 12:57:02", 
        "number": "SNAP0001002", 
        "sys_id": "9017fc2e53801110a1d3ddeeff7b12d7", 
        "sys_updated_by": "admin", 
        "sys_created_on": "2022-06-15 14:19:38", 
        "name": "Development_1-v2.dpl", 
        "last_validated": "2022-06-30 12:56:07", 
        "validation": "passed", 
        "sys_created_by": "admin" 
      } 
    }