機械翻訳について

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

get

/crmRestApi/resources/11.13.18.05/accessGroupExtensionRules

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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>

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

    • ACC_EXT_RULES_AK : 指定されたアクセス・グループ拡張ルール番号を持つアクセス・グループ拡張ルールを検索します。
      ファインダ変数:
      • AccExtRuleNumber; string; アクセス・グループ拡張ルールの一意の代替識別子。
    • PrimaryKey : 指定された主キーを持つアクセス・グループ拡張ルールを検索します。
      ファインダ変数:
      • AccExtRuleId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AccExtRuleId; integer; アクセス拡張ルールの一意の識別子。
    • AccExtRuleNumber; string; アクセス拡張ルールの代替キー識別子。 システム生成の一意の連番です。
    • ActiveFlag; boolean。アクセス拡張ルールがアクティブかどうかを示します。
    • CreatedBy; string; アクセス拡張ルールを作成したユーザー。
    • CreationDate; string; アクセス拡張ルールが作成された日付。
    • DeleteFlag; boolean;レコードを削除できるかどうかを示します。
    • 説明;文字列;アクセス拡張ルールの説明。
    • ExtendAllRulesFlag; boolean;ソース・オブジェクトからターゲット・オブジェクトに拡張するルールを識別するために使用されるメソッドを示します。
    • LastUpdateDate; string; アクセス拡張ルールが最後に更新された日付。
    • LastUpdateLogin; string;アクセス拡張ルールを最後に更新したユーザーのログイン詳細。
    • LastUpdatedBy; string; アクセス拡張ルールを最後に更新したユーザー。
    • 名前、文字列。アクセス拡張ルールの名前。
    • PredefinedFlag; boolean。アクセス拡張ルールが事前定義されているかどうかを示します。
    • RelationshipDisplayName; string;ソース・オブジェクトとターゲット・オブジェクト間の関係の表示名。
    • RelationshipId; integer; ソース・オブジェクトとターゲット・オブジェクト間の関係の一意の識別子。
    • RelationshipName; string;ソース・オブジェクトとターゲット・オブジェクト間の関係の名前。
    • RelationshipTypeCode; string; ソース・オブジェクトとターゲット・オブジェクト間の関係のタイプ。
    • SourceObjectCode; string; アクセス拡張ルールで使用されるソース・オブジェクトのコード。
    • SourceObjectName; string; アクセス拡張ルールで使用されるソース・オブジェクトの名前。
    • TargetObjectCode; string; アクセス拡張ルールで使用されるターゲット・オブジェクトのコード。
    • TargetObjectName; string; アクセス拡張ルールで使用されるターゲット・オブジェクトの名前。
    • UpdateFlag; boolean;レコードを更新できるかどうかを示します。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : accessGroupExtensionRules
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : accessGroupExtensionRules-item-response
タイプ: object
ソースを表示
  • Access Group Extension Rule Details
    タイトル: Access Group Extension Rule Details
    アクセス拡張ルール詳細リソースは、アクセス拡張ルールの詳細を表示、作成、更新および削除するために使用されます。 アクセス拡張ルール詳細を使用して、オブジェクト共有ルール内のオブジェクトに定義されているアクセスを関連オブジェクトに拡張します。
  • タイトル: Access Extension Rule ID
    アクセス拡張ルールの一意の識別子。
  • タイトル: Access Extension Rule Number
    最大長: 30
    アクセス拡張ルールの代替キー識別子。 システム生成の一意の連番です。
  • タイトル: Active
    最大長: 1
    デフォルト値: true
    アクセス拡張ルールがアクティブかどうかを示します。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    アクセス拡張ルールを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    アクセス拡張ルールが作成された日付。
  • タイトル: Delete
    読取り専用: true
    レコードを削除できるかどうかを示します。
  • タイトル: Description
    最大長: 255
    アクセス拡張ルールの説明。
  • タイトル: Extend All Rules Indicator
    最大長: 1
    デフォルト値: true
    ソース・オブジェクトからターゲット・オブジェクトに拡張するルールを識別するために使用するメソッドを示します。
  • タイトル: Last Update Date
    読取り専用: true
    アクセス拡張ルールが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    アクセス拡張ルールを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    アクセス拡張ルールを最後に更新したユーザーのログイン詳細。
  • Links
  • タイトル: Name
    最大長: 200
    アクセス拡張ルールの名前。
  • タイトル: Predefined Indicator
    読取り専用: true
    最大長: 255
    アクセス拡張ルールが事前定義されているかどうかを示します。
  • タイトル: Relationship Display Name
    読取り専用: true
    ソース・オブジェクトとターゲット・オブジェクト間の関係の表示名。
  • タイトル: Related Object
    ソース・オブジェクトとターゲット・オブジェクト間の関係の一意の識別子。
  • タイトル: Relationship Name
    ソース・オブジェクトとターゲット・オブジェクト間の関係の名前。
  • タイトル: Relationship Type Code
    ソース・オブジェクトとターゲット・オブジェクト間の関係のタイプ。
  • タイトル: Source Object Code
    読取り専用: true
    アクセス拡張ルールで使用されるソース・オブジェクトのコード。
  • タイトル: Source Object Name
    読取り専用: true
    アクセス拡張ルールで使用されるソース・オブジェクトの名前。
  • タイトル: Target Object Code
    読取り専用: true
    アクセス拡張ルールで使用されるターゲット・オブジェクトのコード。
  • タイトル: Target Object Name
    読取り専用: true
    アクセス拡張ルールで使用されるターゲット・オブジェクトの名前。
  • タイトル: Update
    読取り専用: true
    レコードを更新できるかどうかを示します。
ネストされたスキーマ : アクセス・グループ拡張ルール詳細
タイプ: array
タイトル: Access Group Extension Rule Details
アクセス拡張ルール詳細リソースは、アクセス拡張ルールの詳細を表示、作成、更新および削除するために使用されます。 アクセス拡張ルール詳細を使用して、オブジェクト共有ルール内のオブジェクトに定義されているアクセスを関連オブジェクトに拡張します。
ソースを表示
ネストされたスキーマ : accessGroupExtensionRules-accessGroupExtensionRuleDetails-item-response
タイプ: object
ソースを表示
  • タイトル: Group Number
    ソース・オブジェクトのルールに関連付けられているアクセス・グループの代替キー識別子。
  • タイトル: Access Extension Rule Detail ID
    アクセス拡張ルール詳細の一意の識別子。
  • タイトル: Access Extension Rule ID
    アクセス拡張ルールの一意の識別子。
  • タイトル: Access Extension Rule Number
    読取り専用: true
    最大長: 30
    アクセス拡張ルールの代替キー識別子。 システム生成の一意の連番です。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    アクセス拡張ルールを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    アクセス拡張ルールが作成された日付。
  • タイトル: Delete Access Permission Indicator
    最大長: 1
    デフォルト値: false
    削除アクセス権が付与されているかどうかを示します。
  • タイトル: Delete
    読取り専用: true
    レコードを削除できるかどうかを示します。
  • タイトル: Last Update Date
    読取り専用: true
    アクセス拡張ルールが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    アクセス拡張ルールを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    アクセス拡張ルールを最後に更新したユーザーのログイン詳細。
  • Links
  • タイトル: Read Access Permission Indicator
    最大長: 1
    デフォルト値: false
    読取りアクセス権が付与されているかどうかを示します。
  • タイトル: Source Object Access Group ID
    ソース・オブジェクトのルールに関連付けられているアクセス・グループの一意の識別子。
  • タイトル: Source Object Rule GUID
    最大長: 64
    ソース・オブジェクトのルールの一意の識別子。
  • タイトル: Source Object Rule Number
    ソース・オブジェクトのルールの代替キー識別子。
  • タイトル: Update Access Permission Indicator
    最大長: 1
    デフォルト値: false
    更新アクセス権が付与されているかどうかを示します。
  • タイトル: Update
    読取り専用: true
    レコードを更新できるかどうかを示します。
トップに戻る

例:

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

cURLコマンド

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

レスポンス本文の例

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

{
    "items": [
        {
            "AccExtRuleId": 1,
            "ActiveFlag": false,
            "CreatedBy": "SEED_DATA_FROM_APPLICATION",
            "CreationDate": "2020-09-10T18:27:45.082+00:00",
            "Description": "Predefined rule for contacts of related account team.",
            "ExtendAllRulesFlag": false,
            "LastUpdateDate": "2021-06-10T09:44:00.456+00:00",
            "LastUpdateLogin": "-1",
            "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
            "Name": "Contacts of Related Account Team",
            "RelationshipId": 100100216995688,
            "AccExtRuleNumber": "AccountContactRule1",
            "PredefinedFlag": true,
            "RelationshipName": "AccountToContact",
            "RelationshipDisplayName": "Account to Contact (Standard)",
            "SourceObjectCode": "Account",
            "TargetObjectCode": "Contact",
            "UpdateFlag": true,
            "DeleteFlag": false,
            "SourceObjectName": "Account",
            "TargetObjectName": "Contact",
            "RelationshipTypeCode": "STANDARD",
            "links": [
      {
       "rel": "self",
       "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroupExtensionRules/AccountContactRule1",
       "name": "accessGroupExtensionRules",
       "kind": "item",
       "properties": {
         "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
      },
      .....
      ],
  }
      ]
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroupExtensionRules",
            "name": "accessGroupExtensionRules",
            "kind": "collection"
        }
    ]
}
「トップに戻る」