使用可能なパラメータ

このセクションで説明する API (ExperienceService/<組織 ID>/cms/projects/_default/distro/procedures) は、パブリッシュされた手順のリストをフェッチします。デフォルトでは、すべてのセッションが返され、結果は 1 つ以上のクエリーパラメータを使用してフィルタできます。その後、結果は 100 のセッションページに分けられます。各ページには次のページへのリンクが含まれます。

パラメータ

タイプ

説明

include

string

(クエリー)

手順のリストをフィルタまたは拡張するオプションのパラメータ。このパラメータには次の値を設定できます。

• publishedonly - パブリッシュされた手順のみを返す

• unpublished - ある時点でパブリッシュされた、パブリッシュされている手順とパブリッシュされていない手順を返す

• unpublisheddistributed- パブリッシュされた手順と、少なくとも 1 人の閲覧者が割り当てられているパブリッシュされていない手順を返す

返されるデータの status プロパティを使用して、手順の現在のステータスを取得できます。ステータスが 0 の場合、手順は未パブリッシュ状態になります。ステータスが 0 以外の場合、手順はパブリッシュ済み状態になります。

これはデフォルトで unpublisheddistributed に設定されます。

includeallunpublished

このパラメータは廃止予定です。

string

(クエリー)

配布ステータスに関係なく、パブリッシュされていないすべての手順を返すオプションのパラメータ。

これはデフォルトで false に設定されます。

organizationId (必須)

string($uuid)

(パス)

組織の ID。これは必須です。