VTvtex
Clusters

Validate document by clusters

Changed on

Checks if a document is present in one or more clusters (specific set of field values).

ℹ️ There is a limit of five rules per request.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

ProductCategoryResource
Dynamic StorageDynamic storage generic resourcesInsert or update document (not remove)
Dynamic StorageDynamic storage generic resourcesFull access to all documents
Dynamic StorageDynamic storage generic resourcesMaster Data administrator

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

post/api/dataentities/{dataEntityName}/documents/{id}/clusters

Request

  • Base URL
    https://apiexamples.vtexcommercestable.com.br
  • URL
    https://apiexamples.vtexcommercestable.com.br/api/dataentities/{dataEntityName}/documents/{id}/clusters
  • Auth
    • API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
    • or API key in header VtexIdclientAutCookie

Path parameters

dataEntityNamestring required
Example:Newsletter

Name of the data entity.

idstring required
Example:b818cbda-e489-11e6-94f4-0ac138d2d42e

ID of the Document.

Headers

Acceptstring required
Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

namestring

Cluster name.

rulestring

Cluster validation rule.

Example request

[
  {
    "name": "male",
    "rule": "gender=male"
  }
]

Response

OK

namestring

Cluster name.

isValidboolean

Informs if the document is valid according to the cluster rule (true) or not (false).

Changes

  • 5bf3265c027cRevision changes
    • breaking

      the request's body type changed from string to array, and format from json to no format

    • info

      the request body application/json default value [ { "name": "male" "rule": "gender=male" }, { "name": "complex", "rule": "((gender=male AND percent=0.35) AND any is null) AND (name=*go*)" } { "name": "complex2", "rule": "((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)" }, { "name": "createdIn", "rule": "createdIn between 2015-10-28 AND 2015-10-30" } ] was removed

    • info

      added the media type application/json for the response with the status