Axiomatic

Rule Packs

Event-to-journal posting rules

List rule packs

GET
/api/rule-packs
x-api-key<token>

API key for programmatic access

In: header

Query Parameters

entityId?string
Formatuuid

Response Body

application/json

application/json

curl -X GET "https://app.axiomatic.software/api/rule-packs"
{
  "packs": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "version": "string",
      "layer": "string",
      "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
      "status": "string",
      "effectiveDate": "2019-08-24",
      "rules": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "eventType": "string",
          "dslSource": "string",
          "priority": 0
        }
      ],
      "activatedFor": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ],
  "books": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "type": "string",
      "rulePackId": "35f68133-5ea9-425e-bc90-c667b45faa42"
    }
  ]
}
{
  "error": "string"
}

Manage rule packs and rules

PUT
/api/rule-packs
x-api-key<token>

API key for programmatic access

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X PUT "https://app.axiomatic.software/api/rule-packs" \  -H "Content-Type: application/json" \  -d '{    "action": "activate_pack",    "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",    "packId": "76be6288-f84b-4cef-9c7f-e3c35001eada"  }'
{
  "activated": 0,
  "deactivated": 0,
  "bookIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}
{
  "error": "string"
}
{
  "error": "string"
}
Empty

Create a rule pack

POST
/api/rule-packs
x-api-key<token>

API key for programmatic access

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://app.axiomatic.software/api/rule-packs" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "version": "string",
  "layer": "string",
  "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
  "status": "string",
  "effectiveDate": "2019-08-24",
  "rules": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "eventType": "string",
      "dslSource": "string",
      "priority": 0
    }
  ],
  "activatedFor": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "createdAt": "2019-08-24T14:15:22Z"
}
{
  "error": "string"
}
{
  "error": "string"
}