APICdmPolicies

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 18 min. de leitura

    • A CdmPoliciesApi fornece endpoints que permitem gerenciar mapeamentos de política de implantáveis em Gestão de dados de configuração (CDM). As políticas que são mapeadas corretamente para um implantável são executadas quando um snapshot do implantável é validado.

    Você deve ter uma das seguintes funções para acessar os endpoints nesta API:
    • ACL de exibição do CDM REST de script
    • ACL de administrador do CDM de REST de script

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

    Para obter informações adicionais sobre mapeamentos de políticas, consulte Mapear políticas para um implantável.

    CdmPoliciesApi - DELETE /sn_cdm/policies/mappings

    Exclui o mapeamento de uma política especificada para um implantável.

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

    Formato da URL

    URL com controle de versões: /api/sn_cdm/{api_version}/policies/mappings

    URL padrão: /api/sn_cdm/policies/mappings

    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
    appName Obrigatório. Nome da aplicação Gestão de dados de configuração (CDM) para a qual o mapeamento para a política será removido.

    Tipo de dados: cadeia de caracteres

    Tabela: aplicação de CDM [sn_cdm_application]
    implantávelNome Obrigatório. Nome do implantável do CDM para o qual o mapeamento para a política será removido.

    Tipo de dados: cadeia de caracteres

    Tabela: CDM implantável [sn_cdm_deployable]
    policyName Obrigatório. Nome da política associada.

    Tipo de dados: cadeia de caracteres

    Tabela: política [sn_pace_policy]
    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. Tipos compatíveis: application/json ou application/xml.

    Padrão: 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. O parâmetro policyName passado é inválido.
    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
    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

    Solicitação de cURL

    O exemplo de código a seguir mostra como remover um mapeamento de política.

    curl "http://instance.servicenow.com/api/sn_cdm/policies/mappings?deployableName=Development_1&policyName=testALPolicy1&appName=testApp" \ 
--request DELETE \ 
--header "Accept:application/json" \ 
--user 'username':'password'

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

    None - results defined by the HTTP status code

    CdmPoliciesApi – GET /sn_cdm/policies/mappings/inputs/resolved

    Retorna as entradas resolvidas para um mapeamento de política especificado de um implantável.

    Para obter informações adicionais sobre mapeamentos de políticas, consulte Mapear políticas para um implantável e Validação e correção de dados de configuração.

    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}/policies/mappings/inputs/resolved

    URL padrão: /api/sn_cdm/policies/mappings/inputs/resolved

    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
    appName Obrigatório. Nome da aplicação Gestão de dados de configuração (CDM) associada ao implantável para o qual as entradas de política resolvidas serão retornadas.

    Tipo de dados: cadeia de caracteres

    Tabela: aplicação de CDM [sn_cdm_application]
    implantávelNome Obrigatório. Nome do implantável do CDM para o qual a política resolvida será retornada.

    Tipo de dados: cadeia de caracteres

    Tabela: CDM implantável [sn_cdm_deployable]
    policyName Obrigatório. Nome da política associada.

    Tipo de dados: cadeia de caracteres

    Tabela: política [sn_pace_policy]
    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. Tipos compatíveis: application/json ou application/xml.

    Padrão: 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. O parâmetro policyName passado é inválido.
    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
    resultado Lista de pares nome-valor de todas as entradas resolvidas para o mapeamento de política especificado.

    Por exemplo: {"input_name": "user_1", "input_password": "" }

    Tipo de dados: objeto

    Solicitação de cURL

    O exemplo a seguir mostra como usar este endpoint para obter as entradas de política resolvidas.

    curl "http://instance.servicenow.com/api/sn_cdm/policies/mappings/inputs/resolved?policyName=testALPolicy1&deployableName=Development_1&appName=testApp" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Retornar resultado:

    { 
  "result": { 
    "key1": "someVal", 
    "additionalDeployablesInput": "[{\"id\":\"e7e34a531b501110636e0fe0604bcba9\",\"label\":\"testApp-Development_2\"}]" 
  } 
}

    CdmPoliciesApi - POST /sn_cdm/policies/mappings

    Mapeia uma política especificada para um implantável.

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

    Formato da URL

    URL com controle de versões: /api/sn_cdm/{api_version}/policies/mappings

    URL padrão: /api/sn_cdm/policies/mappings

    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
    appName Obrigatório. Nome da aplicação Gestão de dados de configuração (CDM) para a qual a política será mapeada.

    Tipo de dados: cadeia de caracteres

    Tabela: aplicação de CDM [sn_cdm_application]
    implantávelNome Obrigatório. Nome do implantável do CDM para o qual a política será mapeada.

    Tipo de dados: cadeia de caracteres

    Tabela: CDM implantável [sn_cdm_deployable]
    policyName Obrigatório. Nome da política associada.

    Tipo de dados: cadeia de caracteres

    Tabela: política [sn_pace_policy]
    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 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.
    Tipo de conteúdo Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.
    Tabela 17. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

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

    Tabela 18. Códigos de status
    Código 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
    descrição Descrição do mapeamento.

    Tipo de dados: cadeia de caracteres
    documento Sys_id do documento.

    Tipo de dados: cadeia de caracteres
    document_ref Detalhes do registro document_ref associado ao nó.

    Tipo de dados: objeto

    "document_ref": {
  "link": "String",
  "value": "String"
}
    document_ref.link Sintaxe de chamada para consultar o registro implantável mapeado para a política usando a API REST de tabela.

    PaCE usa este campo para armazenar a referência ao implantável que está mapeado para uma política.

    Tipo de dados: cadeia de caracteres
    document_ref.sys_id Sys_id do registro implantável mapeado para a política.

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

    Tipo de dados: objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    erro.detalhe Informações adicionais sobre o erro.

    Tipo de dados: cadeia de caracteres
    mensagem.erro Mensagem de erro gerada ao tentar processar a solicitação.

    Tipo de dados: cadeia de caracteres
    exceção Se houver uma exceção ao tentar executar o mapeamento, o link para o registro de exceção.

    Tipo de dados: cadeia de caracteres
    exceção_permitida Sinalizador que indica se exceções são permitidas para a política.
    Valores possíveis:
    • verdadeiro: exceções são permitidas.
    • falso: exceções não são permitidas.

    Tipo de dados: booliano
    status_de_entrada Status das entradas.
    Valores possíveis:
    • inválida
    • válido

    Tipo de dados: cadeia de caracteres
    última_atualizada_por Detalhes do usuário que atualizou o mapeamento de política pela última vez.

    Tipo de dados: objeto

    "last_updated_by": {
  "link": "String",
  "value": "String"
}
    último_atualizado_por.link Sintaxe de chamada para consultar o registro do usuário usando a REST API de tabela.

    Tipo de dados: cadeia de caracteres
    last_updated_by.sys_id Sys_id do registro do usuário.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    número Número exclusivo que identifica o mapeamento. Este valor fornece um identificador legível para o mapeamento.

    Tipo de dados: cadeia de caracteres
    política Detalhes do registro de política associado ao mapeamento.

    Tipo de dados: objeto

    "policy": {
  "link": "String",
  "value": "String"
}
    policy.link Sintaxe de chamada para consultar o registro de política mapeado para a política usando a API REST de tabela.

    Tipo de dados: cadeia de caracteres
    policy.sys_id Sys_id do registro de política.

    Tipo de dados: cadeia de caracteres

    Tabela: política [sn_pace_policy]
    motivo Descrição do motivo do estado atual.

    Tipo de dados: cadeia de caracteres
    estado Estado atual do mapeamento.
    Valores possíveis:
    • ativo
    • inativo

    Tipo de dados: cadeia de caracteres
    sys_class_name Nome da tabela do mapeamento de política.

    Tipo de dados: cadeia de caracteres
    sys_created_by Nome do usuário que criou o mapeamento.

    Tipo de dados: cadeia de caracteres
    sys_created_on Data e hora em que o mapeamento foi criado.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd hh:mm:ss
    sys_id Sys_id do mapeamento.

    Tipo de dados: cadeia de caracteres

    Tabela: Mapeamento de políticas [sn_pace_policy_mapping]
    sys_updated_by Nome do usuário que atualizou o mapeamento.

    Tipo de dados: cadeia de caracteres
    sys_updated_on Data e hora em que o mapeamento foi atualizado pela última vez.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd hh:mm:ss

    Solicitação de cURL

    Este exemplo de código mostra como mapear uma política específica para um implantável.

    curl "http://instance.servicenow.com/api/sn_cdm/policies/mappings?appName=testApp&deployableName=Development_1&policyName=testALPolicy1" \ 
--request POST \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Retornar resultados:

    { 
  "result": { 
    "exception": null, 
    "reason": null, 
    "exception_allowed": "--", 
    "document": "0be34a531b501110636e0fe0604bcb21", 
    "input_status": "valid", 
    "description": null, 
    "sys_updated_on": "2022-06-30 14:07:37", 
    "sys_class_name": "sn_cdm_pace_policy_mapping", 
    "sys_id": "ea24469f1b101110636e0fe0604bcbed", 
    "number": "MAP0001001", 
    "last_updated_by": { 
      "value": "48630e131b501110636e0fe0604bcb53", 
      "link": "https://instance.servicenow.com/api/now/table/sys_user/48630e131b501110636e0fe0604bcb53" 
    }, 
    "sys_updated_by": "admin", 
    "sys_created_on": "2022-06-30 14:07:37", 
    "document_ref": { 
      "value": "0be34a531b501110636e0fe0604bcb21", 
      "link": "https://instance.servicenow.com/api/now/table/sn_cdm_deployable/0be34a531b501110636e0fe0604bcb21" 
    }, 
    "state": "active", 
    "sys_created_by": "admin", 
    "policy": { 
      "value": "12a3c2531b501110636e0fe0604bcb9b", 
      "link": "https://instance.servicenow.com/api/now/table/sn_pace_policy/12a3c2531b501110636e0fe0604bcb9b" 
    } 
  } 
}

    CdmPoliciesApi – PUT /sn_cdm/policies/mappings/inputs/additional-deployables

    Atualiza a variável de entrada additionalDeployablesInput de um mapeamento de política Gestão de dados de configuração (CDM).

    A variável de entrada additionalDeployablesInput contém os implantáveis adicionais que você pode atribuir a um mapeamento de política existente. Eles são semelhantes às entradas de mapeamento, mas têm uma estrutura de matriz específica.

    Para obter informações adicionais sobre mapeamentos de políticas, consulte Mapear políticas para um implantável.

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

    Formato da URL

    URL com controle de versão: /api/sn_cdm/{api_version}/policies/mappings/inputs/additional-deployables

    URL padrão: /api/sn_cdm/policies/mappings/inputs/additional-deployables

    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
    adicionaisImplantáveis Obrigatório. Lista de implantáveis a serem adicionados à variável de entrada additionalDeployablesInput.

    Tipo de dados: matriz de objetos

    "additionalDeployables": [
  {
    "appName": "String", 
    "deployableName": "String"
  }
]
    adicionaisImplantáveis.appName Obrigatório. Nome da aplicação de CDM à qual o implantável está associado.

    Tipo de dados: cadeia de caracteres

    Tabela: aplicação de CDM [sn_cdm_application]
    implantáveisadicionais.NomeImplantável Obrigatório. Nome do implantável do CDM a ser adicionado à variável de entrada additionalDeployablesInput.

    Tipo de dados: cadeia de caracteres

    Tabela: CDM implantável [sn_cdm_deployable]
    appName Obrigatório. Nome da aplicação de CDM para a qual a variável de entrada additionalDeployablesInput será atualizada.

    Tipo de dados: cadeia de caracteres

    Tabela: aplicação de CDM [sn_cdm_application]
    implantávelNome Obrigatório. Nome do implantável do CDM para o qual a variável de entrada additionalDeployablesInput será atualizada.

    Tipo de dados: cadeia de caracteres

    Tabela: CDM implantável [sn_cdm_deployable]
    policyName Obrigatório. Nome da política associada.

    Tipo de dados: cadeia de caracteres

    Tabela: política [sn_pace_policy]
    returnFields Lista de campos a serem retornados como parte da resposta. Passe os nomes da coluna de registro, como sys_id, sys_updated_by ou state.

    Tipo de dados: matriz

    Padrão: todos os campos determinados pelo endpoint
    Tabela 21. Parâmetros do corpo da solicitação
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

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

    Tabela 22. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tipo de conteúdo Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.
    Tabela 23. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

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

    Tabela 24. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. O parâmetro policyName passado é inválido.
    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
    io_definition Detalhes sobre o registro de definição de E/S PaCE associado.

    Para obter informações adicionais sobre PaCE, consulte Policy as Code Engine (PaCE).

    Tipo de dados: objeto

    "io_definition": {
  "link": "String",
  "value": "String"
}
    io_definition.link Sintaxe de chamada para consultar este PaCE registro de definição de E/S usando a API REST de tabela.

    Tipo de dados: cadeia de caracteres
    io_definition.value Sys_id do PaCE registro de definição de E/S.

    Tipo de dados: cadeia de caracteres

    Tabela: mapeamento de E/S [sn_pace_io_mapping]
    is_unused Sinalizador que indica se a variável de entrada de mapeamento não está sendo usada.
    Valores possíveis:
    • verdadeiro: a variável de entrada de mapeamento associada não é usada no momento.
    • falso: a variável de entrada de mapeamento associada é usada no momento.

    Tipo de dados: booliano
    map_value Valor atual da variável de entrada de mapeamento.

    Tipo de dados: matriz de objetos ou cadeia de caracteres
    policy_mapping Detalhes sobre o registro de mapeamento de política PaCE.

    Para obter informações adicionais sobre PaCE, consulte Policy as Code Engine (PaCE).

    Tipo de dados: objeto

    "policy_mapping": {
  "link": "String",
  "value": "String"
}
    policy_mapping.link Sintaxe de chamada para consultar o registro de mapeamento de política usando a API REST de tabela.

    Tipo de dados: cadeia de caracteres
    policy_mapping.value Sys_id do registro de mapeamento de política PaCE.

    Tipo de dados: cadeia de caracteres

    Tabela: Mapeamento de políticas [sn_pace_policy_mapping]
    sys_created_by Nome do usuário que criou a variável de entrada de mapeamento.

    Tipo de dados: cadeia de caracteres
    sys_created_on Data e hora em que a variável de entrada de mapeamento foi criada.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd hh:mm:ss
    sys_id Sys_id do registro de mapeamento associado.

    Tipo de dados: cadeia de caracteres

    Tabela: mapeamento de E/S [sn_pace_io_mapping]
    sys_updated_by Nome do usuário que atualizou a variável de entrada de mapeamento.

    Tipo de dados: cadeia de caracteres
    sys_updated_on Data e hora em que a variável de entrada de mapeamento foi atualizada pela última vez.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd hh:mm:ss

    Solicitação de cURL

    O exemplo a seguir mostra como adicionar implantáveis a uma variável de entrada additionalDeployablesInput.

    curl "https://instance.servicenow.com/api/sn_cdm/policies/mappings/inputs/additional-deployables?additionalDeployables=%5B%7B%22appName%22%3A%20%22testApp%22%2C%20%22deployableName%22%3A%22Development_2%22%7D%5D&policyName=testALPolicy1&deployableName=Development_1&appName=testApp" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--user 'admin':'admin

    Retornar resultado:

    { 
  "result": { 
    "sys_id": "6bb746171b501110636e0fe0604bcb1c", 
    "policy_mapping": { 
      "value": "6bb746171b501110636e0fe0604bcb1b", 
      "link": "https://instance.servicenow.com/api/now/table/sn_cdm_pace_policy_mapping/6bb746171b501110636e0fe0604bcb1b" 
    }, 
    "sys_updated_by": "ameya", 
    "sys_created_on": "2022-06-30 14:23:15", 
    "io_definition": { 
      "value": "4d0b061b1b501110636e0fe0604bcb2f", 
      "link": "https://instance.servicenow.com/api/now/table/sn_pace_io_definition/4d0b061b1b501110636e0fe0604bcb2f" 
    }, 
    "mapped_value": "[{\"id\":\"e7e34a531b501110636e0fe0604bcba9\",\"label\":\"testApp-Development_2\"}]", 
    "sys_updated_on": "2022-06-30 14:53:21", 
    "sys_created_by": "ameya", 
    "is_unused": false 
  } 
}

    CdmPoliciesApi – PUT /sn_cdm/policies/mappings/inputs

    Atualiza uma variável de entrada especificada para um mapeamento de política Gestão de dados de configuração (CDM).

    Para obter informações adicionais sobre mapeamentos de políticas, consulte Mapear políticas para um implantável.

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

    Formato da URL

    URL com controle de versões: /api/sn_cdm/{api_version}/policies/mappings/inputs

    URL padrão: /api/sn_cdm/policies/mappings/inputs

    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
    appName Obrigatório. Nome da aplicação de CDM para a qual as entradas de mapeamento de política serão atualizadas.

    Tipo de dados: cadeia de caracteres

    Tabela: aplicação de CDM [sn_cdm_application]
    implantávelNome Obrigatório. Nome do implantável do CDM para o qual as entradas de mapeamento de política serão atualizadas.

    Tipo de dados: cadeia de caracteres

    Tabela: CDM implantável [sn_cdm_deployable]
    nomeDeEntrada Obrigatório. Nome da variável de entrada a ser atualizada.

    Tipo de dados: cadeia de caracteres

    Tabela: mapeamento de E/S [sn_pace_io_mapping]
    ValorDeEntrada Obrigatório. Valor a ser atribuído à variável de entrada.

    Tipo de dados: dependente da variável de entrada. Você pode encontrar o tipo de dados na tabela Mapeamento de E/S [sn_pace_io_mapping].
    policyName Obrigatório. Nome da política associada.

    Tipo de dados: cadeia de caracteres

    Tabela: política [sn_pace_policy]
    returnFields Lista de campos a serem retornados como parte da resposta. Passe os nomes da coluna de registro, como sys_id, sys_updated_by ou state.

    Tipo de dados: matriz

    Padrão: todos os campos determinados pelo endpoint
    Tabela 27. Parâmetros do corpo da solicitação
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

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

    Tabela 28. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tipo de conteúdo Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.
    Tabela 29. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

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

    Tabela 30. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. O parâmetro policyName passado é inválido.
    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
    io_definition Detalhes sobre o registro de definição de E/S PaCE associado.

    Para obter informações adicionais sobre PaCE, consulte Policy as Code Engine (PaCE).

    Tipo de dados: objeto

    "io_definition": {
  "link": "String",
  "value": "String"
}
    io_definition.link Sintaxe de chamada para consultar este PaCE registro de definição de E/S usando a API REST de tabela.

    Tipo de dados: cadeia de caracteres
    io_definition.value Sys_id do PaCE registro de definição de E/S.

    Tipo de dados: cadeia de caracteres

    Tabela: mapeamento de E/S [sn_pace_io_mapping]
    is_unused Sinalizador que indica se a variável de entrada de mapeamento não está sendo usada.
    Valores possíveis:
    • verdadeiro: a variável de entrada de mapeamento associada não é usada no momento.
    • falso: a variável de entrada de mapeamento associada é usada no momento.

    Tipo de dados: booliano
    map_value Valor atual da variável de entrada de mapeamento.

    Tipo de dados: matriz de objetos ou cadeia de caracteres
    policy_mapping Detalhes sobre o registro de mapeamento de política PaCE.

    Para obter informações adicionais sobre PaCE, consulte Policy as Code Engine (PaCE).

    Tipo de dados: objeto

    "policy_mapping": {
  "link": "String",
  "value": "String"
}
    policy_mapping.link Sintaxe de chamada para consultar o registro de mapeamento de política usando a API REST de tabela.

    Tipo de dados: cadeia de caracteres
    policy_mapping.value Sys_id do registro de mapeamento de política PaCE.

    Tipo de dados: cadeia de caracteres

    Tabela: Mapeamento de políticas [sn_pace_policy_mapping]
    sys_created_by Nome do usuário que criou a variável de entrada de mapeamento.

    Tipo de dados: cadeia de caracteres
    sys_created_on Data e hora em que a variável de entrada de mapeamento foi criada.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd hh:mm:ss
    sys_id Sys_id do registro de mapeamento associado.

    Tipo de dados: cadeia de caracteres

    Tabela: mapeamento de E/S [sn_pace_io_mapping]
    sys_updated_by Nome do usuário que atualizou a variável de entrada de mapeamento.

    Tipo de dados: cadeia de caracteres
    sys_updated_on Data e hora em que a variável de entrada de mapeamento foi atualizada pela última vez.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd hh:mm:ss

    Solicitação de cURL

    O exemplo a seguir mostra como atualizar a variável de entrada key1 associada ao testALPolicy.

    curl "http://instance.servicenow.com/api/sn_cdm/policies/mappings/inputs?policyName=testALPolicy1&appName=testApp&inputValue=value1&inputName=key1&deployableName=Development_1" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Retornar resultados:

    { 
  "result": { 
    "sys_id": "631b861b1b501110636e0fe0604bcb6f", 
    "policy_mapping": { 
      "value": "6bb746171b501110636e0fe0604bcb1b", 
      "link": "https://instance.servicenow.com/api/now/table/sn_cdm_pace_policy_mapping/6bb746171b501110636e0fe0604bcb1b" 
    }, 
    "sys_updated_by": "admin", 
    "sys_created_on": "2022-06-30 14:38:00", 
    "io_definition": { 
      "value": "fe1b061b1b501110636e0fe0604bcb90", 
      "link": "https://instance.servicenow.comm/api/now/table/sn_pace_io_definition/fe1b061b1b501110636e0fe0604bcb90" 
    }, 
    "mapped_value": "someVal", 
    "sys_updated_on": "2022-06-30 14:39:21", 
    "sys_created_by": "admin", 
    "is_unused": false 
  } 
}