Order Status

Added in version 2.5.0.

Requires Pro Edition and Products plugin >= 2.1.5.

Manager

All operations on the OrderStatus resource are provided by its manager. To get access to it you have to call redmine.order_status where redmine is a configured redmine object. See the Configuration about how to configure redmine object.

Create methods

Not supported by Products plugin

Read methods

get

redminelib.managers.ResourceManager.get(resource_id)

Returns single OrderStatus resource from the Products plugin by its id.

Parameters:

resource_id (int) – (required). Id of the order status.

Returns:

Resource object

>>> status = redmine.order_status.get(1)
>>> status
<redminelib.resources.OrderStatus #1 "Paid">

Hint

OrderStatus resource object provides you with some relations. Relations are the other resource objects wrapped in a ResourceSet which are somehow related to an OrderStatus resource object. The relations provided by the OrderStatus resource object are:

• orders

>>> statuses = redmine.order_status.all()
>>> statuses[0]
<redminelib.resources.OrderStatus #1 "Paid">
>>> statuses[0].orders
<redminelib.resultsets.ResourceSet object with Order resources>

all

redminelib.managers.ResourceManager.all()

Returns all OrderStatus resources from the Products plugin.

Parameters:

• limit (int) – (optional). How much resources to return.

• offset (int) – (optional). Starting from what resource to return the other resources.

Returns:

ResourceSet object

>>> statuses = redmine.order_status.all()
>>> statuses
<redminelib.resultsets.ResourceSet object with OrderStatus resources>

filter

Not supported by Products plugin

Update methods

Not supported by Products plugin

Delete methods

Not supported by Products plugin

Export

Not supported by Products plugin