Atlas
Admin — Learned Patterns

Update a learned pattern

Updates a learned pattern's description and/or status. Setting a status records the reviewer and review timestamp.

PATCH
/api/v1/admin/learned-patterns/{id}

Path Parameters

id*string
Length1 <= length <= 128

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:3001/api/v1/admin/learned-patterns/abc123" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "orgId": "string",
  "patternSql": "string",
  "description": "string",
  "sourceEntity": "string",
  "sourceQueries": [
    "string"
  ],
  "confidence": 0,
  "repetitionCount": 0,
  "status": "pending",
  "proposedBy": "agent",
  "reviewedBy": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "reviewedAt": "string",
  "type": "query_pattern",
  "amendmentPayload": {
    "property1": null,
    "property2": null
  }
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}