CdmSnapshotApi

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.

CdmSnapshotAPI – POST /sn_cdm/snapshots/{snapshot_id}/publish

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

Tabela 1. Parâmetros de caminho

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
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 2. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 3. Parâmetros do corpo da solicitação (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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 6. Códigos de status

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.

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

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

Tabela 7. Parâmetros de caminho

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
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 8. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 9. Parâmetros do corpo da solicitação (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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 12. Códigos de status

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.

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

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

Tabela 13. Parâmetros de caminho

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
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 14. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 15. Parâmetros do corpo da solicitação (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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 18. Códigos de status

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.

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

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

Tabela 19. Parâmetros de caminho

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 20. Parâmetros de consulta

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 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 24. Códigos de status

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.

Parâmetros do corpo da resposta

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

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

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

Tabela 25. Parâmetros de caminho

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 26. Parâmetros de consulta

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 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 30. Códigos de status

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.

Parâmetros do corpo da resposta

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

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

Tabela 31. Parâmetros de caminho

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 32. Parâmetros de consulta

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 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 36. Códigos de status

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.

Parâmetros do corpo da resposta

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