Vrátí seznam pravidel s možností filtrace

POST

/api/Rule/Find

Request

Authorization

Add parameter in header

X-BalikujAuthToken

Example:

X-BalikujAuthToken: ********************

Body Params application/json

Examples

Responses

🟢200OK

application/json

Body

🟠400Bad Request

🟠403Forbidden

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/Rule/Find' \
--header 'X-BalikujAuthToken: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "pageSize": 50,
    "start": 0,
    "length": 50,
    "search": null,
    "ruleType": "Order"
}'

Response Example

200 - Example 1

{
    "correlationId": "d22127f9-6f76-4e1f-a15b-47ba32e899d0",
    "result": {
        "data": [
            {
                "id": 0,
                "type": "Order",
                "name": "Zaplacené objednávky",
                "description": "Slouží pro zasílání emailů",
                "status": "Inactive",
                "created": "2019-08-24T14:15:22.123Z",
                "updated": "2019-08-24T14:15:22.123Z",
                "lastSuccessful": "2019-08-24T14:15:22.123Z",
                "validFrom": "string",
                "validTo": "string",
                "usageOneTimeOnly": true,
                "usageOneTimeOnlyPerOrder": true,
                "usageOneTimeOnlyPerPackage": true,
                "sendOrderEmail": true,
                "conditions": [
                    {
                        "field": "OrderPaid",
                        "operator": "EqualTo",
                        "value": "True"
                    }
                ],
                "actions": [
                    {
                        "name": "string",
                        "parameters": {
                            "property1": "string",
                            "property2": "string"
                        }
                    }
                ],
                "validDays": {
                    "monday": true,
                    "tuesday": true,
                    "wednesday": true,
                    "thursday": true,
                    "friday": true,
                    "saturday": true,
                    "sunday": true
                },
                "validTimes": {
                    "time0to6": true,
                    "time6to12": true,
                    "time12to18": true,
                    "time18to24": true
                },
                "isEnabled": true
            }
        ],
        "total": 1
    }
}

Modified at 2025-05-31 13:14:57

Nastaví zvolenou dávku jako archivovanou

Vrátí seznam všech vlastností/sloupců, podle kterých lze vytvářet pravidla