Enable Rules

Enables Rules for Placement.

URL: /rest-api/rules/placement/{placementId}/enable.do

Method: GET

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – no Placement with such ID.

Response sample:
200 OK

Parameters:

  • hash – a MD5 digest of concatenated username's MD5 password and the given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • placementId – ID of Placement.

Disable Rules

Disables Rules for Placement.

URL: /rest-api/rules/placement/{placementId}/disable.do

Method: GET

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – no Placement with such ID.

Response sample:
200 OK

Parameters:

  • hash – a MD5 digest of concatenated username's MD5 password and the given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • placementId – ID of Placement.

Add new Rule group

Add new Rules group for Placement.

URL: /rest-api/rules/placement/{placementId}/add.do

Method: GET

Response format: application/json

Error codes:

  • 400 Bad Request – Empty ruleIds parameter.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – no Placement with such ID.

Response sample:
200 OK

Parameters:

  • hash – a MD5 digest of concatenated username's MD5 password and the given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • placementId – ID of Placement.
  • ruleIds – array of Rules identifier.
  • include – true if Rule should be included; false if Rule should be excluded.
  • operator – AND/OR operator.

Remove Rule

Remove Rule group for Placement.

URL: /rest-api/rules/placement/{placementId}/remove.do

Method: GET

Response format: application/json

Error codes:

  • 400 Bad Request – Empty ruleIds parameter.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – no Placement with such ID.

Response sample:
200 OK

Parameters:

  • hash – a MD5 digest of concatenated username's MD5 password and the given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • placementId – ID of Placement.
  • ruleGroupId – ID of Rule group.

Return Rule

Return all Rule groups for Placement.

URL: /rest-api/rules/placement/{placementId}/GET.do

Method: GET

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – no Placement with such ID.

Response sample:
200 OK

Parameters:

  • hash – a MD5 digest of concatenated username's MD5 password and the given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • placementId – ID of Placement.

Need more help?

Should you require any additional help with our solutions, do not hesitate to contact Epom technical support at support@epom.com. Our support managers are dedicated to resolving any issues and providing you with solutions and support if you face difficulties or have questions.