Categories

Create, manage and query Categories.

Overview

Categories are similar to labels, but are used for categorizing content, such as by Personally Identifiable Information (PII) category. They are unique by their name, across the Graphlit project.

Common examples of PII categories are Credit Card Number and Phone Number.

Operations

Create Category

The createCategory mutation enables the creation of a category by accepting the category name and it returns essential details, including the ID and name of the newly generated category.

Mutation:

mutation CreateCategory($category: CategoryInput!) {
  createCategory(category: $category) {
    id
    name
  }
}

Variables:

{
  "category": {
    "name": "Credit Card Number"
  }
}

Response:

{
  "id": "2abf2bec-ca5a-44aa-81fb-431b4e4ee6fc",
  "name": "Credit Card Number"
}

Update Category

The updateCategory mutation enables the renaming of a category by accepting the category name.

Mutation:

mutation UpdateCategory($category: CategoryUpdateInput!) {
  updateCategory(category: $category) {
    id
    name
  }
}

Variables:

{
  "category": {
    "id": "2abf2bec-ca5a-44aa-81fb-431b4e4ee6fc",
    "name": "Debit Card Number"
  }
}

Response:

{
  "id": "2abf2bec-ca5a-44aa-81fb-431b4e4ee6fc",
  "name": "Debit Card Number"
}

Delete Category

The deleteCategory mutation allows the deletion of a category by utilizing the id parameter, and it returns the ID and state of the deleted category.

Mutation:

mutation DeleteCategory($id: ID!) {
  deleteCategory(id: $id) {
    id
    state
  }
}

Variables:

{
  "id": "2abf2bec-ca5a-44aa-81fb-431b4e4ee6fc"
}

Response:

{
  "id": "2abf2bec-ca5a-44aa-81fb-431b4e4ee6fc",
  "state": "DELETED"
}

Delete Categories

The deleteCategories mutation allows the deletion of multiple categories, as specified by the ids array parameter, and it returns the ID and state of the deleted categories.

Mutation:

mutation DeleteCategories($ids: [ID!]!) {
  deleteCategories(ids: $ids) {
    id
    state
  }
}

Variables:

{
  "ids": [
    "39fcf408-15ca-4cc2-9476-622d64aa38f3",
    "93476a0c-d567-4624-9d5e-df43dfff92ea"
  ]
}

Response:

[
  {
    "id": "93476a0c-d567-4624-9d5e-df43dfff92ea",
    "state": "DELETED"
  },
  {
    "id": "39fcf408-15ca-4cc2-9476-622d64aa38f3",
    "state": "DELETED"
  }
]

Get Category

The category query allows you to retrieve specific details of a category by providing the id parameter.

Query:

query GetCategory($id: ID!) {
  category(id: $id) {
    id
    name
  }
}

Variables:

{
  "id": "2abf2bec-ca5a-44aa-81fb-431b4e4ee6fc"
}

Response:

{
  "id": "2abf2bec-ca5a-44aa-81fb-431b4e4ee6fc",
  "name": "Debit Card Number"
}

Query Categories

• Query Categories
• Query Categories By Name

Query Categories

The categories query allows you to retrieve all categories. It returns a list of category results, including the ID and name for each category.

Query:

query QueryCategories($filter: CategoryFilter!) {
  categories(filter: $filter) {
    results {
      id
      name
    }
  }
}

Variables:

{
  "filter": {
    "offset": 0,
    "limit": 100
  }
}

Response:

{
  "results": [
    {
      "id": "2abf2bec-ca5a-44aa-81fb-431b4e4ee6fc",
      "name": "Debit Card Number"
    }
  ]
}

Query Categories By Name

The categories query allows you to retrieve categories based on a specific filter criteria, via the name parameter. In this example, the name is set to "Number." It returns a list of category results containing the ID and name for each matching category.

Query: Query:

query QueryCategories($filter: CategoryFilter!) {
  categories(filter: $filter) {
    results {
      id
      name
    }
  }
}

Variables:

{
  "filter": {
    "name": "Number",
    "offset": 0,
    "limit": 100
  }
}

Response:

{
  "results": [
    {
      "id": "2abf2bec-ca5a-44aa-81fb-431b4e4ee6fc",
      "name": "Debit Card Number"
    }
  ]
}

Queries

Mutations

Objects