グループREST API

Oracle CPQ 24CのグループREST APIは、REST APIサービスを介してパートナ組織およびホスト会社のグループ・サポートを追加します。次の新しいREST API Webサービスがサポートされます:

すべてのグループの取得

このエンドポイントを使用して、すべてのグループのリストを取得します。

  • エンドポイント: /rest/v16/groups
  • メソッド:  GET

ホスト会社またはパートナ組織のグループの取得

このエンドポイントを使用して、ホスト会社またはパートナ組織のグループのリストを取得します。

  • エンドポイント: /rest/v16/companies/{companyLoginName}/groups
  • メソッド:  GET

ホスト会社またはパートナ組織の1つのグループの作成

このエンドポイントを使用して、ログイン・ユーザーに基づいてホスト会社およびパートナ組織のグループを作成します。

  • エンドポイント: /rest/v16/companies/{companyLoginName}/groups
  • メソッド:  POST

ホスト会社またはパートナ組織の1つのグループの取得

このエンドポイントを使用して、ホスト会社またはパートナ組織のグループ・リソースを取得します。

  • エンドポイント: /rest/v16/companies/{companyLoginName}/groups/{groupVarName}
  • メソッド:  GET

ホスト会社またはパートナ組織の1つのグループの更新

このエンドポイントを使用して、ホスト会社またはパートナ組織のグループを更新します。

  • エンドポイント: /rest/v16/companies/{companyLoginName}/groups/{groupVarName}
  • メソッド: PUT

ホスト会社またはパートナ組織の特定のグループ詳細の更新

このエンドポイントを使用して、Webサービス要求で指定された特定のグループ詳細を更新します。

  • エンドポイント: /rest/v16/companies/{companyLoginName}/groups/{groupVarName}
  • メソッド:  PATCH

グループのすべてのアクセス・セグメントの取得

このエンドポイントを使用して、ホスト会社グループのすべてのグループのアクセス・セグメントを取得します。

  • エンドポイント: /rest/v16/companies/{companyLoginName}/groups/{groupVarName}/segments
  • メソッド:  GET

グループのグループ・アクセス・セグメントの更新

このエンドポイントを使用して、Webサービス要求で提供される情報で既存のグループのアクセス・セグメントを更新します。

  • エンドポイント: /rest/v16/companies/{companyLoginName}/groups/{groupVarName}/segments
  • メソッド:  PATCH

データ表のアクセス権の取得

このエンドポイントを使用して、データ表フォルダ内のデータ表のアクセス権を取得します。

  • エンドポイント: /rest/v16/companies/{companyLoginName}/groups/{groupVarName}/segments/_dataTables/folders/{folderVarName}/accessRights
  • メソッド:  GET

グループのデータ表のアクセス権の更新

このエンドポイントを使用して、グループのデータ表のアクセス権を更新します。

  • エンドポイント: /rest/v16/companies/{companyLoginName}/groups/{groupVarName}/segments/_dataTables/actions/updateAccessRights
  • メソッド:  POST

グループのすべてのユーザーの取得

このエンドポイントを使用して、グループのすべてのユーザーのリストを取得します。

  • エンドポイント:  /rest/v16/companies/{companyLoginName}/group/{groupVarName}/users
  • メソッド:  GET

グループ内のユーザーの一括更新

このエンドポイントを使用して、1つのWebサービス要求を介してグループ内のユーザーを更新します。

  • エンドポイント: /rest/v16/companies/{companyLoginName}/groups/{groupVarName}/users
  • メソッド:  PATCH

有効化のステップ

REST APIガイドのRESTサービス定義を確認して利用してください(Oracle Help Center > 対象となるアプリケーション・サービス領域 > APIおよびスキーマからアクセスできます)。OracleのRESTサービスを初めて利用する場合は、クイック・スタートに関する項から開始してください。