CdmChangesetsApi

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 39 min. de leitura

    • . CdmChangesetsApi fornece endpoints que permitem gerenciar conjuntos de mudanças.

    Usando esses endpoints, você pode:
    • Criar novos conjuntos de mudanças.
    • Implantar conjuntos de mudanças.
    • Recupere listas de ou conjuntos de mudanças individuais.
    • Recupera as mudanças de nó em um conjunto de mudanças.
    • Recupere uma lista de aplicações ou implantáveis que são afetados por um conjunto de mudanças.
    • Excluir conjuntos de mudanças.
    • Retorna uma lista de componentes compartilhados que estão associados a um conjunto de mudanças especificado.

    Os endpoints Criar conjuntos de mudanças usam uma implementação de enfileiramento assíncrona. Com esse tipo de implementação, você chama primeiro o endpoint de solicitação Criar conjunto de mudanças. Este endpoint fila sua solicitação e retorna um identificador de confirmação. Em seguida, você usa este identificador de confirmação para chamar o endpoint de status apropriado para obter o status da solicitação de criação.

    Você deve ter uma das seguintes funções para acessar esta API:
    • ACL de exibição do CDM REST 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 conjuntos de mudanças, consulte Conjuntos de mudanças e controle de versão no CDM .

    CdmChangesetsApi - EXCLUI /sn_cdm/changesets

    Exclui um conjunto de mudanças especificado.

    O solicitante deve ter a função de Editor do CDM para acessar este endpoint.

    Formato de URL

    URL com controle de versão: /api/sn_cdm//changesets

    URL padrão: /api/sn_cdm/changesets

    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
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    changesetNumber Obrigatório.
    Identificador exclusivo do conjunto de mudanças associado, como "Chset-10".

    Tipo de dados: Cadeia de caracteres

    Tabela: Conjunto de mudanças do CDM [sn_cdm_changeset]
    Tabela 3. 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 4. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. 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

    Nome Descrição
    Nenhum(a)

    Solicitação de curl

    O exemplo de código a seguir mostra como remover um conjunto de mudanças.

    curl "http://instance.servicenow.com/api/sn_cdm/changesets?changesetNumber=Chset-760" \ 
--request DELETE \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Para uma exclusão bem-sucedida do conjunto de mudanças, nenhuma resposta é retornada além do código de status HTTP.

    None - results defined by the HTTP status code

    CdmChangesetsApi - OBTER /sn_cdm/changesets

    Recupera todos os conjuntos de mudanças associados a um Gestão de dados de configuração(CDM) ou um registro de conjunto de mudanças especificado.

    Formato de URL

    URL com controle de versão: /api/sn_cdm//changesets

    URL padrão: /api/sn_cdm/changesets

    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
    Tabela 8. Parâmetros de consulta
    Nome Descrição
    appName Obrigatório. Nome da aplicação CDM cujos conjuntos de mudanças você deseja retornar. Esta deve ser uma aplicação ativa.

    Tipo de dados: Cadeia de caracteres

    Tabela: Aplicação CDM [sn_cdm_application]
    número Número do conjunto de mudanças.

    Se você passar este valor, somente o conjunto de mudanças especificado será retornado. Deve ser um conjunto de mudanças associado à aplicação CDM especificada no appNameparâmetro.

    Tipo de dados: Cadeia de caracteres

    Padrão: Nenhum - Retorna todos os conjuntos de mudanças associados à aplicação CDM ou aos especificados pelo stateparâmetro.

    Tabela: CDMChangeset [sn_cdm_changeset]
    estado Estado dos conjuntos de mudanças a serem retornados. Retorne somente os conjuntos de mudanças associados à aplicação CDM especificada para o estado especificado.

    Valores válidos:

    • Bloqueados
    • Verificando possíveis conflitos
    • Falha na confirmação
    • Confirmação em andamento
    • Confirmado
    • Aberto

    Tipo de dados: Cadeia de caracteres

    Padrão: Retorna todos os conjuntos de mudanças para todos os estados
    Tabela 9. 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 10. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. 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

    Nome Descrição
    auto_validate Sinalizador que indica se os conjuntos de mudanças criados na confirmação são validados.
    Valores válidos:
    • Verdadeiro: Valide os conjuntos de mudanças.
    • Falso: Não valide os conjuntos de mudanças.

    Tipo de dados: Booliano
    cdm_application Detalhes da aplicação CDM associada ao conjunto de mudanças.

    Tipo de dados: Objeto

    "cdm_application": {
  "link": "String",
  "value": "String"
}
    cdm_application.link Consulta a ser usada para chamar Tabela Endpoint REST para recuperar a aplicação CDM associada.

    Tipo de dados: Cadeia de caracteres
    cdm_application.value Sys_id da aplicação CDM associada.

    Tipo de dados: Cadeia de caracteres

    Tabela: Aplicação CDM [sn_cdm_application]
    committed_at Data e hora em que o conjunto de mudanças foi confirmado pela última vez.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss
    committed_by Detalhes sobre o usuário que confirmou o conjunto de mudanças.

    Tipo de dados: Objeto

    "committed_by": {
  "link": "String",
  "value": "String"
}
    committed_by.link Chamada para obter o registro do usuário que confirmou o conjunto de mudanças usando o REST Tabela API.

    Tipo de dados: Cadeia de caracteres
    committed_by.value Sys_id do usuário que confirmou o conjunto de mudanças.

    Tipo de dados: Cadeia de caracteres
    descrição Breve descrição da finalidade do conjunto de mudanças.

    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_conflict_detection_time Tempo desde a execução da última detecção de conflito. A detecção de conflitos é realizada sempre que um conjunto de mudanças é confirmado.

    Tipo de dados: Número

    Unidade: Milissegundos
    last_updated Data e hora em que uma mudança foi feita nos dados de configuração associados por meio deste conjunto de mudanças.

    Formato: AAAA-MM-DD hh:mm:ss

    Tipo de dados: Cadeia de caracteres
    número Número exclusivo do conjunto de mudanças.

    Tipo de dados: Cadeia de caracteres
    publish_option
    Opção de publicação para os snapshots configurados associados.
    Valores válidos:
    • Publish_none: Não publique snapshots.
    • Publish_valid: Publique somente os snapshots que passam na validação após a confirmação.

    Para obter informações adicionais sobre como publicar snapshots, consulte Publicar ou cancelar a publicação de um snapshot .

    Tipo de dados: Cadeia de caracteres

    Padrão: Publish_none
    estado Estado atual do conjunto de mudanças.

    Valores possíveis:

    • Bloqueados
    • Verificando possíveis conflitos
    • Falha na confirmação
    • Confirmação em andamento
    • Confirmado
    • Aberto

    Tipo de dados: Cadeia de caracteres
    sys_created_by Nome de usuário que criou o conjunto de mudanças. Por exemplo, able.tuter.

    Tipo de dados: Cadeia de caracteres
    sys_created_on Data e hora em que o conjunto de mudanças foi criado.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss
    sys_id Sys_id do conjunto de mudanças.

    Tipo de dados: Cadeia de caracteres

    Tabela: Conjunto de mudanças do CDM [sn_cdm_changeset]
    sys_updated_by Nome de usuário do usuário que atualizou o conjunto de mudanças pela última vez. Por exemplo, able.tuter.

    Tipo de dados: Cadeia de caracteres
    sys_updated_on Data e hora em que o conjunto de mudanças foi atualizado pela última vez.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss
    título Título do conjunto de mudanças.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    Este exemplo de código mostra como recuperar um conjunto de mudanças específico.

    curl "http://instance.servicenow.com/api/sn_cdm/changesets?appName=testApp&changesetNumber=Chset-946&state=committed" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Resultados de retorno:

    { 
  "result": [ 
    { 
      "description": "Auto generated for deletion of CDM Deployable Dep-12022-06-29 13:09:46", 
      "cdm_application": { 
        "value": "62b517a953b70110a1d3ddeeff7b128c", 
        "link": "http://instance.servicenow.com/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" 
      }, 
      "sys_updated_on": "2022-06-29 13:09:47", 
      "title": "Auto generated for deletion of CDM Deployable Dep-12022-06-29 13:09:46", 
      "number": "Chset-946", 
      "sys_id": "955d6c0f53141110a1d3ddeeff7b1233", 
      "sys_updated_by": "admin", 
      "committed_at": "2022-06-29 13:09:46", 
      "sys_created_on": "2022-06-29 13:09:46", 
      "committed_by": { 
        "value": "6816f79cc0a8016401c5a33be04be441", 
        "link": "http://instance.servicenow.com/api/now/table/sys_user/6816f79cc0a8016401c5a33be04be441" 
      }, 
      "state": "committed", 
      "auto_validate": true, 
      "publish_option": "publish_none", 
      "last_conflict_detection_time": "1656508187450", 
      "sys_created_by": "admin", 
      "last_updated": "2022-06-29 13:09:46" 
    } 
  ] 
}

    CdmChangesetsApi - OBTER /sn_cdm/changesets/activity

    Recupera as mudanças de nó em um conjunto de mudanças especificado.

    Formato de URL

    URL com controle de versão: /api/sn_cdm//changesets/activity

    URL padrão: /api/sn_cdm/changesets/activity

    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
    Tabela 14. Parâmetros de consulta
    Nome Descrição
    changesetNumber Obrigatório.
    Identificador exclusivo do conjunto de mudanças associado, como "Chset-10".

    Tipo de dados: Cadeia de caracteres

    Tabela: Conjunto de mudanças do CDM [sn_cdm_changeset]
    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 15. 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 16. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. 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. 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
    changeset_id Detalhes do conjunto de mudanças solicitado.

    Tipo de dados: Objeto

    "changeset_id": {
  "link": "String",
  "value": "String"
}
    changeset_id.link Consulta a ser usada para chamar Tabela Endpoint REST para recuperar o conjunto de mudanças associado.

    Tipo de dados: Cadeia de caracteres
    changeset_id.value Sys_id do conjunto de mudanças associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Conjunto de mudanças do CDM [sn_cdm_changeset]
    conflito Sinalizador que indica se há um conflito no conjunto de mudanças associado.
    Valores válidos:
    • Verdadeiro: Conflito detectado.
    • Falso: Nenhum conflito encontrado.

    Tipo de dados: Booliano
    criado(a) Data e hora em que o nó foi criado.

    Formato: AAAA-MM-DD hh:mm:ss

    Tipo de dados: Cadeia de caracteres
    created_by Nome de usuário que cria o nó. Por exemplo, able.tuter.

    Tipo de dados: Cadeia de caracteres
    erro Se ocorreu um erro durante o processamento, os detalhes sobre o erro.

    Tipo de dados: Objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    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
    name_path Nome do caminho do nó.

    Tipo de dados: Cadeia de caracteres
    new_name Nome atual do nó.

    Tipo de dados: Cadeia de caracteres
    new_value Valor atual do nó. Para nós folha e literais de matriz.

    Tipo de dados: Cadeia de caracteres
    old_name Nome anterior do nó.

    Tipo de dados: Cadeia de caracteres
    old_value Valor anterior do nó. Para nós folha e literais de matriz.

    Tipo de dados: Cadeia de caracteres
    atualizado Data e hora em que o nó foi atualizado pela última vez.

    Formato: AAAA-MM-DD hh:mm:ss

    Tipo de dados: Cadeia de caracteres
    updated_by Nome de usuário do usuário que atualizou o nó pela última vez. Por exemplo, able.tuter.

    Tipo de dados: Cadeia de caracteres
    seguro Sinalizador que indica se o nó folha associado foi protegido.
    Valores válidos:
    • Verdadeiro: O nó foi protegido.
    • Falso: O nó não foi protegido.

    Tipo de dados: Booliano
    tipo
    Tipo de nó.
    Valores possíveis:
    • sn_cdm_node_collection
    • sn_cdm_node_component
    • sn_cdm_node_folder
    • sn_cdm_node_cdi
    • sn_cdm_node_variable

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    Este exemplo de código mostra como recuperar as mudanças de nó para um conjunto de mudanças específico.

    curl "http://instance.servicenow.com/api/sn_cdm/changesets/activity?changesetNumber=Chset-783" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Resultados de retorno:

    { 
  "result": [ 
    { 
      "sys_id": "ed5d6c0f53141110a1d3ddeeff7b1233", 
      "changeset_id": "955d6c0f53141110a1d3ddeeff7b1233", 
      "new_value": null, 
      "new_state": "Deleted", 
      "new_name": "Dep-1", 
      "new_type": "Deployable", 
      "new_encrypted": false, 
      "updated_on": "2022-06-29 13:09:46", 
      "updated_by": "admin", 
      "resolution_method": "", 
      "conflict": null, 
      "path": "deployables/Dep-1", 
      "created_by": null, 
      "created_on": null, 
      "old_value": null, 
      "old_state": "Superseded", 
      "old_name": "Dep-1", 
      "old_type": "Deployable", 
      "old_encrypted": false 
    } 
] 
}

    CdmChangesetsApi - OBTER /sn_cdm/changesets/commit-status/

    Retorna o status atual da solicitação de confirmação do conjunto de mudanças especificado.

    Formato de URL

    URL com controle de versão: /api/sn_cdm//changesets/commit-status/(commit_id)

    URL padrão: /api/sn_cdm/changesets/commit-status/

    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
    commit_id Sys_id para a solicitação de confirmação cujo status será retornado.

    Este valor é retornado pelo CdmChangesetsApi - PUBLICAR /sn_cdm/changesets//commit endpoint.

    Tipo de dados: Cadeia de caracteres
    Tabela 20. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 21. 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 22. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. 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
    commit_id Confirmar sys_id do registro de solicitação. Igual ao passado para o endpoint.

    Tipo de dados: Cadeia de caracteres
    erros Descrição dos erros encontrados durante o carregamento.

    Tipo de dados: Cadeia de caracteres
    saída Descrição dos dados carregados ou, se ocorreu um erro durante o carregamento, uma mensagem de erro descrevendo o erro encontrado.

    Tipo de dados: Objeto

    "output": {
  "auto_validate": "String",
  "cdm_application": "String",
  "committed_at": "String",
  "committed_by": "String",
  "description": "String",
  "last_conflict_detection_time": "String",
  "number": "String",
  "publish_option": "String",
  "snapshot_description": "String",
  "snapshot_name": "String",
  "state": "String",
  "sys_created_by": "String",
  "sys_id": "String",
  "title": "String"
}
    output.auto_validate Indica se a validação deve ser invocada após a confirmação.

    Tipo de dados: Cadeia de caracteres
    output.cdm_application Nome da aplicação na qual o carregamento foi realizado.

    Tipo de dados: Cadeia de caracteres
    output.committed_at Data e hora em que o conteúdo carregado foi confirmado.

    Tipo de dados: Cadeia de caracteres
    output.committed_by Sys_id do registro da entidade que executou a confirmação.

    Tipo de dados: Cadeia de caracteres
    output.description Atualmente não usado.

    Tipo de dados: Cadeia de caracteres
    output.last_conflict_detection_time Invocação de detecção de conflito de data e hora.

    Tipo de dados: Cadeia de caracteres
    output.number Número exclusivo do conjunto de mudanças.

    Tipo de dados: Cadeia de caracteres
    output.publish_option
    Opção de publicação para os snapshots configurados associados.
    Valores válidos:
    • Publish_none: Não publique snapshots.
    • Publish_valid: Publique somente os snapshots que passam na validação após a confirmação.

    Para obter informações adicionais sobre como publicar snapshots, consulte Publicar ou cancelar a publicação de um snapshot .

    Tipo de dados: Cadeia de caracteres

    Padrão: Publish_none
    output.snapshot_description Descrição do snapshot associado.

    Tipo de dados: Cadeia de caracteres
    output.snapshot_name Nome do snapshot associado.

    Tipo de dados: Cadeia de caracteres
    output.state Estado do conteúdo carregado.
    Valores possíveis:
    • confirmado
    • concluído
    • erro
    • in_progress
    • novo(a)
    • pronto

    Tipo de dados: Cadeia de caracteres
    output.sys_created_by Sys_id da entidade que criou o registro.

    Tipo de dados: Cadeia de caracteres
    output.sys_id Sys_id do registro que contém o conjunto de mudanças.

    Tipo de dados: Cadeia de caracteres
    output.title Título do conjunto de mudanças criado como parte do carregamento.

    Tipo de dados: Cadeia de caracteres
    processing_state Estado de processamento atual da solicitação de confirmação.
    Valores possíveis:
    • NOT_PROCREED
    • PROCESSADO

    Tipo de dados: Cadeia de caracteres
    request_id ID da solicitação. Igual ao passado para o endpoint e. commit_id.

    Tipo de dados: Cadeia de caracteres
    estado Estado atual da confirmação especificada.
    Valores possíveis:
    • concluído
    • erro
    • in_progress
    • novo(a)
    • pronto

    Tipo de dados: Cadeia de caracteres

    Tabela: Valor da coluna de estado da tabela Fila de solicitação do CDM [sn_cdm_request_queue].
    tipo Tipo de solicitação.
    Valores possíveis:
    • confirmar
    • exportação
    • upload_and_commit

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    O exemplo a seguir mostra como chamar este endpoint para obter o status da confirmação especificada.

    curl "http://instance.servicenow.com/api/sn_cdm/changesets/commit-status/bf506e69537c3010a1d3ddeeff7b12c0"\ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    A seguir, são mostrados exemplos de uma resposta de sucesso e erro.

    
// Successful response 

{ 
  "result": { 
    "type": "commit", 
    "state": "completed", 
    "output": { 
      "sys_id": "4a4407e953124110da35ddeeff7b1235", 
      "number": "Chset-1207", 
      "title": "admin064407e953124110da35ddeeff7b1235", 
      "description": "A description of my changeset provided during creation", 
      "committed_at": "2022-03-17 22:19:33", 
      "committed_by": "6816f79cc0a8016401c5a33be04be441", 
      "sys_created_by": "admin", 
      "state": "committed", 
      "publish_option": "publish_none", 
      "auto_validate": false, 
      "snapshot_name": null, 
      "snapshot_description": null, 
      "cdm_application": "DemoApp", 
      "last_conflict_detection_time": null 
    }, 
    "processing_state": "PROCESSED", 
    "commit_id": "9cd583e953124110da35ddeeff7b128a" 
  } 
} 

 

// Example of an error response 

{ 
  "result": { 
    "state": "error", 
    "errors": "Invalid requestId '9cd583e953124110da35ddeeff7b128'", 
    "commit_id": "9cd583e953124110da35ddeeff7b128" 
  } 
}

    CdmChangesetsApi - OBTER /sn_cdm/changesets/impacted-deployables

    Retorna a lista de implantáveis associados a um conjunto de mudanças especificado.

    A função de Visualizador do CDM é necessária para acessar este endpoint.

    Formato de URL

    URL com controle de versão: /api/sn_cdm//changesets/impacted-deployables

    URL padrão: /api/sn_cdm/changesets/impacted-implantables

    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
    changesetNumber Obrigatório.
    Identificador exclusivo do conjunto de mudanças associado, como "Chset-10".

    Tipo de dados: Cadeia de caracteres

    Tabela: Conjunto de mudanças do CDM [sn_cdm_changeset]
    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.
    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
    cdi_count Número de itens de dados de configuração (CDIs) contidos na aplicação CDM associada.

    Tipo de dados: Número (inteiro)
    cdi_usage Percentual de CDIs usados pelo implantável.

    Tipo de dados: Número (inteiro)
    cdm_app Objeto da aplicação CDM associado ao implantável.

    Tipo de dados: Objeto

    "cdm_app": {
  "link": "String",
  "value": "String"
}
    cdm_app.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_app.value Sys_id do registro da aplicação CDM associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Aplicação CDM [sn_cdm_application]
    cdm_ci Objeto de serviço de aplicações associado ao implantável.

    Tipo de dados: Objeto

    "cdm_ci": {
  "link": "String",
  "value": "String"
}
    cdm_ci.link Chamada a ser usada para acessar o registro de serviço de aplicativos usando o REST Tabela API.

    Tipo de dados: Cadeia de caracteres
    cdm_ci.value Sys_id do registro de serviço de aplicações associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item de configuração [cmdb_ci]
    descrição Descrição do CDM implantável gerado.

    Tipo de dados: Cadeia de caracteres
    environment_type Tipo de ambiente do implantável.
    Valores possíveis:
    • Desenvolvimento
    • Produção
    • Testar

    Tipo de dados: Cadeia de caracteres
    erro Retornado somente se ocorreu um erro durante o processamento.

    Tipo de dados: Objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    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
    nome Nome do CDM implantável.

    Tipo de dados: Cadeia de caracteres
    node Detalhes sobre o nó implantável.

    Tipo de dados: Objeto

    "node": {
  "link": "String",
  "value": "String"
}
    node.link Chamada a ser usada para acessar o registro do nó implantável usando o REST Tabela API.

    Tipo de dados: Cadeia de caracteres
    node.value Sys_id do registro do nó implantável.

    Tipo de dados: Cadeia de caracteres

    Tabela: CDM implantável [sn_cdm_deployable]
    snapshot_version_counter Número de snapshots criados para o implantável.

    Tipo de dados: Número (inteiro)
    estado Estado atual do implantável.
    Valores possíveis:
    • ativo
    • excluído

    Tipo de dados: Cadeia de caracteres
    sys_created_by Nome de usuário que criou o CDM implantável. Por exemplo, able.tuter.

    Tipo de dados: Cadeia de caracteres
    sys_created_on Data e hora em que o CDM implantável foi criado.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss
    sys_id Sys_id do implantável criado.

    Tipo de dados: Cadeia de caracteres

    Tabela: CDM implantável [sn_cdm_deployable]
    sys_updated_by Nome de usuário do usuário que atualizou pela última vez o CDM implantável. Por exemplo, able.tuter.

    Tipo de dados: Cadeia de caracteres
    sys_updated_on Data e hora em que o CDM implantável foi atualizado pela última vez.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss

    Solicitação de curl

    O exemplo de código a seguir mostra como recuperar os implantáveis afetados para um conjunto de mudanças especificado.

    curl "http://instance.servicenow.com/api/sn_cdm/changesets/impacted-deployables?changesetNumber=Chset-783" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Resultados de retorno:

    { 
  "result": [ 
    { 
      "cmdb_ci": { 
        "value": "75c5d7a953b70110a1d3ddeeff7b12a2", 
        "link": "http://instance.servicenow.com/api/now/table/cmdb_ci_service_auto/75c5d7a953b70110a1d3ddeeff7b12a2" 
      }, 
      "cdi_count": "2", 
      "snapshot_version_counter": "3", 
      "description": null, 
      "sys_updated_on": "2022-06-29 16:19:05", 
      "environment_type": "Development", 
      "node": { 
        "value": "a1c517a953b70110a1d3ddeeff7b129b", 
        "link": "http://instance.servicenow.com/api/now/table/sn_cdm_node/a1c517a953b70110a1d3ddeeff7b129b" 
      }, 
      "sys_id": "6dc517a953b70110a1d3ddeeff7b129b", 
      "sys_updated_by": "admin", 
      "cdm_app": { 
        "value": "62b517a953b70110a1d3ddeeff7b128c", 
        "link": "http://instance.servicenow.com/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" 
      }, 
      "sys_created_on": "2022-05-31 13:03:23", 
      "cdi_usage": "0.02", 
      "name": "Development_1", 
      "state": "active", 
      "sys_created_by": "admin" 
    } 
  ] 
}

    CdmChangesetsApi - OBTER /sn_cdm/changesets/impacted-shared-components

    Retorna uma lista de componentes compartilhados que estão associados a um conjunto de mudanças especificado.

    A função de Visualizador do CDM é necessária para acessar este endpoint.

    Formato de URL

    URL com controle de versão: /api/sn_cdm//changesets/impacted-shared-components

    URL padrão: /api/sn_cdm/changesets/impacted-shared-components

    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
    changesetNumber Obrigatório.
    Identificador exclusivo do conjunto de mudanças associado, como "Chset-10".

    Tipo de dados: Cadeia de caracteres

    Tabela: Conjunto de mudanças do CDM [sn_cdm_changeset]
    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.
    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 conjunto de mudanças aprovado não existe.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta

    Nome Descrição
    cdm_shared__library Sys_id da biblioteca compartilhada na qual o componente reside.

    Tipo de dados: Cadeia de caracteres
    descrição Descrição do componente compartilhado do CDM.

    Tipo de dados: Cadeia de caracteres
    erro Retornado somente se ocorreu um erro durante o processamento.

    Tipo de dados: Objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Detalhes sobre o erro ocorrido.

    Tipo de dados: Cadeia de caracteres
    mensagem.erro Mensagem que fornece uma visão geral do erro.

    Tipo de dados: Cadeia de caracteres
    nome Nome do componente compartilhado do CDM.

    Tipo de dados: Cadeia de caracteres
    node Sys_id do nó do componente compartilhado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Nó do CDM [sn_cdm_node]
    node_main Sys_id do main_id do registro do nó do componente compartilhado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Nó principal do CDM [sn_cdm_node_main]
    estado Estado atual do componente compartilhado.
    Valores possíveis:
    • ativo
    • excluído

    Tipo de dados: Cadeia de caracteres
    sys_created_by Nome de usuário que cria o componente compartilhado do CDM. Por exemplo, able.tuter.

    Tipo de dados: Cadeia de caracteres
    sys_created_on Data e hora em que o componente compartilhado do CDM foi criado.

    Formato: AAAA-MM-DD hh:mm:ss

    Tipo de dados: Cadeia de caracteres
    sys_id Sys_id do componente compartilhado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Componente compartilhado do CDM [sn_cdm_shared_component]
    sys_updated_by Nome de usuário do usuário que atualizou o componente compartilhado do CDM pela última vez. Por exemplo, able.tuter.

    Tipo de dados: Cadeia de caracteres
    sys_updated_on Data e hora em que o componente compartilhado do CDM foi atualizado pela última vez.

    Formato: AAAA-MM-DD hh:mm:ss

    Tipo de dados: Cadeia de caracteres
    version_counter Número de versões criadas para o componente compartilhado.

    Tipo de dados: Inteiro

    Solicitação de curl

    O exemplo de código a seguir mostra como recuperar os componentes compartilhados afetados para o conjunto de mudanças "Chset-20".

    curl "https://instance.servicenow.com/sn_cdm/changesets/impacted-shared-components?changesetNumber=Chset-20" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Resposta:

    {
  "result": [
    {
      "version_counter": "1",
      "description": null,
      "cdm_shared_library": "acb905e097b3991052687b890353afcd",
      "sys_updated_on": "2022-12-12 20:28:49",
      "node": "3cb945e097b3991052687b890353af0d",
      "sys_id": "34b945e097b3991052687b890353af20",
      "sys_updated_by": "john.jones",
      "node_main": "74b945e097b3991052687b890353af0d",
      "sys_created_on": "2022-12-12 20:28:39",
      "name": "logonService-V2.1",
      "state": "active",
      "sys_created_by": "john.jones"
    },
    {
      "version_counter": "1",
      "description": null,
      "cdm_shared_library": "acb905e097b3991052687b890353afcd",
      "sys_updated_on": "2022-12-12 20:28:49",
      "node": "b0b945e097b3991052687b890353af11",
      "sys_id": "30b945e097b3991052687b890353af21",
      "sys_updated_by": "john.jones",
      "node_main": "f8b945e097b3991052687b890353af10",
      "sys_created_on": "2022-12-12 20:28:39",
      "name": "logonService-V2.2",
      "state": "active",
      "sys_created_by": "john.jones"
    },
    {
      "version_counter": "1",
      "description": null,
      "cdm_shared_library": "acb905e097b3991052687b890353afcd",
      "sys_updated_on": "2022-12-12 20:28:49",
      "node": "6cb905e097b3991052687b890353afd3",
      "sys_id": "b4b945e097b3991052687b890353af21",
      "sys_updated_by": "john.jones",
      "node_main": "a4b905e097b3991052687b890353afd3",
      "sys_created_on": "2022-12-12 20:28:39",
      "name": "paymentService-V1.0",
      "state": "active",
      "sys_created_by": "john.jones"
    },
    {
      "version_counter": "1",
      "description": null,
      "cdm_shared_library": "acb905e097b3991052687b890353afcd",
      "sys_updated_on": "2022-12-12 20:28:49",
      "node": "e0b905e097b3991052687b890353aff1",
      "sys_id": "3cb945e097b3991052687b890353af21",
      "sys_updated_by": "john.jones",
      "node_main": "2cb905e097b3991052687b890353aff0",
      "sys_created_on": "2022-12-12 20:28:39",
      "name": "paymentService-V1.1",
      "state": "active",
      "sys_created_by": "john.jones"
    }
  ]
}

    CdmChangesetsApi - OBTER /sn_cdm/changesets/

    Retorna a lista de implantáveis associados a um conjunto de mudanças especificado.

    Formato de URL

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

    URL padrão: /api/sn_cdm/changesets/

    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 37. 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
    changeset_id Sys_id do registro do conjunto de mudanças a ser processado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Conjunto de mudanças do CDM [sn_cdm_changeset]
    Tabela 38. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 39. 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 40. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 41. 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 42. 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
    changeset_id Sys_id do último conjunto de mudanças associado ao nó implantável.

    Tipo de dados: Cadeia de caracteres
    conflito Sinalizador que indica se o implantável associado está em conflito.
    Valores possíveis:
    • 0: Não está em conflito.
    • 1: Em conflito - Consulte conflict_typeretorne o resultado para obter informações adicionais.

    Tipo de dados: Número
    conflict_type Tipo de conflito implantável.
    Valores possíveis:
    • corrupted_node
    • deleted_node
    • duplicated_node
    • incomplete_deleted_parent
    • incomplete_deleted_ref
    • incomplete_renamed_ref
    • invalid_include
    • orphan_descendent
    • related_conflict
    • unlinked_include
    • unrenamed_include
    • updated_node

    Tipo de dados: Cadeia de caracteres
    descrição Descrição do nó implantável.

    Tipo de dados: Cadeia de caracteres
    effective_from Carimbo de data/hora em que o nó é válido. Este valor é nulo até que você confirme um conjunto de mudanças no qual o nó foi criado.

    Tipo de dados: Número
    effective_to Carimbo de data/hora quando o nó não é mais válido. Se este valor for nulo , o nó permanece em efeito até ser substituído por uma nova versão.

    Tipo de dados: Número
    erro Se ocorreu um erro durante o processamento, os detalhes sobre o erro.

    Tipo de dados: Objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    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
    nível Profundidade do nó a partir do nível da aplicação, que é 0.

    Tipo de dados: Número
    linked_to ID do nó de referência em uma coleção e componente.

    Por exemplo, o snippet de nó a seguir mostra um link entre a coleção Colla e a empresa de componente. Para este exemplo, linkedToo valor é 1 :

    { 
components : {compA:{} //MainId: 1}, 

Collections : { collA : {  
   compA :{} //Include, linkedTo: 1 
    } 
  } 
}

    Tipo de dados: Cadeia de caracteres
    main_id Identificador exclusivo do nó implantável. Este valor é gerado quando o nó é criado e usado para identificar o nó implantável.

    Tipo de dados: Número
    main_id_encoded Valor codificado do mainIdRetornar resultados, usando a representação de cadeia de caracteres Radix 57.

    Tipo de dados: Cadeia de caracteres
    nome Nome do implantável.

    Tipo de dados: Cadeia de caracteres
    node_classificador Classificação de nó, como Desenvolvimento, Produção ou Teste.

    No formato:

    • /Application/implantables/env:Development
    • /Application/implantables/env:production
    • /Application/implantables/env:Test

    Tipo de dados: Cadeia de caracteres
    posição Posição do nó implantável. Aplicável somente a matrizes.

    Por exemplo, para a matriz:

    node1:{
  arrayNode: [{}, "literal1", "literal2", []] }

    é a posição 1000,

    "literal1" é a posição 2000,

    "literal2" é a posição 3000,

    [] é a posição 4000

    Tipo de dados: Número
    previous_version Sys_id da versão anterior do nó implantável associado.

    Tipo de dados: Cadeia de caracteres
    restricted_to Lista de sys_ids dos usuários que têm permissão para acessar o nó implantável associado. Este valor é nulo se todos os grupos puderem acessar o implantável.

    Tipo de dados: Cadeia de caracteres

    Tabela: Grupos restritos do CDM [sn_cdm_restricted_groups]
    secure_value Valor seguro do CDI ou variável. Retornado somente para nós folha e literais de matriz. É o mesmo que valueretorna o resultado, mas é criptografado.

    Tipo de dados: Cadeia de caracteres
    status Status do nó implantável ou o status de uma solicitação com falha.
    Valores possíveis:
    • excluído
    • falha (aprovado se a chamada de endpoint falhar.)
    • novo(a)
    • substituído
    • atualizado
    • válido

    Tipo de dados: Cadeia de caracteres
    system_folder Sinalizador que indica se a pasta associada é uma pasta do sistema.
    Valores possíveis:
    • 0: Não é uma pasta do sistema.
    • 1: Pasta do sistema.

    Tipo de dados: Número
    sys_id Sys_id do implantável afetado.

    Tipo de dados: Cadeia de caracteres
    tipo Tipo de nó, como sn_cdm_node_deployable. Este valor permite que você determine se o nó é um componente, item de dados de configuração (CDI) ou implantável. Este valor é gerado quando o nó é criado.

    Tipo de dados: Cadeia de caracteres
    valor Valor do CDI ou variável. Retornado somente para nós folha e literais de matriz. Se essas informações forem criptografadas, elas serão retornadas em secure_valueretornar resultado.

    Por exemplo, se este nó for o CDI NóA:Cdi1: 1 . valueo resultado do retorno é 1 . Se for um nó de matriz, como Nó 1: "Literal1", "literal2", []] . valueo resultado do retorno é literal1 .

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    O exemplo a seguir mostra como solicitar os implantáveis associados ao conjunto de mudanças cujo sys_id é bf506e69537c3010a1d3ddeeff7b12c0.

    curl "http://instance.servicenow.com/api/sn_cdm/changesets/bf506e69537c3010a1d3ddeeff7b12c0/impacted-deployables"\ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    A seguir mostra uma resposta bem-sucedida e uma resposta de erro para este endpoint.

    // Successful response
{
  "result": [
    {
      "sys_id": "833527a953924110da35ddeeff7b12c1",
      "type": "sn_cdm_node_deployable",
      "main_id": "150",
      "main_id_encoded": "&M",
      "node_path": "!&@!&D!&M",
      "level": 2,
      "status": "valid",
      "node_classifier": "/application/deployables/env:Development",
      "position": null,
      "restricted_to": null,
      "changeset_id": "cb3527a953924110da35ddeeff7b12c0",
      "previous_version": "e8946f6953924110da35ddeeff7b1264",
      "effective_from": "1647563806950",
      "effective_to": null,
      "name": "Development_1",
      "description": "dev deployable decription",
      "value": null,
      "secure_value": null,
      "system_folder": "0",
      "linked_to": null,
      "conflict": "0",
      "conflict_type": null
    },
    {
      "sys_id": "a245e7a953924110da35ddeeff7b1223",
      "type": "sn_cdm_node_deployable",
      "main_id": "153",
      "main_id_encoded": "&P",
      "node_path": "!&@!&D!&P",
      "level": 2,
      "status": "valid",
      "node_classifier": "/application/deployables/env:Test",
      "position": null,
      "restricted_to": null,
      "changeset_id": "ea45e7a953924110da35ddeeff7b1222",
      "previous_version": "9505ef6953924110da35ddeeff7b121a",
      "effective_from": "1647563821422",
      "effective_to": null,
      "name": "Test_1",
      "description": "test deployable decription",
      "value": null,
      "secure_value": null,
      "system_folder": "0",
      "linked_to": null,
      "conflict": "0",
      "conflict_type": null
    }
  ]
} 

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

    CdmChangesetsApi - PUBLICAR /sn_cdm/changesets//commit

    Confirma o conjunto de mudanças especificado. Uma vez confirmado, o conjunto de mudanças persiste nas tabelas do CDM na instância associada.

    O sistema atualiza a aplicação para persistir as mudanças nos dados de configuração no conjunto de mudanças. O estado do conjunto de mudanças muda para Confirmado . Em seguida, o sistema gera um snapshot de cada implantável afetado pelo conjunto de mudanças.

    Este endpoint retorna o ID da solicitação de confirmação. Use este ID para chamar CdmChangesetsApi - OBTER /sn_cdm/changesets/commit-status/ endpoint para obter o status atual da confirmação do conjunto de mudanças.

    Formato de URL

    URL com controle de versão: /api/sn_cdm/api/changesets/changeset_id/commit

    URL padrão: /api/sn_cdm/changesets//commit

    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 43. 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
    changeset_id Sys_id do registro do conjunto de mudanças a ser processado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Conjunto de mudanças do CDM [sn_cdm_changeset]
    Tabela 44. Parâmetros de consulta
    Nome Descrição
    Validar automaticamente Sinalizador que indica se os snapshots criados na confirmação são validados, o que significa que todas as políticas associadas são executadas no snapshot.
    Valores válidos:
    • Verdadeiro: Valide os snapshots.
    • Falso: Não valide os snapshots.

    Padrão: falso
    PublichOption Opção de publicação para os snapshots de configuração associados.
    Valores válidos:
    • Publish_none: Não publique snapshots.
    • Publish_valid: Publique somente os snapshots que passam na validação após a confirmação.
    Nota:
    Esta opção só estará disponível se o valor de autoCommito parâmetro é verdadeiro.

    Para obter informações adicionais sobre como publicar snapshots, consulte Publicar ou cancelar a publicação de um snapshot .

    Tipo de dados: Cadeia de caracteres

    Padrão: Publish_none
    Tabela 45. 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 46. 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 47. 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 48. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Erro: <Error message>

    Valide que changeset_ido parâmetro que você passou estava correto.

    Certifique-se de ter as funções necessárias para acessar este endpoint.
    500 Erro de erro interno do servidor: Valor booliano inválido.

    Se você foi aprovado em autoValidateparâmetro, verifique se é um valor booliano.

    Parâmetros do corpo da resposta

    Nome Descrição
    commit_id Sys_id da solicitação de confirmação.

    Use este ID ao chamar CdmChangesetsApi - OBTER /sn_cdm/changesets/commit-status/ endpoint para verificar o status da solicitação de confirmação.

    Tipo de dados: Cadeia de caracteres
    erro Se ocorreu um erro durante o processamento, os detalhes sobre o erro.

    Tipo de dados: Objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    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 da confirmação. Retornado somente quando ocorre um erro.

    Valores possíveis: Falha

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    O exemplo a seguir mostra como chamar este endpoint para confirmar um registro de conjunto de mudanças.

    curl "http://instance.servicenow.com/api/sn_cdm/changesets/29e24001533030104bacddeeff7b120c/commit?publishOption=publish_valid"\ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \
--user 'username':'password'

    A resposta a seguir mostra a resposta para uma solicitação de confirmação bem-sucedida do conjunto de mudanças.

    // Successful response
{ 
  "result": { 
    "commit_id": "64b5f79f5379301096edddeeff7b12eb" 
  } 
}

// Example of an error response
{
  "error": {
    "message": "Error: Unexpected error occurred in commit request.Error:Failed to insert request in queue",
    "detail": ""
  },
  "status": "failure"
}

    CdmChangesetsApi - POST /sn_cdm/changesets/create

    Cria um novo conjunto de mudanças no estado Aberto para uma aplicação CDM especificada ou biblioteca compartilhada.

    A função Editor do CDM é necessária para acessar este endpoint.

    Formato de URL

    URL com controle de versão: /api/sn_cdm//changesets/create/

    URL padrão: /api/sn_cdm/changesets/create/

    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 49. 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 50. Parâmetros de consulta
    Nome Descrição
    appName Obrigatório. Nome da aplicação CDM ou da biblioteca compartilhada a ser associada a este conjunto de mudanças. Esta deve ser uma aplicação ativa ou uma biblioteca compartilhada.

    Tipo de dados: Cadeia de caracteres
    descrição Descrição do conjunto de mudanças. Insira algo que permita que outras pessoas entendam a finalidade do conjunto de mudanças.

    Tipo de dados: Cadeia de caracteres

    Padrão: Nenhum
    returnFields Lista separada por vírgulas de campos na tabela Conjunto de mudanças do CDM [sn_cdm_changeset] para retornar como parte da resposta.

    Tipo de dados: Cadeia de caracteres
    Tabela 51. 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 52. 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 53. 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 54. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Erro: <Error message>

    Certifique-se de que a aplicação CDM especificada ou a biblioteca compartilhada exista e esteja no estado ativo.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta

    Nome Descrição
    auto_validate

    Sinalizador que indica se a validação automática foi realizada.

    Valores possíveis:
    • Verdadeiro: A validação automática foi realizada.
    • Falso: A validação automática não foi executada.

    Tipo de dados: Booliano
    cdm_application Detalhes sobre a aplicação CDM associada ao conjunto de mudanças.

    Tipo de dados: Objeto

    "cdm_application": { 
  "link": "String",
  "value": "String"
}
    Por exemplo: "Valor": "<sysId>", "link": "http://localhost:8081/api/now/table/*’}"
    cdm_application.link URL da aplicação CDM associada.

    Tipo de dados: Cadeia de caracteres
    cdm_application.value Sys_id da aplicação CDM associada.

    Tipo de dados: Cadeia de caracteres
    committed_at Data e hora em que o conjunto de mudanças foi confirmado no repositório associado.

    Tipo de dados: Cadeia de caracteres
    committed_by Sys_id da entidade que criou o conjunto de mudanças.

    Tipo de dados: Cadeia de caracteres
    descrição Descrição do conjunto de mudanças conforme passado quando o endpoint foi chamado.

    Tipo de dados: Cadeia de caracteres
    erro Se ocorreu um erro durante o processamento, os detalhes sobre o erro.

    Tipo de dados: Objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    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_conflict_detection_time A última detecção de conflito foi executada.

    Tipo de dados: Número

    Unidade: Milissegundos
    número Identificador exclusivo do novo conjunto de mudanças.

    Tipo de dados: Cadeia de caracteres
    publish_option
    Opção de publicação para os snapshots configurados associados.
    Valores válidos:
    • Publish_none: Não publique snapshots.
    • Publish_valid: Publique somente os snapshots que passam na validação após a confirmação.

    Para obter informações adicionais sobre como publicar snapshots, consulte Publicar ou cancelar a publicação de um snapshot .

    Tipo de dados: Cadeia de caracteres

    Padrão: Publish_none
    snapshot_description Descrição do snapshot associado ao conjunto de mudanças.

    Tipo de dados: Cadeia de caracteres
    estado Estado da criação do conjunto de mudanças.
    Valores possíveis:
    • Bloqueados
    • Verificando possíveis conflitos
    • Falha na confirmação
    • Confirmação em andamento
    • Confirmado
    • Aberto

    Tipo de dados: Cadeia de caracteres
    status Status da criação do conjunto de mudanças. Retornado somente quando ocorre um erro.

    Valores possíveis: Falha

    Tipo de dados: Cadeia de caracteres
    sys_created_by Sys_id da entidade que criou o registro do conjunto de mudanças.

    Tipo de dados: Cadeia de caracteres
    sys_id Sys_id do novo conjunto de mudanças.

    Tipo de dados: Cadeia de caracteres
    título Título do conjunto de mudanças associado à aplicação. Normalmente gerado automaticamente pelo sistema.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    O exemplo a seguir mostra como criar um conjunto de mudanças associado à aplicação CDM do Service1 da App.

    curl "http://instance.servicenow.com/api/sn_cdm/changesets/create?appName=App%20Service1&description=Sample%20Description \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \
--user 'username':'password'

    A seguir, é mostrada a resposta para uma criação bem-sucedida do conjunto de mudanças.

    // Example of a successful response
{   
"result": { 
    "sys_id": "42748779c370301054c1582e1340ddcd",
    "number": "Chset-8",
    "title": "admin2021-06-18 10:06:46",
    "description": null,
    "committed_at": "",
    "committed_by": null,
    "sys_created_by": "admin",
    "state": "open",
    "publish_option": "publish_none",
    "auto_validate": false,
    "snapshot_name": null,
    "snapshot_description": null,
    "cdm_application": "App%20Service1" 
  } 
}

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

    Solicitação de curl

    O exemplo a seguir mostra como criar um conjunto de mudanças para a biblioteca compartilhada "javalib".

    curl "http://instance.servicenow.com/api/sn_cdm/changesets/create?sharedLibraryName=javalib&description=description of changeset" \ 
--request POST \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Resposta:

    CdmChangesetsApi - COLOQUE /sn_cdm/changesets/commit

    Atualiza e confirma um conjunto de mudanças especificado.

    O sistema atualiza a aplicação para persistir as mudanças nos dados de configuração no conjunto de mudanças. O estado do conjunto de mudanças muda para Confirmado . Em seguida, o sistema gera um snapshot de cada implantável afetado pelo conjunto de mudanças.

    Este endpoint retorna o ID da solicitação de confirmação. Use este ID para chamar CdmChangesetsApi - OBTER /sn_cdm/changesets/commit-status/ endpoint para obter o status atual da confirmação do conjunto de mudanças.

    Formato de URL

    URL com controle de versão: /api/sn_cdm/api/changesets/changeset_id/commit

    URL padrão: /api/sn_cdm/changesets//commit

    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 55. 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 56. Parâmetros de consulta
    Nome Descrição
    Validar automaticamente Sinalizador que indica se os snapshots criados durante a confirmação são validados, o que significa que todas as políticas associadas são executadas no snapshot.
    Valores válidos:
    • Verdadeiro: Valide os snapshots.
    • Falso: Não valide os snapshots.

    Tipo de dados: Booliano

    Padrão: falso
    changesetNumber Obrigatório.
    Identificador exclusivo do conjunto de mudanças associado, como "Chset-10".

    Tipo de dados: Cadeia de caracteres

    Tabela: Conjunto de mudanças do CDM [sn_cdm_changeset]
    PublichOption
    Opção de publicação para os snapshots configurados associados.
    Valores válidos:
    • Publish_none: Não publique snapshots.
    • Publish_valid: Publique somente os snapshots que passam na validação após a confirmação.

    Para obter informações adicionais sobre como publicar snapshots, consulte Publicar ou cancelar a publicação de um snapshot .

    Tipo de dados: Cadeia de caracteres

    Padrão: Publish_none
    Tabela 57. 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 58. 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 59. 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 60. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Erro: <Error message>

    Valide que changeset_ido parâmetro que você passou estava correto.

    Certifique-se de ter as funções necessárias para acessar este endpoint.
    500 Erro interno do servidor: Valor booliano inválido.

    Se você foi aprovado em autoValidateparâmetro, verifique se é um valor booliano.

    Parâmetros do corpo da resposta

    Nome Descrição
    commit_id Sys_id da solicitação de confirmação.

    Use este ID ao chamar CdmChangesetsApi - OBTER /sn_cdm/changesets/commit-status/ endpoint para verificar o status da solicitação de confirmação.

    Tipo de dados: Cadeia de caracteres
    erro Se ocorreu um erro durante o processamento, os detalhes sobre o erro.

    Tipo de dados: Objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    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 da confirmação. Retornado somente quando ocorre um erro.

    Valores possíveis: Falha

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    O exemplo de código Seguir mostra como usar este endpoint para atualizar um conjunto de mudanças.

    curl "http://instance.servicenow.com/api/sn_cdm/changesets/commit?changesetNumber=Chset-146" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Resultados de retorno:

    { 
  "result": { 
    "commit_id": "cca8190f53141110a1d3ddeeff7b129e" 
  } 
}