結果の並べ替え (order_by)

本項では、コレクションのGET操作中にALM Octane REST APIによって返されるエンティティの並べ替えに関する情報を提供します。

構文

order_byパラメーターの構文は次のとおりです。

order_by=[<direction>]<field name>[[,[<direction>]<field name>]]

例: /defects?order_by=severity,-creation_time

フィールド名はコンマで区切られます (,)。
order_byパラメーターが送信されない場合、コレクションはエンティティIDで並べ替えられます。
並べ替えでは大文字と小文字は区別されません。これは、値ABCDE abcdeが次のようにソートされることを意味します。A a B b C c D d E e
結果は、エンティティの任意のフィールドで並べ替えることができます。
order_byパラメーターが送信されない場合、コレクションはエンティティIDで並べ替えられます。

例: 名前の昇順とストーリーポイントの降順で、不具合コレクションを取得します。

GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/defects?order_by=name,-story_points

参照情報: