機械翻訳について

すべてのツールバーを取得

get

/crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars

リクエスト

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

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

    • AltKey_Name : 指定した代替キー値のツールバーを検索します。
      ファインダ変数:
      • DisplayName; string;このツールバーに固有の代替キー。
    • FindMyToolbar : 現在のユーザーのデフォルト・ツールバーの1行を検索します。
      ファインダ変数:
      • PrimaryKey : 指定した主キー値のツールバーを検索します。
        ファインダ変数:
        • ToolbarId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
      • ActiveFlag; boolean;ツールバーを使用できるかどうかを示します。
      • CreatedBy; string;ツールバーを作成したユーザー。
      • CreationDate; string;ツールバーが作成された日時。
      • DefaultVisibleFlag; boolean;ツールバーをデフォルトで表示するかどうかを示します
      • DisplayName; string;ツールバーのわかりやすい名前。
      • LastUpdateDate; string;ツールバーを最後に更新したユーザー。
      • LastUpdateLogin; string;ツールバーを最後に更新したユーザーのログイン。
      • LastUpdatedBy; string;ツールバーが最後に更新された日付。
      • レイアウト;文字列;レイアウトのわかりやすい説明。
      • LwAcceptOnFlag; boolean;このツールバーからの着信エンゲージメントのAccept/Rejectダイアログをライブ・ウィンドウに表示することを示します。
      • 名前;文字列;ツールバーの名前。
      • 方向;文字列;ツールバーの方向。 HORIZONTALまたはVERTICAL
      • OverrideToolbarProfile; string; SVC_OVERRIDE_PARTNER_TOOLBAR_SELECTIONプロファイル名のプロファイル値。
      • PreferredHeight; integer;ツールバーの優先高さ(ピクセル単位)。
      • PreferredWidth; integer;ツールバーの優先幅(ピクセル単位)。
      • SupportedChannels; string;ツールバーでサポートされているチャネル・タイプのカンマ区切りリスト。
      • ToolbarEnabledProfile; string; SVC_PARTNER_MEDIA_TOOLBAR_ENABLEDプロファイル名のプロファイル値。
      • ToolbarId; integer;ツールバーの自動生成された数値および主キー。
      • ToolbarLabel; string;ツールバーのわかりやすいラベル。
      • URL; string;ツールバーのレンダリングのURL。
      • UrlValidDomainName; string;オプションのリダイレクションのドメイン名。
      • Vendor; string;ベンダーの名前のオプション・フィールド。
    • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
    ヘッダー・パラメータ
    • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
    • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

    トップに戻る

    応答

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

    デフォルトのレスポンス

    次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
    ヘッダー
    • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
    • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
    本文( )
    ルート・スキーマ : multiChannelAdapterToolbars
    タイプ: object
    ソースを表示
    ネストされたスキーマ : アイテム
    タイプ: array
    タイトル: Items
    コレクション内のアイテム。
    ソースを表示
    ネストされたスキーマ : multiChannelAdapterToolbars-item-response
    タイプ: object
    ソースを表示
    ネストされたスキーマ : マルチ・チャネル・アダプタ・ツールバーの追加
    タイプ: array
    タイトル: Multi-Channel Adapter Toolbar Additions
    アダプタ・ツールバー追加リソースは、マルチ・チャネル・アダプタ・ツールバーに関する追加のセカンダリ・ユーザー領域を表示、作成、更新および削除するために使用します。 マルチ・チャネル・アダプタ・ツールバーの親の代替構成データを提供します。
    ソースを表示
    ネストされたスキーマ : multiChannelAdapterToolbars-McaToolbarAddition-item-response
    タイプ: object
    ソースを表示
    「トップに戻る」