younifyd
Menu

Get Rule Definitions

Get list of rule definitions

GET/api/rest/v1/rule-definitions

Use it in a workflow

  1. Add a step and choose the Akeneo connector.
  2. Pick the Get Rule Definitions action (under Rule definition).
  3. Fill in the fields below, then reference the result from later steps as {{getRuleDefinitions.response.data}}.

Request

Query parameters

pageinteger

Specify which page of results to retrieve when using pagination. It is useful for navigating through large datasets by breaking them into smaller, manageable pages. See [Pagination](https://api.akeneo.com/documentation/pagination.html) section for more details.

Default 1

limitinteger

Specify the maximum number of results to return per page. It is useful for controlling the amount of data returned in a single request, especially when dealing with large datasets. See [Pagination](https://api.akeneo.com/documentation/pagination.html) section for more details.

Default 10

with_countboolean

Return the count of items in the response. Be careful with that, on a big catalog, it can decrease performance in a significant way. It is useful for understanding the size of the dataset being returned, especially when dealing with large collections. Use it judiciously to avoid performance issues.

Default false

codesstring

Filter by comma-separated rule codes

typestring

Filter by rule type: product or record

One ofproductrecord

execution_typestring

Filter by execution type: triggered, scheduled, workflow_based

One oftriggeredscheduledworkflow_based

enabledboolean

Filter by enabled status

Response

Returns 200 with an object. Read it in later steps with {{getRuleDefinitions.response.data.<field>}}.

Need more? See the Akeneo guide for connection setup and behaviour shared by every action.