ReDoc documentation

Conditionals

Conditionals allow you to capture business rules in Order Book. You can target Orders based on several attributes or create time-based rules, and apply mutations to this order set enriching for your optimization.

Find out more

Create a new conditional

This endpoint allows you to create a new conditional. The application will assign a generated ID to the conditional, that can be used for retrieving, updating or deleting the conditional. This generated ID is returned in the Location header and (optional) response body.

Securitykeycloak
Request
header Parameters
Prefer
Array of strings

The RFC7240 Prefer header indicates that a particular server behavior is preferred by the client but is not required for successful completion of the request (see RFC 7240).

The following behavior is supported by this API:

  • return=<minimal|representation> is used to suggest the server to return using status code 204 without a resource in the response body (minimal) or using status codes 200 or 201 with the resource in the response body on success (representation).
Request Body schema: application/json
required
name
string

A short name for the Conditional

description
string

A description for the conditional, helpful in determining the why or what.

required
object

The rules that will determine whether this conditional is applicable to an order or not.

At least one conditional needs to be provided. The different top-level conditions are combined with AND logic, ie: they all need to match for an order to match this conditional.

required
object

At least one property has to be filled.

Responses
201

OK

204

Created successfully

default

General error payload

post/conditionals
Request samples
application/json
{
  • "name": "a name",
  • "description": "a description",
  • "conditions": {
    },
  • "effects": {
    }
}
Response samples
application/json
{
  • "id": "624ec196-4c5c-4fb4-bb43-9ffd8a6b8844",
  • "name": "a name",
  • "description": "a description",
  • "conditions": {
    },
  • "effects": {
    }
}

Get a conditional by Id

This endpoint allows you to get the information about a given conditional.

Securitykeycloak
Request
path Parameters
id
required
string

The generated identifier of an entity instance

Responses
200

OK

404

The entity is not found

get/conditionals/{id}
Response samples
application/json
{
  • "id": "624ec196-4c5c-4fb4-bb43-9ffd8a6b8844",
  • "name": "a name",
  • "description": "a description",
  • "conditions": {
    },
  • "effects": {
    }
}

Update an existing conditional by Id

This endpoint updates a given conditional.

Securitykeycloak
Request
path Parameters
id
required
string

The generated identifier of an entity instance

header Parameters
Prefer
Array of strings

The RFC7240 Prefer header indicates that a particular server behavior is preferred by the client but is not required for successful completion of the request (see RFC 7240).

The following behavior is supported by this API:

  • return=<minimal|representation> is used to suggest the server to return using status code 204 without a resource in the response body (minimal) or using status codes 200 or 201 with the resource in the response body on success (representation).
If-Match
string

weak Etag as optimistic locking check

Request Body schema: application/json
required
name
string

A short name for the Conditional

description
string

A description for the conditional, helpful in determining the why or what.

required
object

The rules that will determine whether this conditional is applicable to an order or not.

At least one conditional needs to be provided. The different top-level conditions are combined with AND logic, ie: they all need to match for an order to match this conditional.

required
object

At least one property has to be filled.

Responses
200

OK

204

Created successfully

404

The entity is not found

412

Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET or HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the entity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed and this error response is sent back.

default

General error payload

put/conditionals/{id}
Request samples
application/json
{
  • "name": "a name",
  • "description": "a description",
  • "conditions": {
    },
  • "effects": {
    }
}
Response samples
application/json
{
  • "id": "624ec196-4c5c-4fb4-bb43-9ffd8a6b8844",
  • "name": "a name",
  • "description": "a description",
  • "conditions": {
    },
  • "effects": {
    }
}

Delete a conditional by Id

This endpoint allows you to delete a given conditional

Securitykeycloak
Request
path Parameters
id
required
string

The generated identifier of an entity instance

header Parameters
If-Match
string

weak Etag as optimistic locking check

Responses
204

Deletion has succeeded and body is empty

404

The entity is not found

412

Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET or HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the entity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed and this error response is sent back.

default

General error payload

delete/conditionals/{id}
Response samples
application/problem+json
{}
➔ Next to Partial Routes [EXPERIMENTAL]