getEnforcementRule

READ

Get enforcement rule.

POST /api/v1/shared/getEnforcementRule

curl -X POST '<your-host>/api/v1/shared/getEnforcementRule' \
  -H 'Authorization: Bearer <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
    "family": "storage",
    "id": "string"
  }'

Response

{
  "active": true,
  "appliesToAll": true,
  "companyId": "string",
  "conditionAst": "…",
  "createdAt": "string",
  "createdBy": "string",
  "customFields": "…",
  "description": "string",
  "family": "storage",
  "filteredItemGroupIds": [
    "string"
  ],
  "filteredItemMatchAll": true,
  "filteredItemTypes": [
    "string"
  ],
  "id": "string",
  "message": "string",
  "name": "string",
  "severity": "string",
  "surfaces": [
    "salesOrderLine"
  ],
  "targetType": "item",
  "updatedAt": "string",
  "updatedBy": "string"
}

Parameters

ParameterType

"storage""sales"

Input schema

schema

{
  "type": "object",
  "properties": {
    "family": {
      "type": "string",
      "enum": [
        "storage",
        "sales"
      ]
    },
    "id": {
      "type": "string"
    }
  },
  "required": [
    "family",
    "id"
  ]
}