API de classificação de dados

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 8 min. de leitura

    • A API de classificação de dados fornece endpoints para agrupar dados por tipo.

    Com a API de classificação de dados, você pode:
    • Atribua classificações de dados a entradas de dicionário existentes.
    • Pesquise as classificações de dados para entradas de dicionário específicas.
    • Remova todas as classificações de dados associadas a entradas de dicionário específicas.
    • Recupera uma lista de todas as classificações de dados disponíveis no domínio atual.

    Esta API requer o plug-in Data Classification [com.glide.data_classification].

    Para obter mais informações, consulte Classificação de dados.

    Classificação de dados - GET /data_classification/getAllDataClasses

    Retorna uma lista de todas as classificações de dados disponíveis no domínio atual.

    Requer a função admin, data_classification_admin ou data_classification_auditor.

    Formato de URL

    URL padrão: /api/now/data_classification/getAllDataClasses

    Parâmetros de solicitação compatíveis

    Tabela 1. Parâmetros de caminho
    Nome Descrição
    Nenhum
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    Nenhum
    Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    Nenhum

    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

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 6. Códigos de status
    Código de status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.

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

    Nome Descrição
    resultado

    Resultado da solicitação. Retorna o sys_id e o nome de cada classificação de dados disponível. Se não houver classificações de dados, ele retornará uma matriz vazia.

    As classificações de dados podem ser organizadas em relacionamentos primário-secundário. Se houver classificações de dados primários, elas serão identificadas no resultado.

    Tipo de dados: matriz

    "result": [
  {
    "parent": {Object},
    "sys_id": "String",
    "name": "String"
  }
]
    resultado.parental Entrada para uma classificação de dados primários.

    Tipo de dados: objeto

    "parent": {
  "sys_id": "String",
  "name": "String"
}
    result.parent.sys_id Sys_id da classificação de dados primários da tabela Classificação de dados [data_classification].

    Tipo de dados: cadeia de caracteres
    result.parent.name Nome da classificação de dados primária.

    Tipo de dados: cadeia de caracteres
    resultado.sys_id Sys_id da classificação de dados da tabela Classificação de dados [data_classification].

    Tipo de dados: cadeia de caracteres
    result.name Nome da classificação de dados.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Recupera uma lista de todas as classificações de dados disponíveis.

    curl "https://instance.servicenow.com/api/now/data_classification/getAllDataClasses" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
    {
  "result": [
    {
      "parent": {
        "sys_id": "a9670fc773fc1010ae8dd21efaf6a735",
        "name": "Confidential"
      },
      "sys_id": "348107b951d71010f877f3f178e7dd0d",
      "name": "Personally identifiable information"
    },
    {
      "sys_id": "a9670fc773fc1010ae8dd21efaf6a735",
      "name": "Confidential"
    },
    {
      "sys_id": "59b7070b73fc1010ae8dd21efaf6a764",
      "name": "Restricted"
    },
    {
      "sys_id": "11d60fc773fc1010ae8dd21efaf6a744",
      "name": "Internal"
    },
    {
      "sys_id": "f5b4cf4773fc1010ae8dd21efaf6a766",
      "name": "Public"
    }
  ]
}

    Classificação de dados - POST /data_classification/classify

    Atribui classificações de dados predefinidas ou definidas pelo usuário a entradas de dicionário existentes.

    Requer a função admin ou data_classification_admin.

    Formato de URL

    URL padrão: /api/now/data_classification/classify

    Parâmetros de solicitação compatíveis

    Tabela 7. Parâmetros de caminho
    Nome Descrição
    Nenhum
    Tabela 8. Parâmetros de consulta
    Nome Descrição
    Nenhum
    Tabela 9. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    dicionario_entries Obrigatório. Os sys_ids dos registros que você deseja classificar. Os sys_ids são da tabela Dicionário [sys_dictionary]. Inserido como uma lista separada por vírgulas dentro de uma cadeia de caracteres.

    Tipo de dados: cadeia de caracteres
    data_classes Obrigatório. Os sys_ids das classificações de dados que você deseja atribuir. Os sys_ids são da tabela Classificação de dados [data_classification]. Inserido como uma lista separada por vírgulas dentro de uma cadeia de caracteres.

    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. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tipo de conteúdo Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 11. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 12. Códigos de status
    Código de status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

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

    Nome Descrição
    resultado Mensagem que descreve o resultado da operação.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Atribui uma classificação de dados a uma entrada de dicionário.

    curl "https://instance.servicenow.com/api/now/data_classification/classify" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"dictionary_entries\": \"445de0a6dba30300efc57416bf9619b0\",
    \"data_classes\": \"40edb1f51bbcec50b92a10a61a4bcb8a\"
}" \
--user 'username':'password'

    {
  "result": "Successfully stored the data classification configurations"
}

    Classificação de dados - POST /data_classification/clear

    Remove todas as classificações de dados das entradas do dicionário especificadas.

    Requer a função admin ou data_classification_admin.

    Formato de URL

    URL padrão: /api/now/data_classification/clear

    Parâmetros de solicitação compatíveis

    Tabela 13. Parâmetros de caminho
    Nome Descrição
    Nenhum
    Tabela 14. Parâmetros de consulta
    Nome Descrição
    Nenhum
    Tabela 15. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    dicionario_entries Obrigatório. Os sys_ids dos registros dos quais você deseja remover classificações. Os sys_ids são da tabela Dicionário [sys_dictionary]. Inserido como uma lista separada por vírgulas dentro de uma cadeia de caracteres.

    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 16. 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
    Tipo de conteúdo Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 17. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 18. Códigos de status
    Código de status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

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

    Nome Descrição
    resultado Mensagem que descreve o resultado da operação.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Limpa as classificações de dados de uma entrada de dicionário.

    curl "https://instance.servicenow.com/api/now/data_classification/clear" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"dictionary_entries\": \"445de0a6dba30300efc57416bf9619b0\"
}" \
--user 'username':'password'

    {
  "result": "Classifications removed for the specified dictionary entries"
}

    Classificação de dados - POST /data_classification/getClassification

    Recupera todas as classificações de dados das entradas do dicionário especificadas.

    Requer a função admin, data_classification_admin ou data_classification_auditor.

    Formato de URL

    URL padrão: /api/now/data_classification/getClassification

    Parâmetros de solicitação compatíveis

    Tabela 19. Parâmetros de caminho
    Nome Descrição
    Nenhum
    Tabela 20. Parâmetros de consulta
    Nome Descrição
    Nenhum
    Tabela 21. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    dicionario_entries Obrigatório. Os sys_ids dos registros para os quais você deseja recuperar classificações. Os sys_ids são da tabela Dicionário [sys_dictionary]. Inserido como uma lista separada por vírgulas dentro de uma cadeia de caracteres.

    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 22. 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
    Tipo de conteúdo Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 23. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 24. Códigos de status
    Código de status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

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

    Nome Descrição
    resultado

    Resultado da solicitação. Retorna um objeto JSON contendo o sys_id de cada entrada do dicionário com uma matriz de suas classificações de dados associadas. Se não houver classificações de dados associadas, ele retornará uma mensagem descrevendo o resultado da operação.

    As classificações de dados podem ser organizadas em relacionamentos primário-secundário. Se houver classificações de dados primários, elas serão identificadas no resultado.

    Tipo de dados: objeto

    "result": {
  <sys_dictionary_sys_id>: [
    {
      "parent": {Object},
      "sys_id": "String",
      "name": "String"
    }
  ]
}
    result.name Nome da classificação de dados.

    Tipo de dados: cadeia de caracteres
    resultado.parental Entrada para uma classificação de dados primários.

    Tipo de dados: objeto

    "parent": {
  "sys_id": "String",
  "name": "String"
}
    result.parent.name Nome da classificação de dados primária.

    Tipo de dados: cadeia de caracteres
    result.parent.sys_id Sys_id da classificação de dados primários da tabela Classificação de dados [data_classification].

    Tipo de dados: cadeia de caracteres
    resultado.sys_id Sys_id da classificação de dados da tabela Classificação de dados [data_classification].

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Obtenha as classificações de dados associadas a uma entrada de dicionário específica.

    curl "https://instance.servicenow.com/api/now/data_classification/getClassification" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"dictionary_entries\": \"445de0a6dba30300efc57416bf9619b0\"
}" \
--user 'username':'password'

    {
  "result": {
    "445de0a6dba30300efc57416bf9619b0": [
      {
        "parent": {
          "sys_id": "a9670fc773fc1010ae8dd21efaf6a735",
          "name": "Confidential"
        },
        "sys_id": "348107b951d71010f877f3f178e7dd0d",
        "name": "Personally identifiable information"
      }
    ]
  }
}