Skip to content
aimrack

Enforcement Rule Acknowledgment

The enforcement rule acknowledgment resource.

Base/enforcementRuleAcknowledgment
GET/enforcementRuleAcknowledgment

List enforcement rule acknowledgments

Retrieve a paginated list of enforcement rule acknowledgments. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GET/enforcementRuleAcknowledgment
curl --request GET \
  --url '<your-host>/enforcementRuleAcknowledgment?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "documentType": "string",
    "documentId": "xyz789",
    "severity": "string",
    "outcome": "string",
    "message": "string",
    "createdBy": "string"
  }
]
GET/enforcementRuleAcknowledgment

Retrieve a enforcement rule acknowledgment

Fetch a single enforcement rule acknowledgment by filtering on `id`.

Query parameters

idstring

Match on the enforcement rule acknowledgment's `id`, e.g. `eq.{id}`.

GET/enforcementRuleAcknowledgment
curl --request GET \
  --url '<your-host>/enforcementRuleAcknowledgment?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "documentType": "string",
  "documentId": "xyz789",
  "severity": "string",
  "outcome": "string",
  "message": "string",
  "createdBy": "string"
}
POST/enforcementRuleAcknowledgment

Create a enforcement rule acknowledgment

Create a new enforcement rule acknowledgment.

Body parameters

ruleIdstring
ruleNamestring
documentTypestringrequired
documentIdstringrequired
documentLineIdstring
itemIdstring
severitystringrequired
outcomestringrequired
messagestringrequired
POST/enforcementRuleAcknowledgment
curl --request POST \
  --url <your-host>/enforcementRuleAcknowledgment \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"documentType":"string","documentId":"xyz789","severity":"string","outcome":"string","message":"string"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "documentType": "string",
  "documentId": "xyz789",
  "severity": "string",
  "outcome": "string",
  "message": "string",
  "createdBy": "string"
}
PATCH/enforcementRuleAcknowledgment

Update a enforcement rule acknowledgment

Update an existing enforcement rule acknowledgment, matched on `id`.

Body parameters

ruleIdstring
ruleNamestring
documentTypestringrequired
documentIdstringrequired
documentLineIdstring
itemIdstring
severitystringrequired
outcomestringrequired
messagestringrequired
PATCH/enforcementRuleAcknowledgment
curl --request PATCH \
  --url '<your-host>/enforcementRuleAcknowledgment?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"ruleId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "documentType": "string",
  "documentId": "xyz789",
  "severity": "string",
  "outcome": "string",
  "message": "string",
  "createdBy": "string"
}
DELETE/enforcementRuleAcknowledgment

Delete a enforcement rule acknowledgment

Delete a enforcement rule acknowledgment, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the enforcement rule acknowledgment to delete, e.g. `eq.{id}`.

DELETE/enforcementRuleAcknowledgment
curl --request DELETE \
  --url '<your-host>/enforcementRuleAcknowledgment?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content