getEnforcementRules

READ

Get enforcement rules.

POST /api/v1/shared/getEnforcementRules

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

Response

{
  "results": [
    {
      "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"
    }
  ],
  "count": null
}

Parameters

ParameterType

"storage""sales"

"item""workCenter"

Input schema

schema

{
  "type": "object",
  "properties": {
    "family": {
      "type": "string",
      "enum": [
        "storage",
        "sales"
      ]
    },
    "args": {
      "type": "object",
      "properties": {
        "limit": {
          "type": "integer",
          "default": 100
        },
        "offset": {
          "type": "integer",
          "default": 0
        },
        "search": {
          "type": [
            "string",
            "null"
          ]
        },
        "targetType": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "item",
            "workCenter"
          ]
        }
      }
    }
  },
  "required": [
    "family"
  ]
}