CdmSnapshotApi

. CdmSnapshotApi fornece endpoints que permitem publicar, cancelar a publicação e revalidar snapshots no Gestão de dados de configuração(CDM).

Você publica um snapshot para que ele possa ser exportado, habilitando o. Integração e entrega contínuas (CICD) pipeline para acessar e usar os dados de configuração associados. Os exportadores só podem executar em snapshots publicados. Quando os snapshots não são mais necessários, você pode 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 com script (sn_cdm.cdm.viewer)
• ACL do Editor de CDM REST com script (sn_cdm.cdm_editor)

. Gestão de dados de configuração(CDM) plug-in deve ser ativado para que esta API esteja disponível em uma instância.

Para obter informações adicionais sobre snapshots, consulte Exibir snapshots .

CdmSnapshotAPI - POST /sn_cdm/snapshots/

Publica um snapshot não publicado especificado.

Um snapshot pode ser publicado, ele deve ser validado. Você pode usar CdmSnapshotAPI - POST /sn_cdm/snapshots/ endpoint para validar snapshots ou tê-los validados automaticamente quando você faz uma confirmação. Um implantável deve ser conectado a um serviço para publicar seus snapshots. Se o snapshot já tiver sido publicado, a solicitação falhará.

Formato de URL

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

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

Nota:

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

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres
snapshot_id	Sys_id do registro de snapshot a ser processado. Tipo de dados: Cadeia de caracteres Tabela: Snapshot do CDM [sn_cdm_snapshot]

Tabela 2. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

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

Nome	Descrição
Nenhum(a)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

Tabela 4. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. 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 5. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 6. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

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

Nome	Descrição
erro	Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: Objeto "error": { "detail": "String", "message": "String" }
error.detail	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' 

A seguir 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/

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

Formato de URL

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

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

Nota:

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

Parâmetros de solicitação compatíveis

Tabela 7. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres
snapshot_id	Sys_id do registro de snapshot a ser processado. Tipo de dados: Cadeia de caracteres Tabela: Snapshot do CDM [sn_cdm_snapshot]

Tabela 8. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

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

Nome	Descrição
Nenhum(a)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

Tabela 10. Cabeçalhos da solicitação

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 11. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 12. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

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

Nome	Descrição
erro	Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: Objeto "error": { "detail": "String", "message": "String" }
error.detail	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' 

A seguir mostra uma resposta de sucesso e falha para a 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/

Valida um snapshot não publicado especificado.

A validação é realizada como um processo assíncrono. Chamar este endpoint só 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 Tabela API para localizar o snapshot e verificar seu status de validação.

Nota:

Não é possível validar um snapshot publicado.

Formato de URL

URL com controle de versão: /api/sn_cdm/api/snapshots/snapshot_id/validate

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

Nota:

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

Parâmetros de solicitação compatíveis

Tabela 13. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres
snapshot_id	Sys_id do registro de snapshot a ser processado. Tipo de dados: Cadeia de caracteres Tabela: Snapshot do CDM [sn_cdm_snapshot]

Tabela 14. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

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

Nome	Descrição
Nenhum(a)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

Tabela 16. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. 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 17. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 18. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
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.

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

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" }
error.detail	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' 

A seguir mostra uma resposta de sucesso e falha para a solicitação Validar.

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

Publica um snapshot não publicado especificado.

Um snapshot pode ser publicado, ele deve ser validado. Você pode usar CdmSnapshotApi - PUT /sn_cdm/snapshots/validate endpoint para validar snapshots ou tê-los validados automaticamente quando você faz uma confirmação. Um implantável deve ser conectado a um serviço para publicar seus snapshots. 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 de URL

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

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

Nota:

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

Parâmetros de solicitação compatíveis

Tabela 19. Parâmetros de caminho

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

Tabela 20. Parâmetros de consulta

Nome	Descrição
appName	Obrigatório. Nome do Gestão de dados de configuração(CDM) aplicação para a qual o snapshot será criado. Tipo de dados: Cadeia de caracteres Tabela: Aplicação CDM [sn_cdm_application]
DeployableName	Obrigatório. Nome do CDM implantável para o qual o snapshot será criado. Tipo de dados: Cadeia de caracteres Tabela: CDM implantável [sn_cdm_deployable]
nome	Obrigatório. Nome do snapshot. Tipo de dados: Cadeia de caracteres Tabela: Snapshot do CDM [sn_cdm_snapshot]
returnFields	Lista de campos a serem retornados como parte da resposta. Passe os nomes das colunas de registro, como sys_id, sys_updated_by ou state. Tipo de dados: Matriz Padrão: Todos os campos conforme determinado pelo endpoint

Tabela 21. Parâmetros do corpo da solicitação

Nome	Descrição
Nenhum(a)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

Tabela 22. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. 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 23. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 24. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta

Nome	Descrição
cdm_application_id	Detalhes sobre a aplicação CDM associada ao snapshot. Tipo de dados: Objeto "cdm_application_id": { "link": "String", "value": "String" }
cdm_application_id.link	Chamada a ser usada para acessar o registro da aplicação CDM usando o REST Tabela API. Tipo de dados: Cadeia de caracteres
cdm_application_id.value	Sys_id do registro da aplicação CDM associado. Tipo de dados: Cadeia de caracteres Tabela: Aplicação CDM [sn_cdm_application]
cdm_deployable_id	Detalhes sobre o CDM implantável 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 Tabela REST API. Tipo de dados: Cadeia de caracteres
cdm_deployable_id.value	Sys_id do registro implantável. Tipo de dados: Cadeia de caracteres Tabela: CDM implantável [sn_cdm_deployable]
changeset_id	Detalhes sobre o conjunto de mudanças associado ao snapshot. Tipo de dados: Objeto "changeset_id": { "link": "String", "value": "String" }
changeset_id.link	Sintaxe de chamada para consultar este registro do conjunto de mudanças usando Tabela REST API. Tipo de dados: Cadeia de caracteres
changeset_id.value	Identificador exclusivo do registro do conjunto de mudanças. Tipo de dados: Cadeia de caracteres Tabela: Conjunto de mudanças do CDM [sn_cdm_changeset]
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" }
error.detail	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. Tipo de dados: Cadeia de caracteres Tabela: Snapshot do CDM [sn_cdm_snapshot]
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: execution_error Falha(s) in_progress not_validated aprovado passed_with_exception solicitado Tipo de dados: Cadeia de caracteres

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'

Resultados de retorno:

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

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

Formato de URL

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

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

Nota:

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

Parâmetros de solicitação compatíveis

Tabela 25. Parâmetros de caminho

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

Tabela 26. Parâmetros de consulta

Nome	Descrição
appName	Obrigatório. Nome do Gestão de dados de configuração(CDM) aplicação para a qual o snapshot será criado. Tipo de dados: Cadeia de caracteres Tabela: Aplicação CDM [sn_cdm_application]
DeployableName	Obrigatório. Nome do CDM implantável para o qual o snapshot será criado. Tipo de dados: Cadeia de caracteres Tabela: CDM implantável [sn_cdm_deployable]
nome	Obrigatório. Nome do snapshot. Tipo de dados: Cadeia de caracteres Tabela: Snapshot do CDM [sn_cdm_snapshot]
returnFields	Lista de campos a serem retornados como parte da resposta. Passe os nomes das colunas de registro, como sys_id, sys_updated_by ou state. Tipo de dados: Matriz Padrão: Todos os campos conforme determinado pelo endpoint

Tabela 27. Parâmetros do corpo da solicitação

Nome	Descrição
Nenhum(a)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

Tabela 28. Cabeçalhos da solicitação

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 29. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 30. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta

Nome	Descrição
cdm_application_id	Detalhes sobre a aplicação CDM associada ao snapshot. Tipo de dados: Objeto "cdm_application_id": { "link": "String", "value": "String" }
cdm_application_id.link	Chamada a ser usada para acessar o registro da aplicação CDM usando o REST Tabela API. Tipo de dados: Cadeia de caracteres
cdm_application_id.value	Sys_id do registro da aplicação CDM associado. Tipo de dados: Cadeia de caracteres Tabela: Aplicação CDM [sn_cdm_application]
cdm_deployable_id	Detalhes sobre o CDM implantável 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 Tabela REST API. Tipo de dados: Cadeia de caracteres
cdm_deployable_id.value	Sys_id do registro implantável. Tipo de dados: Cadeia de caracteres Tabela: CDM implantável [sn_cdm_deployable]
changeset_id	Detalhes sobre o conjunto de mudanças associado ao snapshot. Tipo de dados: Objeto "changeset_id": { "link": "String", "value": "String" }
changeset_id.link	Sintaxe de chamada para consultar este registro do conjunto de mudanças usando Tabela REST API. Tipo de dados: Cadeia de caracteres
changeset_id.value	Identificador exclusivo do registro do conjunto de mudanças. Tipo de dados: Cadeia de caracteres Tabela: Conjunto de mudanças do CDM [sn_cdm_changeset]
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" }
error.detail	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. Tipo de dados: Cadeia de caracteres Tabela: Snapshot do CDM [sn_cdm_snapshot]
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: execution_error Falha(s) in_progress not_validated aprovado passed_with_exception 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.

Resultados de retorno:

CdmSnapshotApi - PUT /sn_cdm/snapshots/validate

Valida um snapshot não publicado especificado em relação a suas políticas mapeadas.

A validação é realizada como um processo assíncrono. Chamar este endpoint só 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 Tabela API para localizar o snapshot e verificar seu status de validação.

Nota:

Não é possível validar um snapshot publicado.

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

Formato de URL

URL com controle de versão: /api/sn_cdm//snapshots/validate

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

Nota:

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

Parâmetros de solicitação compatíveis

Tabela 31. Parâmetros de caminho

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

Tabela 32. Parâmetros de consulta

Nome	Descrição
appName	Obrigatório. Nome do Gestão de dados de configuração(CDM) aplicação para a qual o snapshot será criado. Tipo de dados: Cadeia de caracteres Tabela: Aplicação CDM [sn_cdm_application]
DeployableName	Obrigatório. Nome do CDM implantável para o qual o snapshot será criado. Tipo de dados: Cadeia de caracteres Tabela: CDM implantável [sn_cdm_deployable]
nome	Obrigatório. Nome do snapshot. Tipo de dados: Cadeia de caracteres Tabela: Snapshot do CDM [sn_cdm_snapshot]
returnFields	Lista de campos a serem retornados como parte da resposta. Passe os nomes das colunas de registro, como sys_id, sys_updated_by ou state. Tipo de dados: Matriz Padrão: Todos os campos conforme determinado pelo endpoint

Tabela 33. Parâmetros do corpo da solicitação

Nome	Descrição
Nenhum(a)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

Tabela 34. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. 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 35. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 36. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
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.

Parâmetros do corpo da resposta

Nome	Descrição
cdm_application_id	Detalhes sobre a aplicação CDM associada ao snapshot. Tipo de dados: Objeto "cdm_application_id": { "link": "String", "value": "String" }
cdm_application_id.link	Chamada a ser usada para acessar o registro da aplicação CDM usando o REST Tabela API. Tipo de dados: Cadeia de caracteres
cdm_application_id.value	Sys_id do registro da aplicação CDM associado. Tipo de dados: Cadeia de caracteres Tabela: Aplicação CDM [sn_cdm_application]
cdm_deployable_id	Detalhes sobre o CDM implantável 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 Tabela REST API. Tipo de dados: Cadeia de caracteres
cdm_deployable_id.value	Sys_id do registro implantável. Tipo de dados: Cadeia de caracteres Tabela: CDM implantável [sn_cdm_deployable]
changeset_id	Detalhes sobre o conjunto de mudanças associado ao snapshot. Tipo de dados: Objeto "changeset_id": { "link": "String", "value": "String" }
changeset_id.link	Sintaxe de chamada para consultar este registro do conjunto de mudanças usando Tabela REST API. Tipo de dados: Cadeia de caracteres
changeset_id.value	Identificador exclusivo do registro do conjunto de mudanças. Tipo de dados: Cadeia de caracteres Tabela: Conjunto de mudanças do CDM [sn_cdm_changeset]
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" }
error.detail	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. Tipo de dados: Cadeia de caracteres Tabela: Snapshot do CDM [sn_cdm_snapshot]
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: execution_error Falha(s) in_progress not_validated aprovado passed_with_exception solicitado Tipo de dados: Cadeia de caracteres

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' 

Resultados de retorno:

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