Condition Sets

Reusable condition value sets

All endpoints require a bearer token (oh_... API key or user JWT) and are served under https://api.orderly-hub.com. Use the Try it consoles to run a request against the Preview (test) server.

List condition sets

GET/api/v1/condition-sets

Responses

200 Condition set list

GET/api/v1/condition-sets

List condition sets

API key (Bearer token)

https://api-test.orderly-hub.com/api/v1/condition-sets

Create a condition set

POST/api/v1/condition-sets

Request body

Field	Type	Description
name	string
description	string

{
  "name": "Jane Doe",
  "description": "string"
}

Responses

201 Condition set created

POST/api/v1/condition-sets

Create a condition set

API key (Bearer token)

Request body (JSON){ "name": "Jane Doe", "description": "string" }

https://api-test.orderly-hub.com/api/v1/condition-sets

Get condition set details

GET/api/v1/condition-sets/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Condition set details

GET/api/v1/condition-sets/{id}

Get condition set details

API key (Bearer token)

id * (path)

https://api-test.orderly-hub.com/api/v1/condition-sets/

Update a condition set

PATCH/api/v1/condition-sets/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Request body

{}

Responses

200 Condition set updated

PATCH/api/v1/condition-sets/{id}

Update a condition set

API key (Bearer token)

id * (path)

Request body (JSON){}

https://api-test.orderly-hub.com/api/v1/condition-sets/

Delete a condition set

DELETE/api/v1/condition-sets/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Condition set deleted

DELETE/api/v1/condition-sets/{id}

Delete a condition set

API key (Bearer token)

id * (path)

https://api-test.orderly-hub.com/api/v1/condition-sets/

Get condition set values

GET/api/v1/condition-sets/{id}/values

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 List of values

GET/api/v1/condition-sets/{id}/values

Get condition set values

API key (Bearer token)

id * (path)

https://api-test.orderly-hub.com/api/v1/condition-sets//values

Add values to condition set

POST/api/v1/condition-sets/{id}/values

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Request body

Field	Type	Description
values	array

{
  "values": [
    "string"
  ]
}

Responses

200 Values added

POST/api/v1/condition-sets/{id}/values

Add values to condition set

API key (Bearer token)

id * (path)

Request body (JSON){ "values": [ "string" ] }

https://api-test.orderly-hub.com/api/v1/condition-sets//values

Remove specific values from condition set

DELETE/api/v1/condition-sets/{id}/values

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Request body

Field	Type	Description
values	array

{
  "values": [
    "string"
  ]
}

Responses

200 Values removed

DELETE/api/v1/condition-sets/{id}/values

Remove specific values from condition set

API key (Bearer token)

id * (path)

https://api-test.orderly-hub.com/api/v1/condition-sets//values

Clear all values from condition set

DELETE/api/v1/condition-sets/{id}/values/all

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 All values cleared

DELETE/api/v1/condition-sets/{id}/values/all

Clear all values from condition set

API key (Bearer token)

id * (path)

https://api-test.orderly-hub.com/api/v1/condition-sets//values/all