機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. アクセス・グループ

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

get

/crmRestApi/resources/11.13.18.05/accessGroups

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • AccessGroupNumberRowFinder : 指定されたアクセス・グループ番号を持つアクセス・グループを検索します。
      ファインダ変数:
      • AccessGroupNumber; string;アクセス・グループの代替キー識別子。
    • PrimaryKey : 指定された主キーを持つアクセス・グループを検索します。
      ファインダ変数:
      • AccessGroupId; integer; アクセス・グループの一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AccessGroupId; integer; アクセス・グループの一意の識別子。
    • AccessGroupNumber; string;アクセス・グループの代替キー識別子。 システム生成の一意の連番です。
    • ActiveFlag; boolean。アクセス・グループがアクティブかどうかを示します。
    • CreatedBy; string; アクセス・グループを作成したユーザー。
    • CreationDate; string;アクセス・グループが作成された日付。
    • 説明; string;アクセス・グループの説明。
    • LastUpdateDate; string; アクセス・グループが最後に更新された日付。
    • LastUpdateLogin; string;アクセス・グループを最後に更新したユーザーのログイン詳細。
    • LastUpdatedBy; string; アクセス・グループを最後に更新したユーザー。
    • Name; string;アクセス・グループの名前。
    • TypeCode; string; アクセス・グループのタイプを示すコード。
    • TypeCodeMeaning; string;アクセス・グループのタイプ。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : accessGroups
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : accessGroups-item-response
タイプ: object
ソースを表示
  • タイトル: Access Group ID
    アクセス・グループの一意の識別子。
  • Access Group Members
    タイトル: Access Group Members
    アクセス・グループ・メンバー・リソースは、グループのメンバーを表示、作成および削除するために使用されます。 グループ・メンバーは、グループの一部であるリソースです。
  • タイトル: Number
    最大長: 4000
    アクセス・グループの代替キー識別子。 システム生成の一意の連番です。
  • タイトル: Active
    最大長: 1
    デフォルト値: false
    アクセス・グループがアクティブかどうかを示します。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    アクセス・グループを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    アクセス・グループが作成された日付。
  • タイトル: Delete
    読取り専用: true
    デフォルト値: true
    レコードを削除できるかどうかを示します。
  • タイトル: Description
    最大長: 4000
    アクセス・グループの説明。
  • タイトル: Last Update Date
    読取り専用: true
    アクセス・グループが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    アクセス・グループを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    アクセス・グループを最後に更新したユーザーのログイン詳細。
  • Links
  • タイトル: Name
    最大長: 4000
    アクセス・グループの名前。
  • タイトル: Type
    最大長: 30
    デフォルト値: ORA_ZCA_CUSTOM
    アクセス・グループのタイプを示すコード。
  • タイトル: Type
    読取り専用: true
    最大長: 80
    アクセス・グループのタイプ。
  • タイトル: Update
    読取り専用: true
    デフォルト値: true
    レコードを更新できるかどうかを示します。
ネストされたスキーマ : アクセス・グループ・メンバー
タイプ: array
タイトル: Access Group Members
アクセス・グループ・メンバー・リソースは、グループのメンバーを表示、作成および削除するために使用されます。 グループ・メンバーは、グループの一部であるリソースです。
ソースを表示
ネストされたスキーマ : accessGroups-AccessGroupMembers-item-response
タイプ: object
ソースを表示
  • タイトル: Access Group ID
    アクセス・グループの一意の識別子。
  • タイトル: Access Group Member ID
    アクセス・グループ・メンバーの一意の識別子。
  • タイトル: Group Number
    読取り専用: true
    最大長: 4000
    アクセス・グループ・メンバーが属するアクセス・グループの代替キー識別子。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    アクセス・グループ・メンバーを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    アクセス・グループ・メンバーが作成された日付。
  • タイトル: E-Mail
    読取り専用: true
    最大長: 320
    アクセス・グループ・メンバーの電子メール・アドレス。
  • タイトル: Phone
    読取り専用: true
    アクセス・グループ・メンバーに関連付けられたリソースの電話番号。
  • タイトル: Last Update Date
    読取り専用: true
    アクセス・グループ・メンバーが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    アクセス・グループ・メンバーを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    アクセス・グループ・メンバーを最後に更新したユーザーのログイン詳細。
  • Links
  • タイトル: Member Type
    最大長: 1
    デフォルト値: true
    メンバーが手動でグループに追加されたかどうかを示します。
  • タイトル: Group Name
    読取り専用: true
    最大長: 4000
    アクセス・グループ・メンバーが属するアクセス・グループの名前。
  • タイトル: Party ID
    アクセス・グループ・メンバーの一意の識別子。
  • タイトル: Resource Name
    読取り専用: true
    最大長: 255
    アクセス・グループ・メンバーの名前。
  • タイトル: Resource Registry ID
    読取り専用: true
    最大長: 30
    リソースの代替キー識別子。
  • タイトル: Resource Role
    読取り専用: true
    アクセス・グループ・メンバーに関連付けられたリソースのロール。
  • タイトル: Type Code
    最大長: 30
    デフォルト値: ORA_ZCA_CUSTOM
    アクセス・グループ・メンバーの親アクセス・グループ・タイプを示すコード。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべてのアクセス・グループを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroups

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
    "items": [
        {
            "AccessGroupId": 300100182647465,
            "AccessGroupNumber": "CDRM_1",
            "ActiveFlag": false,
            "CreatedBy": "SALES_ADMIN",
            "CreationDate": "2020-01-07T06:48:00+00:00",
            "Description": "Demo Group Description",
            "LastUpdateDate": "2020-01-07T06:48:00.425+00:00",
            "LastUpdateLogin": "99EB11C2CFA55443E05392BDF20ABC87",
            "LastUpdatedBy": "SALES_ADMIN",
            "Name": "Demo Group",
            "TypeCode": "CUSTOM",
            "UpdateFlag": true,
            "DeleteFlag": false,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroups/CDRM_1",
                    "name": "accessGroups",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroups/CDRM_1",
                    "name": "accessGroups",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroups/CDRM_1/lov/ActiveFlagLookupVO",
                    "name": "ActiveFlagLookupVO",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroups/CDRM_1/child/AccessGroupMembers",
                    "name": "AccessGroupMembers",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroups",
            "name": "accessGroups",
            "kind": "collection"
        }
    ]
}
「トップに戻る」