Configure a CMP via API¶

This API is made for resellers that want to enable the CMP configuration via their own Front-End.

Please read Partner API documentation prior to this article if you are not familar with our API structure yet.

Introduction¶

Below you will find a couple of features that our CMP offers and how those can be managed with the Partner API.

1 Configuration

• 1.1 Data Controller
• 1.2 Imprint and Privacy URLs
• 1.3 Banner Message: Predefined Message
• 1.4 Banner Message: Custom Message
• 1.5 Price Packages
• 1.6 Reshow Policy

2 Appearance

• 2.1 Custom Brand Color
• 2.2 Custom Brand Logo
• 2.3 Font Family
• 2.4 Font Size
• 2.5 First Layer Layout: Privacy Banner
• 2.6 First Layer Layout: Privacy Wall
• 2.7 Second Layer Layout: Privacy Settings center
• 2.8 Second Layer Layout: Privacy Settings side
• 2.9 Privacy Trigger: Privacy Button
• 2.10 Privacy Trigger: Privacy Link
• 2.11 Privacy Button: Predefined Icons
• 2.12 Privacy Button: Custom Icons
• 2.13 Privacy Button: Position (left / right position)
• 2.14 Background Overlay for Layers

3 Service Categories

• 3.1 Create custom category
• 3.2 Delete category

4 Data Processing Services

• 4.1 List all available DPSs
• 4.2 Add DPS to Category
• 4.3 Modify predefined data processing services
• 4.4 Use Crawling and Scanning
• 4.5 Using Subconsents

5 Geolocation Rules

• 5.1 Prerequisites
• 5.2 Operations Available
• 5.3 Creating RuleSets
• 5.4 Updating Rulesets
• 5.5 Listing RuleSets
• 5.6 Deleting RuleSets

Configuration¶

Data Controller¶

The data controller is the person or legal entity that is responsible for the domain entered below. This role can be shared by more than one person, company or other organization.

Example Request

mutation {
  setting(
    settingsId: "ABCDEF1234"
    language: "en"
    dataController: "John Doe"
  ) { settingsId }
}

Example UI Implementation

Imprint and Privacy URLs¶

The CMP allows you to adjust Imprint and Privacy URLs. They will be shown in the layers of the CMP. You can specify absolute URLs and relative Paths.

mutation {
  setting(
    settingsId: "ABCDEF1234"
    language: "en"
    imprintUrl: "http://mywebsite.com/imprint"
    privacyPolicyUrl: "http://mywebsite.com/privacypolicy"
  ) { settingsId }
}

Notes

This feature is on language level.
If disableAutoTranslate is set to true (default false), the URLs will be set only for the specific language.
If disableAutoTranslate is set to false, the URLs will be set across all enabled languages.

Example UI Implementation

Banner Message: Predefined Message¶

The Banner Message appears in first Layer.

A predefined Banner Message in all languages will be set per default. The values will always be set when a new setting is created or a new language is added.

If you modified the standard message, you can reset the value by setting bannerMessage to null.

mutation {
  setting(
    settingsId: "ABCDEF1234"
    language: "en"
    bannerMessage: null
  ) { settingsId }
}

Notes

This feature is on language level.
If disableAutoTranslate is set to true (default false), the banner message will be auto-translated and set for every language.

Banner Message: Custom Message¶

A Custom Banner Message can be adjusted. The message can be set for an individual language or set across all languages by using auto-translate feature.

mutation {
  setting(
    settingsId: "ABCDEF1234"
    language: "en"
    bannerMessage: "This message will be translated and set for all languages"
  ) { settingsId }
}

mutation {
  setting(
    settingsId: "ABCDEF1234"
    language: "en"
    bannerMessage: "This message will only apply to EN banners"
    disableAutoTranslate: true
  ) { settingsId }
}

Notes

This feature is on language level.
If disableAutoTranslate is set to true (default false), the banner message will be auto-translated and set for every language.

Example UI Implementation

Price Packages¶

Price Packages are connected to a set of features and correspond to individual Plans.

A Price Package should always be applied.

They are used to enforce limitations and are relevant for activating and exposing of features within the PartnerAPI and Admin Interface.

Price Package Identifier are generated and maintained by Usercentrics.

mutation {
  setting(
    settingsId: "ABCDEF1234"
    language: "en"
    featureConfig: {
      pricePackageId: "gbXCTitO7" # Activating Usercentrics Business Plan
    }
  ) { settingsId }
}

Notes

If no Pricing Package is defined, no limitation is applied.

Reshow Policy¶

The Reshow Poilicy defines under which circumstances the CMP Banner should be shown to the user again. Depending on the country, different regulations may apply.

We strongly recommend to set at least Major.

You can apply multiple values.
You can apply no value (default), in that case the Banner will never be shown again.

mutation {
  setting(
    settingsId: "ABCDEF1234"
    language: "en"
    showInitialViewForVersionChange: ["Major"]
  ) { settingsId }
}

Notes

This feature is on setting level. The value will be automatically set across all languages.

The default value showInitialViewForVersionChange is [""] (empty).

Appearance¶

Custom Brand Color¶

The brand color is used to create a custom color pallete for your Consent Management Platform. The expected value is required to be in HEX without leading #(hash)-character.

mutation {
  setting(
    settingsId: "ABCDEF1234"
    language: "en"
    customization: { color: { primary: "ff0000" } }
  ) { settingsId }
}

Notes

This feature is on setting level. The value will be automatically set across all languages.

Secondary colors will be automatically added based on your Brand color to ensure visibility and accessibility.

The default value customization { color { primary } } is 0045A5

Example UI Implementation

Custom Brand Logo¶

Specify the URL to a logo that will be displayed in the top left corner of both Layers.

mutation {
  setting(
    settingsId: "ABCDEF1234"
    language: "en"
    customization: { logoUrl: "https://mydomain.com/logo.png" }
  ) { settingsId }
}

Notes

This feature is on setting level. The value will be automatically set across all languages.

Secondary colors will be automatically added based on your Brand color to ensure visibility and accessibility.

The default value customization { logoUrl } is empty "".

Example UI Implementation

Font Family¶

Specify a Font Family that will be used in both Layers. You can specify predefined fonts or use customized fonts. It is necessary to have the relevant font files on the website in order for custom fonts to work.

mutation {
  setting(
    settingsId: "ABCDEF1234"
    language: "en"
    customization: { font: { family: "verdana" } }
  ) { settingsId }
}

This feature is on setting level. The value will be automatically set across all languages.

The default value customization { font { family } } is BlinkMacSystemFont,-apple-system,Segoe UI,Roboto,Oxygen-Sans,Ubuntu,Cantarell,Fira Sans,Droid Sans,Helvetica Neue,Helvetica,Arial,sans-serif.

Example UI Implementation

Font Size¶

Specify a Font Size that will be used in both Layers. Any value will be represented in px unit. We recommend to only allow certain sizes to ensure visibility and accessibility.

mutation {
  setting(
    settingsId: "ABCDEF1234"
    language: "en"
    customization: { font: { size: "12" } }
  ) { settingsId }
}

This feature is on setting level. The value will be automatically set across all languages.

The default value customization { font { size } } is 14.

Example UI Implementation

First Layer Layout: Privacy Banner¶

The First Layer is displayed to the user when the website / app is accessed for the very first time (without any preexisting consent information) and contains all information that must be disclosed to the user in order to obtain a valid consent.

The "Privacy Banner" is shown as a sticky-footer on the clients website.

Example Request

mutation {
  setting(
    settingsId: "ABCDEF1234"
    language: "en"
    firstLayer:
    {
        variant: BANNER
    }
  ) { settingsId }
}

Notes

This feature is on setting level. The value will be automatically set across all languages.

The default value of firstLayer { variant } is BANNER

Example UI Implementation

First Layer Layout: Privacy Wall¶

The First Layer is displayed to the user when the website / app is accessed for the very first time (without any preexisting consent information) and contains all information that must be disclosed to the user in order to obtain a valid consent.

The "Privacy Wall" is shown as a horizontally and vertically centered element on the clients website.

Example Request

mutation {
  setting(
    settingsId: "ABCDEF1234"
    language: "en"
    firstLayer:
    {
        variant: WALL
    }
  ) { settingsId }
}

Notes

This feature is on setting level. The value will be automatically set across all languages.

The default value of firstLayer { variant } is BANNER

Example UI Implementation

Second Layer Layout: Privacy Settings center¶

The Second Layer contains detailed information about the integrated Data Processing Services and Categories. It enables the user to view current privacy settings and to adapt them on a granular level at any time

The "Privacy Settings Center" is shown as a horizontally and vertically centered element on the clients website.

Example Request

mutation {
  setting(
    settingsId: "ABCDEF1234"
    language: "en"
    secondLayer:
    {
        variant: CENTER
    }
  ) { settingsId }
}

Notes

This feature is on setting level. The value will be automatically set across all languages.

The default value of secondLayer { variant } is CENTER

Example UI Implementation

Second Layer Layout: Privacy Settings side¶

The Second Layer contains detailed information about the integrated Data Processing Services and Categories. It enables the user to view current privacy settings and to adapt them on a granular level at any time

The "Privacy Banner" is shown as a right-side pinned element on the clients website.

Example Request

mutation {
  setting(
    settingsId: "ABCDEF1234"
    language: "en"
    secondLayer:
    {
        variant: SIDE
    }
  ) { settingsId }
}

Notes

This feature is on setting level. The value will be automatically set across all languages.

The default value of secondLayer { variant } is CENTER

Example UI Implementation

Privacy Trigger: Privacy Button¶

The Privacy Button is a visual element that will be placed on the bottom of the clients website. Usercentrics provides a couple of predevined Button Icons. Below you will find the links to the respective images.

mutation {
  setting(
    settingsId: "ABCDEF1234"
    language: "en"
    privacyButtonIsVisible: true
    buttonPrivacyOpenIconUrl: "https://img.usercentrics.eu/misc/icon-fingerprint.svg"
  ) { settingsId }
}

Notes

This feature is on setting level. The value will be automatically set across all languages.

The value privacyButtonIsVisible defines whether a Privacy Button will be shown true or not false.
The value buttonPrivacyOpenIconUrl defines which Button Icon will be displayed.

Example UI Implementation

Privacy Trigger: Privacy Link¶

The privacy link gives your users access to their current Privacy Settings (i.e. Second Layer). The link must be placed onto the website. Enabling privacy link implies deactiving privacy button.

mutation {
  setting(
    settingsId: "ABCDEF1234"
    language: "en"
    privacyButtonIsVisible: false
  ) { settingsId }
}

Include the following link into the website in order for your users to be able to change their Privacy Settings.

<a href="#" onClick="UC_UI.showSecondLayer();">Privacy Settings</a>

The default value privacyButtonIsVisible is true.

Example UI Implementation

Privacy Button: Predefined Icons¶

Usercentrics provides a couple of predevined Button Icons. Below you will find the links to the images.

mutation {
  setting(
    settingsId: "ABCDEF1234"
    language: "en"
    privacyButtonIsVisible: true
    buttonPrivacyOpenIconUrl: "https://img.usercentrics.eu/misc/icon-security.svg"
  ) { settingsId }
}

Notes

This feature is on setting level. The value will be automatically set across all languages.

Example UI Implementation

Privacy Button: Custom Icons¶

You can specify a custom Icon Url that will be used to display the privacy button.

mutation {
  setting(
    settingsId: "ABCDEF1234"
    language: "en"
    buttonPrivacyOpenIconUrl: "https://mydomain.com/privacy_icon.png"
  ) { settingsId }
}

Notes

This feature is on setting level. The value will be automatically set across all languages.

The default value of buttonPrivacyOpenIconUrl is https://img.usercentrics.eu/misc/icon-fingerprint.svg.

Example UI Implementation

Privacy Button: Position (left / right position)¶

The privacy button can be positioned at bottom left and bottom right.

mutation {
  setting(
    settingsId: "ABCDEF1234"
    language: "en"
    buttonDisplayLocation: "br"
  ) { settingsId }
}

The default value buttonDisplayLocation is bl.

Example UI Implementation

Background Overlay for Layers¶

The Background Overlay adds a gray transparent container above the website, highlighting the CMP layers.

mutation {
    setting(
    settingsId: "ABCDEF1234"
    language: "de"
    firstLayer: { isOverlayEnabled: false  }
    secondLayer: { isOverlayEnabled: false  }
  ) { settingsId }
}

Notes

The default value firstLayer { isOverlayEnabled } is true. The default value secondLayer { isOverlayEnabled } is true.

This feature is on setting level. The value will be automatically set across all languages.

Example UI Implementation

Service Categories¶

Service Categories: Create custom category¶

Usercentrics enables you to classify the used Data Processing Services into different categories.
You can use our predefined categories without any concern or create your own categories and description texts based on your needs.

mutation {
  mutateCategories(
    settingsId: "ABCDEF1234"
    language: "en"
    disableAutoTranslation: true
    categories: {
      added: {
        categorySlug: "Payment",
        label: "Payment",
        description: "Custom Payment Vendor Category",
        isEssential: false,
      }
    }
  ) { settingsId }
}

Notes

The value categorySlug represents the unique key of this category across all languages. This key is mandatory and is required also when adding new vendors to categories or when deleting a category.
The value label contains the name of the category and will be displayed in the UI.
The value description contains the description of the category and will be displayed in the UI.
The value isEssential defines whether a category is classified as essential. Vendors inside the essential category are automatically activated.

This feature is on setting and language level.
While categories are configured on setting level, you can have label and description localized.

If disableAutoTranslate is set to true (default false), label and description are not going to be translated.

Example UI Implementation

Service Categories: Delete category¶

The CMP API enables you to delete any existing category entirely. Make sure the category is empty and has no vendors assigned to it before removing it.

mutation {
    mutateCategories(
    settingsId: "ABCDEF1234"
    language: "de"
    categories: {
      removed: "Payment"
    }
  ) { settingsId }
}

Notes

The category has to be empty. There cannot be any vendors assigned to that category.

This feature is on setting level.
While categories are configured on setting level, you can have label and description localized.

Data Processing Services¶

Also known as DPS, consentTemplate or "Vendor".

List all available DPSs¶

Usercentrics maintains and provides an extensive list of predefined vendor templates.

query {
  consentTemplates {
    templateId
    version
    dataProcessors
  }
}

Notes

Example UI Implementation

Add DPS to Category¶

Any DPS can be added to a specific category.

mutation {
    mutateTemplates(
    settingsId: "ABCDEF1234"
    language: "de"
    consentTemplates: {
      added: {
        templateId:"JiFH1ubU"
        categorySlug:"Payment"
        isAutoUpdateAllowed:true
        type:"predefined"
      }
    }
  ) { settingsId }
}

Notes

This feature is on setting level.

If a template cannot be assigned to multiple categories. An error will be shown when trying to add a template to more than one category

The value templateId contains the respective ID of the predefined template. JiFH1ubU is the Paypal template.
The value categorySlug defines the category in which the template will be added.
The value isAutoUpdateAllowed ensures that the template is always set to the latest version and will contain the latest updates.
The value type can be predefined or custom, depending on the template you want to add. If taken from our database, it should always be predefined.

Modify predefined Data Processing Services¶

The predefined DPSs provided by Usercentrics are maintained internally and can't be modified by customers directly. However, it's possible to create a custom DPS based on a predefined one, which is then owned by the user and can be modified:

mutation {
  transformTemplate(
    settingsId: "ABCDEF1234"
    templateId: "Hko_qNsuiXX"
    language: "en"
    categorySlug: "functional"
    defaultConsentStatus: true
  ) {
    templateId
    type
  }
}

Notes - settingsId indicates to which setting the new service must be added - templateId: Hko_qNsuiXX indicates that this template must be used as a base for the new template, so all data is copied from it. - defaultConsentStatus indicates this service's suggested default consent status, which can be overridden at the configuration level.

The new service (templateId returned from the operation above) can then be updated. The operation below updates the addressOfProcessingCompany and description properties, for example.

Example Request

mutation {
  updateConsentTemplate(
    consentTemplate: {
      addressOfProcessingCompany: "Munich, Germany"
      templateId: "we3ZUuoCamXxLo"
      type: "custom"
      language: "en"
      description: "New description text"
      meaningHasChanged: true
    }, 
    allowedSettingsIds: ["settings2", "settings3"]
  ) {
    addressOfProcessingCompany
    description
    version
    language
    dataProcessor
  }

{
  "data": {
    "updateConsentTemplate": [
      {
        "addressOfProcessingCompany": "Munich, Germany",
        "description": "New description text",
        "version": "2.1.0",
        "dataProcessor": "Google Tag Manager",
        "language": "en"
      },
      {
        "addressOfProcessingCompany": "Munich, Germany",
        "version": "2.1.0",
        "description": "Нов текст на описанието",
        "dataProcessor": "Google Tag Manager",
        "language": "bg"
      },
      {
        "addressOfProcessingCompany": "Munich, Germany",
        "version": "2.1.0",
        "description": "新的描述文字",
        "dataProcessor": "Google Tag Manager",
        "language": "zh"
      }
    ]
  }
}

Notes - IMPORTANT: meaningHasChanged indicates whether the properties updated here should be carried over to other languages of this template and auto-translated if applicable, which is the case for description. If meaningHasChanged isn't set, the operation above will only be applied for the language en. - allowedSettingsIds isn't required but was applied here to demonstrate that it can be used to allow other configurations to use this service.

Crawling and Scanning¶

We provide two endpoints that can be used to scan and crawl websites.

• Endpoint getTechnologies scans URLs or Sitemaps and returns a list of all services detected.
• Endpoint addTechnology scans URLs or Sitemaps and adds the detected services directly to the specified SettingId in a predefined category.

For both Endpoints, you can specify a List of URLs or specify a Sitemap to be scanned. Nested Sitemaps are supported to a depth of 2.

Basic Authentication

Both endpoints allow to specify Usernames and Passwords within the URL to enable basic authentication. Format of URL with basic authentication: <protocol>://<user>:<password>@<host>:<port>/<url-path>

Example:

http://myuser:mypassword@shop.website.com/uk/sitemap.xml

Important
Since crawling a website isn’t a very fast task this API call can take a few minutes and so the caller should make sure to display a loading dialog to provide good UX to the user.

The getTechnologies Endpoint

Technology you (or your end-customer) need to know about the technology present in the website and that can be retrieved via url or sitemap of the website in getTechnologies entrypoint node. The parameter isSitemap tells the API if the provided url is the url to a sitemap. E.g. https://usercentrics.com/sitemap.xml.

Example Request

# Write your query or mutation here
query {
 getTechnologies(url: "http://bl.plattenspieler-nadel.com/", isSitemap: false) {
   label
    templateId
  }
}

Example Response

{
  "data": {
    "getTechnologies": [
      {
        "label": "Google WebFonts",
        "templateId": "HkYNq4sdjbm"
      },
      {
        "label": "Mapbox scripts",
        "templateId": "U8QkTd2W"
      },
      {
        "label": "Facebook Widgets (comments, like, page, login)",
        "templateId": "XYQZBUojc"
      }
    ]
  }
}

The addTechnology Endpoint

This requests triggers our crawler functionality which scans a specific website for used technologies. After scanning the website the crawler automatically adds the appropriate consent templates for the found technologies to the provided setting. The category is predefined by Usercentrics. All three parameters are mandatory. The parameter isSitemap tells the API if the provided url is the url to a sitemap. E.g. https://usercentrics.com/sitemap.xml.

Example Request

mutation {
  addTechnology(
    settingsId: "HkvOYLyME",
    isSitemap: true,
    url: "https://usercentrics.com/sitemap.xml") {
      settingsId
      consentTemplates {
        templateId
      }
    }
}

Example Response

{
  "data": {
    "addTechnology": {
      "consentTemplates": [
        {
          "templateId": "HJI5SmLm7"
        },
        {
          "templateId": "S1pcEj_jZX"
        },

      ],
      "settingsId": "HkvOYLyME",
    }
  }
}

Using Subconsents¶

Request to mutate subconsents. The settingsId and language parameter are mandatory.

Example Request

mutation {
  mutateTemplates(
    settingsId: "8yKTozwk"
    language: "en"
    consentTemplates: {
      updated: [
        {
          templateId: "H1Vl5NidjWX"
          subConsents: [
            { templateId: "H1MvxcVjOoZ7", type: "predefined", version: "1.0.0" }
            { templateId: "rkt8g9Niuo-7", type: "predefined", version: "1.0.0" }
          ]
        }
      ]
    }
  ) {
    language
    consentTemplates {
      templateId
      version
      categorySlug
      description
      subConsents {
        templateId
        type
        version
      }
    }
  }
}

Example Response

{
  "data":  {
    "mutateTemplates":  {
      "consentTemplates":  [
         {
          "categorySlug": "essential",
          "description": "",
          "subConsents":  [
             {
              "templateId": "H1MvxcVjOoZ7",
              "type": "predefined",
              "version": "1.0.0",
            },
             {
              "templateId": "rkt8g9Niuo-7",
              "type": "predefined",
              "version": "1.0.0",
            },
          ],
          "templateId": "H1Vl5NidjWX",
          "version": "10.2.15",
        },
      ],
      "language": "en",
    },
  },
}

Geolocation Rules¶

Geolocation Rules (RuleSets) will enable you to set up and display different CMP Configurations on your website based on the user’s location. Please refer to this documentation page, which explores RuleSets, its components, implementation, and important configuration changes required for using Geolocation Rules with specific legislations, such as CCPA and TCF.

The sections below focus only on managing Geolocation Rules via the Partner API.

Prerequisites¶

As pointed here, in configurations defined in regional rules, there must be no region limitation set in the setting itself. This can be verified via API inspecting the settings data:

• The displayOnlyForEU property must be set to false (Already false by default)

• In the case of a setting configured for an US legislation (CCPA, CPRA, CPA, and so on), the property ccpa.region must be set to ALL. (US_CA_ONLY by default).

Operations Available¶

All mutation operations listed below accept an array as input, which means that with a single operation, multiple RuleSets can be created, updated, or deleted.

The examples provided below are for reference only. For an extensive documentation about all the available fields check our API documentation here.

Creating RuleSets¶

Example of creating a RuleSet, which defines two regional rules:

• For users accessing my website from France and Spain, a banner with the configuration settings2 will be displayed.
• For users accessing my website from Great Britain, a banner with the configuration settings3 will be displayed.

Beyond that, all users accessing the website where this RuleSet is implemented from any other location will have a banner displayed with the configuration settings1 (the fallback/default configuration). (Note the noShow property set to false here. Were it set to true, no banner would be displayed to users from other locations).

Note: Location codes must correspond to ISO3166_1 or ISO3166_2 ISO standards. E.g. "DE" Germany, "DEBY" for Germany Bavaria. The country always includes all state regions, and therefore overrules them.

Request Example

mutation CreateRuleSets {
  createRuleSets(
    ruleSets: [
      {
        name: "new ruleset"
        defaultRule: { settingsId: "settings1", noShow: false }
        description: "some description"
        rules: [
          {
            locations: ["FR", "ES"]
            name: "France-Spain region"
            settingsId: "settings2"
          },
           {
            locations: ["GB"]
            name: "Great Britain region"
            settingsId: "settings3"
          }
        ]
      }
    ]
  ) {
    defaultRule {
      noShow
      setting {
        settingsId
      }
    }
    ruleSetId
    name
    rules {
      locations
      name
      setting {
        settingsId
      }
    }
  }
}

Response Example

{
  "data": {
    "createRuleSets": [
      {
        "defaultRule": {
          "noShow": false,
          "setting": {
            "settingsId": "settings1"
          }
        },
        "ruleSetId": "ruleSet1",
        "name": "new ruleset",
        "rules": [
          {
            "locations": ["FR", "ES"],
            "name": "France-Spain region",
            "setting": {
              "settingsId": "settings2"
            }
          },
          {
            "locations": ["GB"],
            "name": "Great Britain region",
            "setting": {
              "settingsId": "settings3"
            }
          }
        ]
      }
    ]
  }
}

Updating RuleSets¶

To update a RuleSet data, use the mutation updateRuleSets. This mutation works based on partial updates, this means only the fields to be updated need to be provided in the input.

IMPORTANT: To modify the rules list an updated version of it, possible copying the original and modifying it. As with all the other properties, any value provided on this property will completely override the current one.

Request Example

Updating the list or rules for the RuleSet created above

mutation Mutation {
  updateRuleSets(
    ruleSets: [
      {
        ruleSetId: "ruleSet1"
        rules: [
          {
            locations: ["FR", "ES", "PT"]
            name: "France-Spain-PT region"
            settingsId: "settings1"
          }
          {
            locations: ["GB"]
            name: "Great Britain region"
            settingsId: "settings2"
          }
        ]
      }
    ]
  ) {
    ruleSetId
    rules {
      name
      locations
      setting {
        settingsId
      }
    }
  }
}

Listing RuleSets¶

The Query ruleSets operation can list all your RuleSets or entries by id. In case the argument ruleSetIds is omitted, all RuleSets are returned. To define a list of IDs to be returned, provide a list of RuleSet IDs to this argument.

Pagination¶

The result returned by the Query ruleSets is always paginated. To control the pagination, two arguments are used:

• limit defines the maximal amount of documents to be returned in a single request and can be used to represent a page size. Its default is set to 100 and the maximal value allowed is 200.
• skip can be used to define the idea of page number once the limit (or page size) is known. Its default value is set to 0.

Request Example

query RuleSets {
  ruleSets(ruleSetIds: ["xxxxxxx", "yyyyyyy"]) {
    name
    description
    rules {
      name
    }
  }
}

Deleting RuleSets¶

Deleting RuleSets only requires the list of IDs to be provided:

Request Example

mutation DeleteRuleSets {
  deleteRuleSets(ruleSetIds: ["ruleset1", "ruleset2"])
}

Response Example

(Contains the list of IDs deleted. Either all IDs are deleted or an error is returned.):

{
  "data": {
    "deleteRuleSets": ["ruleset1", "ruleset2"]
  }
}