Read the managed cleanup setting for one relation type

get

https://api.test.bluestonepim.com/rules-engine/relations/{relationId}/settings

Returns the cleanup switch for one relation type. A relation type the Rules Engine has never seen returns defaults (removeProductsFromRelation false, activeRuleCount 0, no modifiedAt), not 404, so the rule editor can call this for any relation without special handling. Requires read permission only.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK. The setting for the relation type.

404Not Found. PIM does not know this relation type, or the id is not a PIM relation id (24 hex characters). This never means "the Rules Engine has no setting saved" - that case returns defaults with a 200.

500Internal Server Error. A DynamoDB read failed (the setting or activeRuleCount). The switch value is unknown, not off - retry rather than showing it as off.

502Bad Gateway. PIM could not be reached, so the relation could not be checked. API Gateway sends this body. The switch value is unknown, not off - retry.