Productsup
API referenceV2Analyzer tests

Update analyzer test assignment configuration

Updates an existing analyzer test assignment's configuration. All fields are optional - only provide the fields you want to update.

PATCH
/V2/attributes/{attributeId}/analyzer-tests/{assignmentId}

Authorization

bearerAuth
AuthorizationBearer <token>

ProductsUp Keycloak JWT bearer token.

In: header

Path Parameters

attributeId*integer

Attribute (export field) ID

assignmentId*integer

Assignment ID to update

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://export-template-api.productsup.com/V2/attributes/0/analyzer-tests/0" \  -H "Content-Type: application/json" \  -d '{    "configuration": {      "value": 100,      "operator": "<="    }  }'
{
  "data": {
    "id": 1,
    "attributeId": 123,
    "templateId": "length_check",
    "templateName": "Length Validation",
    "configuration": {
      "value": 100,
      "operator": ">"
    },
    "createdAt": "2024-06-10T14:00:00Z",
    "updatedAt": "2024-06-10T14:00:00Z",
    "name": "Price must be positive",
    "color": "#ff0000",
    "caption": "Invalid price",
    "group": "Pricing",
    "hint": "Check the price column for negative values",
    "errorId": 10059,
    "requiredColumns": [
      "price",
      "currency"
    ]
  }
}
{
  "errors": {
    "message": "Request validation has encountered constraint violations.",
    "errors": {
      "templateId": [
        "This field is missing."
      ],
      "configuration": [
        "This field is missing."
      ]
    }
  }
}
{
  "errors": {
    "message": "Resource access denied."
  }
}
{
  "errors": {
    "message": "Resource access denied."
  }
}

How is this guide?

Unassign analyzer test template from an attribute DELETE

Removes an analyzer test template assignment from an attribute (export field).

Get operation status and result GET

Retrieves the status, result or error of an asynchronous operation (e.g. created by POST /V2/export-templates, POST /V2/export-templates/{id}/duplicate, PUT /V2/export-templates/{id}, or DELETE /V2/export-templates/{id}). Use this to poll for completion and obtain the resourceId on success or the error envelope on failure.