機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. サブスクリプション・アカウントのロール

すべてのサブスクリプション・アカウント・ロールを取得

get

/crmRestApi/resources/11.13.18.05/subscriptionAccountRoles

リクエスト

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

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

    • PrimaryKey : 指定された主キーを持つサブスクリプション・アカウント・ロールを検索します。
      ファインダ変数:
      • SubscrAccMgmtRoleId; integer; サブスクリプション・アカウント・ロールの一意の識別子。
    • RowFinder : 指定されたサブスクリプション・アカウント・ロール番号を持つサブスクリプション・アカウント・ロールを検索します。
      ファインダ変数:
      • SubscrAccRoleNumber; string; サブスクリプション・アカウント・ロールの代替一意識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CorpCurrencyCode; string; サブスクリプション・アカウントに関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • CreatedBy; string; サブスクリプション・アカウント・ロールを作成したユーザー。
    • CreationDate; string; サブスクリプション・アカウント・ロールが作成された日付。
    • CurcyConvRateType; string;通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • CurrencyCode; string;通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • EmailAddress; string; パーティのプライマリ電子メール・アドレス。
    • LastUpdateDate; string; サブスクリプション・アカウント・ロールが更新された日付。
    • LastUpdateLogin; string; サブスクリプション・アカウント・ロールを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; サブスクリプション・アカウント・ロールを最後に更新したユーザー。
    • PartyId; integer; ロールが関連付けられているサブスクリプション・アカウントの一意の識別子。
    • PartyName; string; サブスクリプション・アカウントに関連付けられたパーティの名前。
    • PartyNumber; string; サブスクリプション・アカウントの一意の代替識別子。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERがTrueに設定されている場合、値を更新できます。 デフォルト値は、プロファイル・オプションZCA_PUID_PREFIXで指定された値と一意のシステム生成順序番号を連結した値です。
    • PartyType; string; サブスクリプション・アカウントに関連付けられたパーティのタイプ。
    • PersonFirstName; string;個人の名。
    • PersonLastName; string;個人の姓。
    • RoleName; string;サブスクリプション・アカウントのロール名。
    • SubscrAccMgmtRoleId; integer; サブスクリプション・アカウント・ロールの一意の識別子。
    • SubscrAccRoleNumber; string; サブスクリプション・アカウント・ロールの代替一意識別子。
    • SubscrAccountNumber; string; サブスクリプション・アカウントの代替の一意の識別子。
    • SubscriptionAccountId; integer; ロールに関連付けられたサブスクリプション・アカウントの一意の識別子。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : subscriptionAccountRoles
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : subscriptionAccountRoles-item-response
タイプ: object
ソースを表示
  • タイトル: Corporate Currency Code
    最大長: 15
    サブスクリプション・アカウントに関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    サブスクリプション・アカウント・ロールを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    サブスクリプション・アカウント・ロールが作成された日付。
  • タイトル: Currency Conversion Rate Type
    最大長: 30
    通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Currency Code
    最大長: 15
    通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • 読取り専用: true
    ロールを削除するかどうかを示します。 値がYの場合、ロールを削除する必要があります。 デフォルト値はNです。
  • タイトル: Primary Email
    読取り専用: true
    最大長: 320
    パーティのプライマリEメール・アドレス。
  • タイトル: Last Updated Date
    読取り専用: true
    サブスクリプション・アカウント・ロールが更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    サブスクリプション・アカウント・ロールを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    サブスクリプション・アカウント・ロールを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Party ID
    ロールが関連付けられているサブスクリプション・アカウントの一意の識別子。
  • タイトル: Name
    読取り専用: true
    最大長: 360
    サブスクリプション・アカウントに関連付けられたパーティの名前。
  • タイトル: Registry ID
    最大長: 30
    サブスクリプション・アカウントの一意の代替識別子。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERがTrueに設定されている場合、値を更新できます。 デフォルト値は、プロファイル・オプションZCA_PUID_PREFIXで指定された値と一意のシステム生成順序番号を連結した値です。
  • タイトル: Party Type
    読取り専用: true
    最大長: 30
    サブスクリプション・アカウントに関連付けられたパーティのタイプ。
  • タイトル: First Name
    読取り専用: true
    最大長: 150
    個人の名。
  • タイトル: Last Name
    読取り専用: true
    最大長: 150
    個人の姓。
  • タイトル: Role
    最大長: 30
    サブスクリプション・アカウントのロール名。
  • タイトル: Subscription Account Roles ID
    読取り専用: true
    サブスクリプション・アカウント・ロールの一意の識別子。
  • タイトル: Subscription Account Number
    最大長: 30
    サブスクリプション・アカウントの代替一意識別子。
  • タイトル: Subscription Account Role Number
    最大長: 30
    サブスクリプション・アカウント・ロールの代替一意識別子。
  • タイトル: Subscription Account ID
    ロールに関連付けられたサブスクリプション・アカウントの一意の識別子。
  • 読取り専用: true
    ロールを更新できるかどうかを示します。 値がYの場合、ロールを更新できます。 デフォルト値はNです。
「トップに戻る」