---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# API de classificação de dados

# API de classificação de dados {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 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.
* Recupere uma lista de todas as classificações de dados disponíveis no domínio atual.
{#data-classification-api__ul_hy2_srm_xnb}

Esta API requer o plug-in Classificação de dados \[com.glide.data_classification\].

Para obter mais informações, consulte [Classificação de dados](https://www.servicenow.com/docs/access?context=data-classification&version=xanadu&pubname=xanadu-platform-security&ft:locale=en-US).

## Classificação de dados - GET /data_classification/getAllDataClasses {#ariaid-title2}

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

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

### Parâmetros de solicitação compatíveis

{#data_class-GET-getAllDataClasses__entry__2}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 1. Parâmetros de caminho]

{#data_class-GET-getAllDataClasses__entry__6}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 2. Parâmetros de consulta]

{#data_class-GET-getAllDataClasses__entry__10}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)]

### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#data_class-GET-getAllDataClasses__entry__14}{#data_class-GET-getAllDataClasses__accept-RESTAPI}

| 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 4. Cabeçalhos da solicitação]

{#data_class-GET-getAllDataClasses__entry__18}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 5. Cabeçalhos de resposta]

### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#data_class-GET-getAllDataClasses__entry__22}{#data_class-GET-getAllDataClasses__entry-200-status-code}

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

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

{#data_class-GET-getAllDataClasses__entry__26}

| 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.primário | Entrada para uma classificação de dados primária. Tipo de dados: objeto "parent": { "sys_id": "String", "name": "String" } |
| result.parent.sys_id | Sys_id da classificação de dados primária 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 {#ariaid-title3}

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

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

### Parâmetros de solicitação compatíveis

{#data_class-POST-classify__entry__2}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 7. Parâmetros de caminho]

{#data_class-POST-classify__entry__6}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 8. Parâmetros de consulta]

{#data_class-POST-classify__entry__10}

| Nome | Descrição |
|-|-|
| dicionário_entradas | 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 entre uma cadeia de caracteres. Tipo de dados: cadeia de caracteres |
| classes_dados | 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 entre uma cadeia de caracteres. Tipo de dados: cadeia de caracteres |
[Tabela 9. Parâmetros do corpo da solicitação (XML ou JSON)]

### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#data_class-POST-classify__entry__16}{#data_class-POST-classify__accept-RESTAPI}{#data_class-POST-classify__content_type-RESTAPI}

| 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 10. Cabeçalhos da solicitação]

{#data_class-POST-classify__entry__22}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 11. Cabeçalhos de resposta]

### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#data_class-POST-classify__entry__26}{#data_class-POST-classify__entry-200-status-code}

| 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. |
[Tabela 12. Códigos de status]

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

{#data_class-POST-classify__entry__32}

| 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 {#ariaid-title4}

Remove todas as classificações de dados das entradas de dicionário especificadas.
Requer a função admin ou data_classification_admin.

### Formato da URL

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

### Parâmetros de solicitação compatíveis

{#data_class-POST-clear__entry__2}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 13. Parâmetros de caminho]

{#data_class-POST-clear__entry__6}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 14. Parâmetros de consulta]

{#data_class-POST-clear__entry__10}

| Nome | Descrição |
|-|-|
| dicionário_entradas | 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 entre uma cadeia de caracteres. Tipo de dados: cadeia de caracteres |
[Tabela 15. Parâmetros do corpo da solicitação (XML ou JSON)]

### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#data_class-POST-clear__entry__14}{#data_class-POST-clear__accept-RESTAPI}{#data_class-POST-clear__content_type-RESTAPI}

| 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 16. Cabeçalhos da solicitação]

{#data_class-POST-clear__entry__20}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 17. Cabeçalhos de resposta]

### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#data_class-POST-clear__entry__24}{#data_class-POST-clear__entry-200-status-code}

| 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. |
[Tabela 18. Códigos de status]

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

{#data_class-POST-clear__entry__30}

| 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 {#ariaid-title5}

Recupera todas as classificações de dados das entradas de dicionário especificadas.
Requer a função admin, data_classification_admin ou data_classification_auditor.

### Formato da URL

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

### Parâmetros de solicitação compatíveis

{#data_class-POST-getClassification__entry__2}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 19. Parâmetros de caminho]

{#data_class-POST-getClassification__entry__6}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 20. Parâmetros de consulta]

{#data_class-POST-getClassification__entry__10}

| Nome | Descrição |
|-|-|
| dicionário_entradas | 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 entre uma cadeia de caracteres. Tipo de dados: cadeia de caracteres |
[Tabela 21. Parâmetros do corpo da solicitação (XML ou JSON)]

### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#data_class-POST-getClassification__entry__14}{#data_class-POST-getClassification__accept-RESTAPI}{#data_class-POST-getClassification__content_type-RESTAPI}

| 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 22. Cabeçalhos da solicitação]

{#data_class-POST-getClassification__entry__20}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 23. Cabeçalhos de resposta]

### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#data_class-POST-getClassification__entry__24}{#data_class-POST-getClassification__entry-200-status-code}

| 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. |
[Tabela 24. Códigos de status]

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

{#data_class-POST-getClassification__entry__30}

| Nome | Descrição |
|-|-|
| resultado | Resultado da solicitação. Retorna um objeto JSON que contém 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.primário | Entrada para uma classificação de dados primária. 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ária 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"
          }
        ]
      }
    }