APICdmEditor

A CdmEditorApi fornece endpoints que permitem criar nós, atualizar nós, incluir nós existentes em outros nós, excluir nós e recuperar nós e inclusões de nós.

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)

Para exibir os campos que foram criptografados, você deve ter a função Secreta do CDM.

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.

Nota:

A API CdmEditorApi não pode ser usada para modificar arquivos. Somente a exclusão de arquivo é permitida no momento.

CdmEditorApi - DELETE /sn_cdm/editor/nodes

Exclui um nó especificado.

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}/editor/nodes

URL padrão: /api/sn_cdm/editor/nodes

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário 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 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 2. Parâmetros de consulta

Nome	Descrição
changesetNumber	Obrigatório. Identificador exclusivo do changeset associado, como "Chset-10". Tipo de dados: cadeia de caracteres Tabela: CDMChangeset [sn_cdm_changeset]
fullNamePath	Obrigatório. Nome do caminho do nó a ser excluído. Você pode passar o caminho do nome em qualquer um dos formatos a seguir. Por exemplo, para excluir o seguinte nó testApp/deployables/Development1/cdi1: Formato de barra invertida: testApp/deployables/Development1/cdi1 Nota: Se o nome do nó contiver uma barra invertida ("/"), você não poderá usar este formato. Caminho do nome de back-end com caracteres de substituição: testApp​deployables​​Development1​​cdi1 Matriz: ['testApp','deployables','Development1','cdi1'] Tipo de dados: cadeia de caracteres

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 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 do 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
Nenhum(a)

Solicitação de cURL

O exemplo de código a seguir mostra como excluir o nó "cdi88".

curl "http://instance.servicenow.com/api/sn_cdm/editor/nodes?changesetNumber=Chset783&fullNamePath=%2FtestApp%2Fdeployables%2FDevelopment-1%2Fcdi88" \
--request DELETE \
--header "Accept:application/json" \
--user 'username':'password'

Retornar resultado:

None - just the associated HTTP status code

CdmEditorApi - GET /sn_cdm/editor/includes

Retorna a lista de nós que foram incluídos em um caminho de nó especificado.

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

Formato da URL

URL com controle de versões: /api/sn_cdm/{api_version}/editor/includes

URL padrão: /api/sn_cdm/editor/includes

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário 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 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 8. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

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

Nome	Descrição
changesetNumber	Identificador exclusivo do changeset associado, como "Chset-10". Tipo de dados: cadeia de caracteres Tabela: CDMChangeset [sn_cdm_changeset]
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
sourceFullNamePath	Obrigatório. Nome do caminho do nó de origem para o qual os nós incluídos serão retornados. Você pode passar o caminho do nome em qualquer um dos formatos a seguir. Por exemplo, para retornar as inclusões do nó collectionA no diretório testApp/collection : Formato de barra invertida: testApp/collection/collectionA Nota: Se o nome do nó contiver uma barra invertida ("/"), você não poderá usar este formato. Caminho do nome de back-end com caracteres de substituição: testApp​collections​collectionA Matriz: ['testApp','collections','collectionA'] Tipo de dados: cadeia de caracteres

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 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 do 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
changeset_id	Identificador exclusivo do changeset associado, como "Chset-10". Tipo de dados: cadeia de caracteres Tabela: CDMChangeset [sn_cdm_changeset]
conflito	Sinalizador que indica se houve um conflito ao processar o nó. Valores possíveis: verdadeiro: conflito detectado. falso: nenhum conflito foi detectado. Tipo de dados: booliano
tipo_conflito	Se o parâmetro conflict for verdadeiro, o tipo de conflito detectado. Nulo se nenhum conflito for detectado. Valores possíveis: nó_corrompido nó_excluído nó_duplicado incompleto_deleted_parent ref_excluído_incompleto incompleto_renamed_ref invalid_include descendente_órfão relacionado_conflito unlinked_include unrenamed_include update_node Tipo de dados: cadeia de caracteres
descrição	Descrição resumida da finalidade do nó. Tipo de dados: cadeia de caracteres
eficaz_de	Carimbo de data/hora (convertido em um número inteiro longo) quando o nó foi confirmado como parte do changeset. Se o nó não tiver sido confirmado, este valor será "nulo". Tipo de dados: número (inteiro)
eficaz_para	Carimbo de data/hora (convertido em um número inteiro longo) do nó quando ele foi excluído ou substituído por outro nó, caso contrário, "nulo". Tipo de dados: número (inteiro)
erro	Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: objeto "error": { "detail": "String", "message": "String" }
erro.detalhe	Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres
mensagem.erro	Mensagem de erro gerada ao tentar processar a solicitação. Tipo de dados: cadeia de caracteres
nível	Nível do nó, a partir do nó raiz, que é sempre 0. Por exemplo, o nó /AppA/components/compA tem dois níveis. Tipo de dados: cadeia de caracteres
vinculado_a	O parâmetro main_id do nó referenciado ao qual este nó está vinculado. Se este nó não estiver vinculado a um nó de referência, o valor será "nulo". Tipo de dados: cadeia de caracteres
main_id	Identificador primário do nó. Você pode usar este valor na inclusão de script CdmQuery() para recuperar uma árvore JSON. Por exemplo: CdmQuery().mainId('123')/query().getTree(); Tipo de dados: cadeia de caracteres
main_id_encoded	Representação de cadeia de caracteres RADIX 57 do parâmetro main_id do nó. Tipo de dados: cadeia de caracteres
nome	Nome do nó que foi incluído no caminho de destino. Tipo de dados: cadeia de caracteres
nó_classificador	Hierarquia de classificadores do nó. Use essas informações para localizar um nó na hierarquia de pastas. Por exemplo, um implantável teria uma hierarquia de /application/deployables/env:Development Enquanto uma coleção teria uma hierarquia de /aplicações/coleções Tipo de dados: cadeia de caracteres
nó_caminho	Nome do caminho completo do nó que foi incluído no caminho de destino, como /Production/deployables/Development1/cdi1. Tipo de dados: cadeia de caracteres
posição	Posição do nó. Por exemplo: se você carregar a seguinte matriz: arrayNode1: [ "literal1", {"cdi1": 1}, "literal3" ] Os valores de posição são definidos da seguinte forma: arrayNode1.literal1 = 1000 arrayNode1.2000 = 2000 arrayNode1.literal3 = 3000 Se um objeto complexo for carregado em uma matriz, neste caso {"cdi1": 1}, o endpoint criará um novo nó virtual com o nome igual à sua posição. No exemplo acima, é 2000. Para inclusões, a posição está sempre vazia. Tipo de dados: cadeia de caracteres
versão_anterior	Detalhes da versão anterior do registro do nó. Nota: Se um novo nó tiver sido criado, o endpoint retornará "previous_version" = nulo para este parâmetro. Tipo de dados: objeto "previous_version": { "link": "String", "value": "String" }
restrito_a	Detalhes do grupo que tem acesso ao associado ao nó. Tipo de dados: objeto "restricted_to": { "link": "String", "value": "String" }
valor_seguro	Se este valor foi sinalizado para ser protegido, o campo criptografado (retornou mascarado). Um usuário deve ter a função sn_cdm.cdm_secrets para descriptografar essas informações. Você pode direcionar o endpoint para não retornar esses campos definindo o campo de parâmetro de consulta returnFields. Tipo de dados: cadeia de caracteres
status	Status do nó. Valores possíveis: EXCLUÍDO NOVO SUBSTITUÍDO ATUALIZADO VÁLIDO Tipo de dados: cadeia de caracteres
sys_id	Sys_id do nó. Tipo de dados: cadeia de caracteres Tabela: nó do CDM [sn_cdm_node]
pasta_do_sistema	Sinalizador que indica se o nó associado é uma pasta do sistema. Valores possíveis: verdadeiro: o nó é uma pasta do sistema. falso: o nó não é uma pasta do sistema. Tipo de dados: booliano
tipo	Tipo de nó. Valores possíveis: sn_cdm_node_cdi sn_cdm_node_collection sn_cdm_node_component sn_cdm_node_folder sn_cdm_node_variable Tipo de dados: cadeia de caracteres
valor	Valor do nó. Tipo de dados: cadeia de caracteres

Solicitação de cURL

Este exemplo de código mostra como recuperar as inclusões no caminho de origem /testApp/collection/collA.

curl "http://instance.servicenow.com/api/sn_cdm/editor/includes?changesetNumber=Chset5&sourceFullNamePath=%2FtestApp%2Fcollections%2FcollA" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Retornar resultado:

{ 
  "result": [ 
    { 
      "sys_id": "a1c517a953b70110a1d3ddeeff7b129b", 
      "type": "sn_cdm_node_deployable", 
      "main_id": "6", 
      "main_id_encoded": ",", 
      "node_path": "!$!+!,", 
      "level": 2, 
      "status": "valid", 
      "node_classifier": "/application/deployables/env:Development", 
      "position": null, 
      "restricted_to": null, 
      "changeset_id": "e9c517a953b70110a1d3ddeeff7b1299", 
      "previous_version": null, 
      "effective_from": "1654002206866", 
      "effective_to": null, 
      "name": "Development_1", 
      "description": null, 
      "value": null, 
      "secure_value": null, 
      "system_folder": "0", 
      "linked_to": null, 
      "conflict": "0", 
      "conflict_type": null 
    } 
  ] 
}

CdmEditorApi - GET /sn_cdm/editor/nodes

Retorna os detalhes de um nó especificado ou uma lista de nós secundários Gestão de dados de configuração (CDM) para um nó primário especificado.

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

Formato da URL

URL com controle de versões: /api/sn_cdm/{api_version}/editor/nodes

URL padrão: /api/sn_cdm/editor/nodes

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário 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 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 14. Parâmetros de consulta

Nome	Descrição
changesetNumber	Identificador exclusivo do changeset associado, como "Chset-10". Tipo de dados: cadeia de caracteres Tabela: CDMChangeset [sn_cdm_changeset]
descriptografar senha	Sinalizador que indica se o valor deve ser criptografado para os nós folha. Valores válidos: verdadeiro: criptografado falso: não criptografado Tipo de dados: booliano Padrão: falso
nome	Nome do nó. Se você passar este parâmetro, somente os resultados do nó especificado serão retornados. Tipo de dados: cadeia de caracteres Padrão: todos os nós no nó primário
parentFullNamePath	Obrigatório. Nome do caminho do nó primário para o qual os nós secundários serão retornados ou para o qual reside o nó especificado no parâmetro name. Você pode passar o caminho do nome em qualquer um dos formatos a seguir. Por exemplo, para retornar os nós do nó collectionA no diretório testApp/collection : Formato de barra invertida: testApp/collection/collectionA Nota: Se o nome do nó contiver uma barra invertida ("/"), você não poderá usar este formato. Caminho do nome de back-end com caracteres de substituição: testApp​collections​collectionA Matriz: ['testApp','collections','collectionA'] 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
tipo	Tipo de nó. Valores possíveis: sn_cdm_node_cdi OU cdi sn_cdm_node_collection OU coleção sn_cdm_node_component OU componente sn_cdm_node_folder OU pasta sn_cdm_node_variable OU variável Tipo de dados: cadeia de caracteres Padrão: todos

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 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 do 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
changeset_id	Detalhes do registro do changeset associado ao nó. 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. Tipo de dados: cadeia de caracteres Tabela: conjunto de mudanças do CDM [sn_cdm_changeset]
conflito	Sinalizador que indica se houve um conflito ao processar o nó. Valores possíveis: verdadeiro: conflito detectado. falso: nenhum conflito foi detectado. Tipo de dados: booliano
tipo_conflito	Se o parâmetro conflict for verdadeiro, o tipo de conflito detectado. Nulo se nenhum conflito for detectado. Valores possíveis: nó_corrompido nó_excluído nó_duplicado incompleto_deleted_parent ref_excluído_incompleto incompleto_renamed_ref invalid_include descendente_órfão relacionado_conflito unlinked_include unrenamed_include update_node Tipo de dados: cadeia de caracteres
descrição	Descrição resumida da finalidade do nó. Tipo de dados: cadeia de caracteres
eficaz_de	Carimbo de data/hora (convertido em um número inteiro longo) quando o nó foi confirmado como parte do changeset. Se o nó não tiver sido confirmado, este valor será "nulo". Tipo de dados: número (inteiro)
eficaz_para	Carimbo de data/hora (convertido em um número inteiro longo) do nó quando ele foi excluído ou substituído por outro nó, caso contrário, "nulo". Tipo de dados: número (inteiro)
erro	Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: objeto "error": { "detail": "String", "message": "String" }
erro.detalhe	Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres
mensagem.erro	Mensagem de erro gerada ao tentar processar a solicitação. Tipo de dados: cadeia de caracteres
nível	Nível do nó, a partir do nó raiz, que é sempre 0. Por exemplo, o nó /AppA/components/compA tem dois níveis. Tipo de dados: cadeia de caracteres
vinculado_a	O parâmetro main_id do nó referenciado ao qual este nó está vinculado. Se este nó não estiver vinculado a um nó de referência, o valor será "nulo". Tipo de dados: cadeia de caracteres
main_id	Identificador primário do nó. Você pode usar este valor na inclusão de script CdmQuery() para recuperar uma árvore JSON. Por exemplo: CdmQuery().mainId('123')/query().getTree(); Tipo de dados: cadeia de caracteres
main_id_encoded	Representação de cadeia de caracteres RADIX 57 do parâmetro main_id do nó. Tipo de dados: cadeia de caracteres
nome	O nome do nó. Tipo de dados: cadeia de caracteres
nó_classificador	Hierarquia de classificadores do nó. Use essas informações para localizar um nó na hierarquia de pastas. Por exemplo, um implantável teria uma hierarquia de /application/deployables/env:Development Enquanto uma coleção teria uma hierarquia de /aplicações/coleções Tipo de dados: cadeia de caracteres
nó_caminho	Nome completo do caminho do nó. Tipo de dados: cadeia de caracteres
posição	Posição do nó. Por exemplo: se você carregar a seguinte matriz: arrayNode1: [ "literal1", {"cdi1": 1}, "literal3" ] Os valores de posição são definidos da seguinte forma: arrayNode1.literal1 = 1000 arrayNode1.2000 = 2000 arrayNode1.literal3 = 3000 Se um objeto complexo for carregado em uma matriz, neste caso {"cdi1": 1}, o endpoint criará um novo nó virtual com o nome igual à sua posição. No exemplo acima, é 2000. Para inclusões, a posição está sempre vazia. Tipo de dados: cadeia de caracteres
versão_anterior	Detalhes da versão anterior do registro do nó. Nota: Se um novo nó tiver sido criado, o endpoint retornará "previous_version" = nulo para este parâmetro. Tipo de dados: objeto "previous_version": { "link": "String", "value": "String" }
versão_anterior.link	Sintaxe de chamada para consultar este registro de nó usando a API REST de tabela. Tipo de dados: cadeia de caracteres
valor_versão_anterior.	Sys_id do registro do nó. Tipo de dados: cadeia de caracteres Tabela: nó do CDM [sn_cdm_node]
motivo_para_conflito	Explicação detalhada do conflito. Tipo de dados: cadeia de caracteres
restrito_a	Detalhes do grupo que tem acesso ao associado ao nó. Tipo de dados: objeto "restricted_to": { "link": "String", "value": "String" }
restrito_para.link	Sintaxe de chamada para consultar este registro de grupo usando a API REST de tabela. Tipo de dados: cadeia de caracteres
restrito_para.valor	Sys_id do registro do grupo. Tipo de dados: cadeia de caracteres Tabela: grupo do CDM [sys_user_group]
valor_seguro	Se este valor foi sinalizado para ser protegido, o campo criptografado (retornou mascarado). Um usuário deve ter a função sn_cdm.cdm_secrets para descriptografar essas informações. Você pode direcionar o endpoint para não retornar esses campos definindo o campo de parâmetro de consulta returnFields. Tipo de dados: cadeia de caracteres
status	Status do nó. Valores possíveis: EXCLUÍDO NOVO SUBSTITUÍDO ATUALIZADO VÁLIDO Tipo de dados: cadeia de caracteres
pasta_do_sistema	Sinalizador que indica se o nó associado é uma pasta do sistema. Valores possíveis: verdadeiro: o nó é uma pasta do sistema. falso: o nó não é uma pasta do sistema. Tipo de dados: booliano
sys_class_name	Tabela na qual o nó reside. Tipo de dados: cadeia de caracteres
sys_created_by	Nome do usuário que criou o nó. Tipo de dados: cadeia de caracteres
sys_created_on	Data e hora em que o nó foi criado. Tipo de dados: cadeia de caracteres Formato: aaaa-mm-dd hh:mm:ss
sys_id	Sys_id do nó. Tipo de dados: cadeia de caracteres Tabela: nó do CDM [sn_cdm_node]
sys_updated_by	Nome do usuário que atualizou o nó. Tipo de dados: cadeia de caracteres
sys_updated_on	Data e hora em que o nó foi atualizado pela última vez. Tipo de dados: cadeia de caracteres Formato: aaaa-mm-dd hh:mm:ss
tipo	Tipo de nó. Valores possíveis: sn_cdm_node_cdi sn_cdm_node_collection sn_cdm_node_component sn_cdm_node_folder sn_cdm_node_variable Tipo de dados: cadeia de caracteres Padrão: todos
valor	Valor do nó. Tipo de dados: cadeia de caracteres

Solicitação de cURL

Este exemplo de código mostra como recuperar os nós secundários do tipo sn_cdm_node_cdi no nó primário /testApp/Fdeployables/Development_1.

curl "http://instance.servicenow.com/api/sn_cdm/editor/nodes?decryptPassword=true&name=cdi45&changesetNumber=Chset3&parentFullNamePath=%2FtestApp%2Fdeployables%2FDevelopment_1&type=sn_cdm_node_cdi" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Retornar resultado:

{ 
  "result": [ 
    { 
      "changeset_id": { 
        "value": "d403648653b70110a1d3ddeeff7b12c5", 
        "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/d403648653b70110a1d3ddeeff7b12c5" 
      }, 
      "node_path": "!$!+!,![:", 
      "description": null, 
      "sys_updated_on": "2022-06-30 09:24:07", 
      "type": "sn_cdm_node_cdi", 
      "sys_class_name": "sn_cdm_node", 
      "sys_id": "c93c7c1753981110a1d3ddeeff7b12c7", 
      "sys_updated_by": "admin", 
      "previous_version": null, 
      "sys_created_on": "2022-06-30 08:53:13", 
      "value": "cdcdc", 
      "effective_from": null, 
      "linked_to": null, 
      "sys_created_by": "admin", 
      "restricted_to": null, 
      "level": "3", 
      "conflict_type": null, 
      "main_id": "2869", 
      "effective_to": null, 
      "secure_value": null, 
      "node_classifier": "/application/deployables/env:Development", 
      "main_id_encoded": "[:", 
      "name": "cdi45", 
      "position": null, 
      "reason_for_conflict": null, 
      "system_folder": false, 
      "status": "new", 
      "conflict": false 
    } 
  ] 
}

CdmEditorApi – POST /sn_cdm/editor/includes

Inclui um nó existente em outro nó, como um nó de componente em um nó de coleção ou um nó de coleção em um nó implantável. Depois de incluir um nó, o novo nó tem seu próprio sys_id e main_Id exclusivos.

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}/editor/includes

URL padrão: /api/sn_cdm/editor/includes

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário 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 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
changesetNumber	Obrigatório. Número exclusivo do changeset aberto a ser incluído no nó de destino. 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 da coluna de registro, como sys_id, sys_updated_by ou state. Tipo de dados: matriz Padrão: todos os campos determinados pelo endpoint
sourceFullNamePath	Obrigatório. Nome do caminho do nó a ser incluído no nó de destino. Você pode passar o caminho do nome em qualquer um dos formatos a seguir. Por exemplo, para incluir o seguinte nó Staging/deployables/Development1/cdi1: Formato de barra invertida: Preparação/implantáveis/Desenvolvimento1/cdi1 Nota: Se o nome do nó contiver uma barra invertida ("/"), você não poderá usar este formato. Caminho do nome de back-end com caracteres de substituição: Preparação​implantáveis​​Desenvolvimento1​​​cdi1 Matriz: ['Staging','deployables','Development1','cdi1'] Tipo de dados: cadeia de caracteres
targetFullNamePath	Obrigatório. Nome do caminho do nó sob o qual o nó de origem será incluído. Você pode passar o caminho do nome em qualquer um dos formatos a seguir. Por exemplo, para incluir o seguinte nó Production/deployables/Development1: Formato de barra invertida: Produção/implantáveis/Desenvolvimento1/cdi1 Nota: Se o nome do nó contiver uma barra invertida ("/"), você não poderá usar este formato. Caminho do nome de back-end com caracteres de substituição: Produção​implantáveis​​Desenvolvimento1​​​cdi1 Matriz: ['Produção','implantáveis','Desenvolvimento1','cdi1'] Tipo de dados: cadeia de caracteres

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 do 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
changeset_id	Identificador exclusivo do changeset associado, como "Chset-10". Tipo de dados: cadeia de caracteres Tabela: CDMChangeset [sn_cdm_changeset]
conflito	Sinalizador que indica se houve um conflito ao processar o nó. Valores possíveis: verdadeiro: conflito detectado. falso: nenhum conflito foi detectado. Tipo de dados: booliano
tipo_conflito	Se o parâmetro conflict for verdadeiro, o tipo de conflito detectado. Nulo se nenhum conflito for detectado. Valores possíveis: nó_corrompido nó_excluído nó_duplicado incompleto_deleted_parent ref_excluído_incompleto incompleto_renamed_ref invalid_include descendente_órfão relacionado_conflito unlinked_include unrenamed_include update_node Tipo de dados: cadeia de caracteres
descrição	Descrição resumida da finalidade do nó. Tipo de dados: cadeia de caracteres
eficaz_de	Carimbo de data/hora (convertido em um número inteiro longo) quando o nó foi confirmado como parte do changeset. Se o nó não tiver sido confirmado, este valor será "nulo". Tipo de dados: número (inteiro)
eficaz_para	Carimbo de data/hora (convertido em um número inteiro longo) do nó quando ele foi excluído ou substituído por outro nó, caso contrário, "nulo". Tipo de dados: número (inteiro)
erro	Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: objeto "error": { "detail": "String", "message": "String" }
erro.detalhe	Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres
mensagem.erro	Mensagem de erro gerada ao tentar processar a solicitação. Tipo de dados: cadeia de caracteres
nível	Nível do nó, a partir do nó raiz, que é sempre 0. Por exemplo, o nó /AppA/components/compA tem dois níveis. Tipo de dados: cadeia de caracteres
vinculado_a	O parâmetro main_id do nó referenciado ao qual este nó está vinculado. Se este nó não estiver vinculado a um nó de referência, o valor será "nulo". Tipo de dados: cadeia de caracteres
main_id	Identificador primário do nó. Você pode usar este valor na inclusão de script CdmQuery() para recuperar uma árvore JSON. Por exemplo: CdmQuery().mainId('123')/query().getTree(); Tipo de dados: cadeia de caracteres
main_id_encoded	Representação de cadeia de caracteres RADIX 57 do parâmetro main_id do nó. Tipo de dados: cadeia de caracteres
nome	Nome do nó que foi incluído no caminho de destino. Tipo de dados: cadeia de caracteres
nó_classificador	Hierarquia de classificadores do nó. Use essas informações para localizar um nó na hierarquia de pastas. Por exemplo, um implantável teria uma hierarquia de /application/deployables/env:Development Enquanto uma coleção teria uma hierarquia de /aplicações/coleções Tipo de dados: cadeia de caracteres
nó_caminho	Nome do caminho completo do nó que foi incluído no caminho de destino, como /Production/deployables/Development1/cdi1. Tipo de dados: cadeia de caracteres
posição	Posição do nó. Por exemplo: se você carregar a seguinte matriz: arrayNode1: [ "literal1", {"cdi1": 1}, "literal3" ] Os valores de posição são definidos da seguinte forma: arrayNode1.literal1 = 1000 arrayNode1.2000 = 2000 arrayNode1.literal3 = 3000 Se um objeto complexo for carregado em uma matriz, neste caso {"cdi1": 1}, o endpoint criará um novo nó virtual com o nome igual à sua posição. No exemplo acima, é 2000. Para inclusões, a posição está sempre vazia. Tipo de dados: cadeia de caracteres
versão_anterior	Detalhes da versão anterior do registro do nó. Nota: Se um novo nó tiver sido criado, o endpoint retornará "previous_version" = nulo para este parâmetro. Tipo de dados: objeto "previous_version": { "link": "String", "value": "String" }
restrito_a	Detalhes do grupo que tem acesso ao associado ao nó. Tipo de dados: objeto "restricted_to": { "link": "String", "value": "String" }
valor_seguro	Se este valor foi sinalizado para ser protegido, o campo criptografado (retornou mascarado). Um usuário deve ter a função sn_cdm.cdm_secrets para descriptografar essas informações. Você pode direcionar o endpoint para não retornar esses campos definindo o campo de parâmetro de consulta returnFields. Tipo de dados: cadeia de caracteres
status	Status do nó. Valores possíveis: EXCLUÍDO NOVO SUBSTITUÍDO ATUALIZADO VÁLIDO Tipo de dados: cadeia de caracteres
sys_id	Sys_id do nó. Tipo de dados: cadeia de caracteres Tabela: nó do CDM [sn_cdm_node]
pasta_do_sistema	Sinalizador que indica se o nó associado é uma pasta do sistema. Valores possíveis: verdadeiro: o nó é uma pasta do sistema. falso: o nó não é uma pasta do sistema. Tipo de dados: booliano
tipo	Tipo de nó. Valores possíveis: sn_cdm_node_cdi sn_cdm_node_collection sn_cdm_node_component sn_cdm_node_folder sn_cdm_node_variable Tipo de dados: cadeia de caracteres
valor	Valor do nó. Tipo de dados: cadeia de caracteres

Solicitação de cURL

O exemplo de código a seguir mostra como incluir o nó /testApp/collections/collA em /testApp/deployables/Development_1.

curl "http://instance.servicenow.com/api/sn_cdm/editor/includes?changesetNumber=Chset5&targetFullNamePath=%2FtestApp%2Fdeployables%2FDevelopment_1&sourceFullNamePath=%2FtestApp%2Fcollecti
ons%2FcollA" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

Retornar resultado:

{ 
  "result": { 
    "changeset_id": { 
      "value": "d403648653b70110a1d3ddeeff7b12c5", 
      "link": "http://192.168.0.233:8080/api/now/table/sn_cdm_changeset/d403648653b70110a1d3ddeeff7b12c5" 
    }, 
    "node_path": "!$!+!,![?", 
    "description": null, 
    "sys_updated_on": "2022-06-30 09:19:47", 
    "type": "sn_cdm_node_linked", 
    "sys_class_name": "sn_cdm_node", 
    "sys_id": "1642015b53981110a1d3ddeeff7b1232", 
    "sys_updated_by": "admin", 
    "previous_version": null, 
    "sys_created_on": "2022-06-30 09:19:47", 
    "value": null, 
    "effective_from": null, 
    "linked_to": "2870", 
    "sys_created_by": "admin", 
    "restricted_to": null, 
    "level": "3", 
    "conflict_type": null, 
    "main_id": "2872", 
    "effective_to": null, 
    "secure_value": null, 
    "node_classifier": "/application/deployables/env:Development", 
    "main_id_encoded": "[?", 
    "name": "collA", 
    "position": null, 
    "reason_for_conflict": null, 
    "system_folder": false, 
    "status": "new", 
    "conflict": false 
  } 
}

CdmEditorApi – POST /sn_cdm/editor/nodes

Cria um tipo específico de nó, como componente, coleção, pasta, item de dados de configuração (CDI) ou variável.

Você também pode especificar se deseja gerar automaticamente quaisquer nós primários que não estejam definidos no momento.

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

Formato da URL

URL com controle de versões: /api/sn_cdm/{api_version}/editor/nodes

URL padrão: /api/sn_cdm/editor/nodes

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário 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 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
autoCreateParents	Sinalizador que indica se os primários não existentes devem ser criados automaticamente no caminho do nome como componentes. As exceções são app, implantável e coleção. Se você não definir este sinalizador e os primários ainda não existirem, o endpoint falhará. Valores válidos: verdadeiro: cria automaticamente os primários não existentes. falso: não cria automaticamente os primários não existentes. Tipo de dados: booliano Padrão: falso
changesetNumber	Obrigatório. Identificador exclusivo do changeset associado, como "Chset-10". Tipo de dados: cadeia de caracteres Tabela: CDMChangeset [sn_cdm_changeset]
fullNamePath	Obrigatório. Nome do caminho do nó. Você pode passar o caminho do nome em qualquer um dos formatos a seguir. Por exemplo, para definir o caminho do nome do nó testApp/deployables/Development1/cdi1: Formato de barra invertida: testApp/deployables/Development1/cdi1 Nota: Se o nome do nó contiver uma barra invertida ("/"), você não poderá usar este formato. Caminho do nome de back-end com caracteres de substituição: testApp​deployables​​Development1​​cdi1 Matriz: ['testApp','deployables','Development1','cdi1'] 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
seguro	Sinalizador que indica se o valor deve ser criptografado para os nós folha. Valores válidos: verdadeiro: criptografado falso: não criptografado Tipo de dados: booliano Padrão: falso
tipo	Obrigatório. Tipo de novo nó. Valores válidos: sn_cdm_node_collection OU coleção sn_cdm_node_component OU componente sn_cdm_node_folder OU pasta sn_cdm_node_cdi OU cdi sn_cdm_node_variable ou variável Tipo de dados: cadeia de caracteres
valor	Valor do novo nó. Tipo de dados: cadeia de caracteres Padrão: equivalente a "nulo"

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 do 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
changeset_id	Detalhes do registro do changeset associado ao nó. 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. Tipo de dados: cadeia de caracteres Tabela: conjunto de mudanças do CDM [sn_cdm_changeset]
conflito	Sinalizador que indica se houve um conflito ao processar o nó. Valores possíveis: verdadeiro: conflito detectado. falso: nenhum conflito foi detectado. Tipo de dados: booliano
tipo_conflito	Se o parâmetro conflict for verdadeiro, o tipo de conflito detectado. Nulo se nenhum conflito for detectado. Valores possíveis: nó_corrompido nó_excluído nó_duplicado incompleto_deleted_parent ref_excluído_incompleto incompleto_renamed_ref invalid_include descendente_órfão relacionado_conflito unlinked_include unrenamed_include update_node Tipo de dados: cadeia de caracteres
descrição	Descrição resumida da finalidade do nó. Tipo de dados: cadeia de caracteres
eficaz_de	Carimbo de data/hora (convertido em um número inteiro longo) quando o nó foi confirmado como parte do changeset. Se o nó não tiver sido confirmado, este valor será "nulo". Tipo de dados: número (inteiro)
eficaz_para	Carimbo de data/hora (convertido em um número inteiro longo) do nó quando ele foi excluído ou substituído por outro nó, caso contrário, "nulo". Tipo de dados: número (inteiro)
erro	Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: objeto "error": { "detail": "String", "message": "String" }
erro.detalhe	Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres
mensagem.erro	Mensagem de erro gerada ao tentar processar a solicitação. Tipo de dados: cadeia de caracteres
nível	Nível do nó, a partir do nó raiz, que é sempre 0. Por exemplo, o nó /AppA/components/compA tem dois níveis. Tipo de dados: cadeia de caracteres
vinculado_a	O parâmetro main_id do nó referenciado ao qual este nó está vinculado. Se este nó não estiver vinculado a um nó de referência, o valor será "nulo". Tipo de dados: cadeia de caracteres
main_id	Identificador primário do nó. Você pode usar este valor na inclusão de script CdmQuery() para recuperar uma árvore JSON. Por exemplo: CdmQuery().mainId('123')/query().getTree(); Tipo de dados: cadeia de caracteres
main_id_encoded	Representação de cadeia de caracteres RADIX 57 do parâmetro main_id do nó. Tipo de dados: cadeia de caracteres
nome	O nome do nó. Tipo de dados: cadeia de caracteres
nó_classificador	Hierarquia de classificadores do nó. Use essas informações para localizar um nó na hierarquia de pastas. Por exemplo, um implantável teria uma hierarquia de /application/deployables/env:Development Enquanto uma coleção teria uma hierarquia de /aplicações/coleções Tipo de dados: cadeia de caracteres
nó_caminho	Nome completo do caminho do nó. Tipo de dados: cadeia de caracteres
posição	Posição do nó. Por exemplo: se você carregar a seguinte matriz: arrayNode1: [ "literal1", {"cdi1": 1}, "literal3" ] Os valores de posição são definidos da seguinte forma: arrayNode1.literal1 = 1000 arrayNode1.2000 = 2000 arrayNode1.literal3 = 3000 Se um objeto complexo for carregado em uma matriz, neste caso {"cdi1": 1}, o endpoint criará um novo nó virtual com o nome igual à sua posição. No exemplo acima, é 2000. Para inclusões, a posição está sempre vazia. Tipo de dados: cadeia de caracteres
versão_anterior	Detalhes da versão anterior do registro do nó. Nota: Se um novo nó tiver sido criado, o endpoint retornará "previous_version" = nulo para este parâmetro. Tipo de dados: objeto "previous_version": { "link": "String", "value": "String" }
versão_anterior.link	Sintaxe de chamada para consultar este registro de nó usando a API REST de tabela. Tipo de dados: cadeia de caracteres
valor_versão_anterior.	Sys_id do registro do nó. Tipo de dados: cadeia de caracteres Tabela: nó do CDM [sn_cdm_node]
motivo_para_conflito	Explicação detalhada do conflito. Tipo de dados: cadeia de caracteres
restrito_a	Detalhes do grupo que tem acesso ao associado ao nó. Tipo de dados: objeto "restricted_to": { "link": "String", "value": "String" }
restrito_para.link	Sintaxe de chamada para consultar este registro de grupo usando a API REST de tabela. Tipo de dados: cadeia de caracteres
restrito_para.valor	Sys_id do registro do grupo. Tipo de dados: cadeia de caracteres Tabela: grupo do CDM [sys_user_group]
valor_seguro	Se este valor foi sinalizado para ser protegido, o campo criptografado (retornou mascarado). Um usuário deve ter a função sn_cdm.cdm_secrets para descriptografar essas informações. Você pode direcionar o endpoint para não retornar esses campos definindo o campo de parâmetro de consulta returnFields. Tipo de dados: cadeia de caracteres
status	Status do nó. Valores possíveis: EXCLUÍDO NOVO SUBSTITUÍDO ATUALIZADO VÁLIDO Tipo de dados: cadeia de caracteres
pasta_do_sistema	Sinalizador que indica se o nó associado é uma pasta do sistema. Valores possíveis: verdadeiro: o nó é uma pasta do sistema. falso: o nó não é uma pasta do sistema. Tipo de dados: booliano
sys_class_name	Tabela na qual o nó reside. Tipo de dados: cadeia de caracteres
sys_created_by	Nome do usuário que criou o nó. Tipo de dados: cadeia de caracteres
sys_created_on	Data e hora em que o nó foi criado. Tipo de dados: cadeia de caracteres Formato: aaaa-mm-dd hh:mm:ss
sys_id	Sys_id do nó. Tipo de dados: cadeia de caracteres Tabela: nó do CDM [sn_cdm_node]
sys_updated_by	Nome do usuário que atualizou o nó. Tipo de dados: cadeia de caracteres
sys_updated_on	Data e hora em que o nó foi atualizado pela última vez. Tipo de dados: cadeia de caracteres Formato: aaaa-mm-dd hh:mm:ss
tipo	Tipo de nó. Valores possíveis: sn_cdm_node_cdi sn_cdm_node_collection sn_cdm_node_component sn_cdm_node_folder sn_cdm_node_variable Tipo de dados: cadeia de caracteres Padrão: todos
valor	Valor do nó. Tipo de dados: cadeia de caracteres

Solicitação de cURL

O exemplo de código a seguir mostra como criar um nó usando este endpoint.

curl "http://instance.servicenow.com/api/sn_cdm/editor/nodes?fullNamePath=%2FtestApp%2Fdeployables%2FDevelopment1%2Fcdi1&secure=true&value=someVal&type=cdi&changesetNumber=Chset-760" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

Retornar resultado:

{ 
  "result": { 
    "changeset_id": { 
      "value": "d403648653b70110a1d3ddeeff7b12c5", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/d403648653b70110a1d3ddeeff7b12c5" 
    }, 
    "node_path": "!$!+!,![:", 
    "description": null, 
    "sys_updated_on": "2022-06-30 08:53:13", 
    "type": "sn_cdm_node_cdi", 
    "sys_class_name": "sn_cdm_node", 
    "sys_id": "c93c7c1753981110a1d3ddeeff7b12c7", 
    "sys_updated_by": "admin", 
    "previous_version": null, 
    "sys_created_on": "2022-06-30 08:53:13", 
    "value": null, 
    "effective_from": null, 
    "linked_to": null, 
    "sys_created_by": "admin", 
    "restricted_to": null, 
    "level": "3", 
    "conflict_type": null, 
    "main_id": "2869", 
    "effective_to": null, 
    "secure_value": "﷞﷟﷒113a0c6e53001110a1d3ddeeff7b121d﷬﷔1﷬﷭bAUA1wj-fxofbSrMyF-BAg==6qiho5f_9DhnuHT2Km5SLf0Ck4XNX_w=﷮﷯", 
    "node_classifier": "/application/deployables/env:Development", 
    "main_id_encoded": "[:", 
    "name": "cdi45", 
    "position": null, 
    "reason_for_conflict": null, 
    "system_folder": false, 
    "status": "new", 
    "conflict": false 
  } 
}

CdmEditorApi – PUT /sn_cdm/editor/nodes

Atualiza o nome e/ou o valor de um nó especificado.

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

Formato da URL

URL com controle de versões: /api/sn_cdm/{api_version}/editor/nodes

URL padrão: /api/sn_cdm/editor/nodes

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário 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 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
changesetNumber	Obrigatório. Identificador exclusivo do changeset associado, como "Chset-10". Tipo de dados: cadeia de caracteres Tabela: CDMChangeset [sn_cdm_changeset]
fullNamePath	Obrigatório. Nome do caminho do nó. Você pode passar o caminho do nome em qualquer um dos formatos a seguir. Por exemplo, para definir o caminho do nome do nó testApp/deployables/Development1/cdi1: Formato de barra invertida: testApp/deployables/Development1/cdi1 Nota: Se o nome do nó contiver uma barra invertida ("/"), você não poderá usar este formato. Caminho do nome de back-end com caracteres de substituição: testApp​deployables​​Development1​​cdi1 Matriz: ['testApp','deployables','Development1','cdi1'] Tipo de dados: cadeia de caracteres
novoNome	Novo nome para o nó associado. Tipo de dados: cadeia de caracteres
newValue	Novo valor para o nó associado. Tipo de dados: cadeia de caracteres
seguro	Sinalizador que indica se o valor deve ser criptografado para os nós folha. Valores válidos: verdadeiro: criptografado falso: não criptografado Tipo de dados: booliano Padrão: falso
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 do 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
changeset_id	Detalhes do registro do changeset associado ao nó. 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. Tipo de dados: cadeia de caracteres Tabela: conjunto de mudanças do CDM [sn_cdm_changeset]
conflito	Sinalizador que indica se houve um conflito ao processar o nó. Valores possíveis: verdadeiro: conflito detectado. falso: nenhum conflito foi detectado. Tipo de dados: booliano
tipo_conflito	Se o parâmetro conflict for verdadeiro, o tipo de conflito detectado. Nulo se nenhum conflito for detectado. Valores possíveis: nó_corrompido nó_excluído nó_duplicado incompleto_deleted_parent ref_excluído_incompleto incompleto_renamed_ref invalid_include descendente_órfão relacionado_conflito unlinked_include unrenamed_include update_node Tipo de dados: cadeia de caracteres
descrição	Descrição resumida da finalidade do nó. Tipo de dados: cadeia de caracteres
eficaz_de	Carimbo de data/hora (convertido em um número inteiro longo) quando o nó foi confirmado como parte do changeset. Se o nó não tiver sido confirmado, este valor será "nulo". Tipo de dados: número (inteiro)
eficaz_para	Carimbo de data/hora (convertido em um número inteiro longo) do nó quando ele foi excluído ou substituído por outro nó, caso contrário, "nulo". Tipo de dados: número (inteiro)
erro	Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: objeto "error": { "detail": "String", "message": "String" }
erro.detalhe	Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres
mensagem.erro	Mensagem de erro gerada ao tentar processar a solicitação. Tipo de dados: cadeia de caracteres
nível	Nível do nó, a partir do nó raiz, que é sempre 0. Por exemplo, o nó /AppA/components/compA tem dois níveis. Tipo de dados: cadeia de caracteres
vinculado_a	O parâmetro main_id do nó referenciado ao qual este nó está vinculado. Se este nó não estiver vinculado a um nó de referência, o valor será "nulo". Tipo de dados: cadeia de caracteres
main_id	Identificador primário do nó. Você pode usar este valor na inclusão de script CdmQuery() para recuperar uma árvore JSON. Por exemplo: CdmQuery().mainId('123')/query().getTree(); Tipo de dados: cadeia de caracteres
main_id_encoded	Representação de cadeia de caracteres RADIX 57 do parâmetro main_id do nó. Tipo de dados: cadeia de caracteres
nome	O nome do nó. Tipo de dados: cadeia de caracteres
nó_classificador	Hierarquia de classificadores do nó. Use essas informações para localizar um nó na hierarquia de pastas. Por exemplo, um implantável teria uma hierarquia de /application/deployables/env:Development Enquanto uma coleção teria uma hierarquia de /aplicações/coleções Tipo de dados: cadeia de caracteres
nó_caminho	Nome completo do caminho do nó. Tipo de dados: cadeia de caracteres
posição	Posição do nó. Por exemplo: se você carregar a seguinte matriz: arrayNode1: [ "literal1", {"cdi1": 1}, "literal3" ] Os valores de posição são definidos da seguinte forma: arrayNode1.literal1 = 1000 arrayNode1.2000 = 2000 arrayNode1.literal3 = 3000 Se um objeto complexo for carregado em uma matriz, neste caso {"cdi1": 1}, o endpoint criará um novo nó virtual com o nome igual à sua posição. No exemplo acima, é 2000. Para inclusões, a posição está sempre vazia. Tipo de dados: cadeia de caracteres
versão_anterior	Detalhes da versão anterior do registro do nó. Nota: Se um novo nó tiver sido criado, o endpoint retornará "previous_version" = nulo para este parâmetro. Tipo de dados: objeto "previous_version": { "link": "String", "value": "String" }
versão_anterior.link	Sintaxe de chamada para consultar este registro de nó usando a API REST de tabela. Tipo de dados: cadeia de caracteres
valor_versão_anterior.	Sys_id do registro do nó. Tipo de dados: cadeia de caracteres Tabela: nó do CDM [sn_cdm_node]
motivo_para_conflito	Explicação detalhada do conflito. Tipo de dados: cadeia de caracteres
restrito_a	Detalhes do grupo que tem acesso ao associado ao nó. Tipo de dados: objeto "restricted_to": { "link": "String", "value": "String" }
restrito_para.link	Sintaxe de chamada para consultar este registro de grupo usando a API REST de tabela. Tipo de dados: cadeia de caracteres
restrito_para.valor	Sys_id do registro do grupo. Tipo de dados: cadeia de caracteres Tabela: grupo do CDM [sys_user_group]
valor_seguro	Se este valor foi sinalizado para ser protegido, o campo criptografado (retornou mascarado). Um usuário deve ter a função sn_cdm.cdm_secrets para descriptografar essas informações. Você pode direcionar o endpoint para não retornar esses campos definindo o campo de parâmetro de consulta returnFields. Tipo de dados: cadeia de caracteres
status	Status do nó. Valores possíveis: EXCLUÍDO NOVO SUBSTITUÍDO ATUALIZADO VÁLIDO Tipo de dados: cadeia de caracteres
pasta_do_sistema	Sinalizador que indica se o nó associado é uma pasta do sistema. Valores possíveis: verdadeiro: o nó é uma pasta do sistema. falso: o nó não é uma pasta do sistema. Tipo de dados: booliano
sys_class_name	Tabela na qual o nó reside. Tipo de dados: cadeia de caracteres
sys_created_by	Nome do usuário que criou o nó. Tipo de dados: cadeia de caracteres
sys_created_on	Data e hora em que o nó foi criado. Tipo de dados: cadeia de caracteres Formato: aaaa-mm-dd hh:mm:ss
sys_id	Sys_id do nó. Tipo de dados: cadeia de caracteres Tabela: nó do CDM [sn_cdm_node]
sys_updated_by	Nome do usuário que atualizou o nó. Tipo de dados: cadeia de caracteres
sys_updated_on	Data e hora em que o nó foi atualizado pela última vez. Tipo de dados: cadeia de caracteres Formato: aaaa-mm-dd hh:mm:ss
tipo	Tipo de nó. Valores possíveis: sn_cdm_node_cdi sn_cdm_node_collection sn_cdm_node_component sn_cdm_node_folder sn_cdm_node_variable Tipo de dados: cadeia de caracteres Padrão: todos
valor	Valor do nó. Tipo de dados: cadeia de caracteres

Solicitação de cURL

O exemplo de código a seguir mostra como atualizar o valor de um nó.

curl "http://instance.servicenow.com/api/sn_cdm/editor/nodes?newValue=cdcdc&fullNamePath=%2FtestApp%2Fdeployables%2FDe
velopment-1%2Fcdi45&changesetNumber=Chset-5" \
--request PUT \
--header "Accept:application/json" \
--user 'username':'password'

Retornar resultado:

{ 
  "result": { 
    "changeset_id": { 
      "value": "d403648653b70110a1d3ddeeff7b12c5", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/d403648653b70110a1d3ddeeff7b12c5" 
    }, 
    "node_path": "!$!+!,![:", 
    "description": null, 
    "sys_updated_on": "2022-06-30 08:53:13", 
    "type": "sn_cdm_node_cdi", 
    "sys_class_name": "sn_cdm_node", 
    "sys_id": "c93c7c1753981110a1d3ddeeff7b12c7", 
    "sys_updated_by": "admin", 
    "previous_version": null, 
    "sys_created_on": "2022-06-30 08:53:13", 
    "value": null, 
    "effective_from": null, 
    "linked_to": null, 
    "sys_created_by": "admin", 
    "restricted_to": null, 
    "level": "3", 
    "conflict_type": null, 
    "main_id": "2869", 
    "effective_to": null, 
    "secure_value": "﷞﷟﷒113a0c6e53001110a1d3ddeeff7b121d﷬﷔1﷬﷭bAUA1wj-fxofbSrMyF-BAg==6qiho5f_9DhnuHT2Km5SLf0Ck4XNX_w=﷮﷯", 
    "node_classifier": "/application/deployables/env:Development", 
    "main_id_encoded": "[:", 
    "name": "cdi45", 
    "position": null, 
    "reason_for_conflict": null, 
    "system_folder": false, 
    "status": "new", 
    "conflict": false 
  } 
}