DescribeQuickActionResult | SOAP API 開発者ガイド

describeQuickActions() コールは、DescribeQuickActionResult オブジェクトの配列を返します。各 DescribeQuickActionResult オブジェクトは、指定されたオブジェクトへのクイックアクションを表します。

名前	型	説明
actionEnumOrId	string	アクションの一意の ID。アクションに ID がない場合、API 名が使用されます。この項目は、API バージョン 35.0 以降で使用できます。
canvasApplicationName	string	キャンバスアプリケーションの名前 (使用されている場合)。
colors	DescribeColor[]	色情報の配列。各色はテーマに関連付けられています。この項目は、API バージョン 29.0 以降で使用できます。
defaultValues	DescribeQuickActionDefaultValue[]	アクションのデフォルト値。
height	int	アクションペインの高さ (ピクセル単位)。
iconName	string	アクションに使用するアイコンの名前。カスタムアイコンが使用されていない場合、この値は設定されません。
iconUrl	string	アクションに使用するアイコンの URL。このアイコン URL は、Spring '10 で導入された現在の Salesforce テーマに使用される 32x32 アイコン、またはカスタムアイコン (存在する場合) に対応します。
icons	DescribeIcon[]	アイコンの配列。各アイコンはテーマに関連付けられています。クイックアクションに関連付けられたカスタムアイコンがなく、クイックアクションによって特定のオブジェクトが作成される場合、アイコンは作成されるオブジェクトに使用されるアイコンに対応します。たとえば、クイックアクションによって取引先が作成される場合、アイコン配列には取引先に使用されるアイコンが含まれます。カスタムアイコンがクイックアクションに関連付けられていた場合、配列にはそのカスタムアイコンが含まれます。この項目は、API バージョン 29.0 以降で使用できます。API バージョン 32.0 以降では、それより前の API バージョンとは異なるアイコンを返します。
label	string	アクションの表示ラベル。
layout	DescribeLayoutSection	アクションが存在するレイアウトのセクション。
lightningComponentBundleId	ID	type が `LightningComponent` の場合、アクションでコールされる Lightning コンポーネントバンドルの ID。この項目は、API バージョン 38.0 以降で使用できます。
lightningComponentBundleName	string	type が `LightningComponent` の場合、アクションでコールされる Lightning コンポーネントバンドルの名前。この項目は、API バージョン 38.0 以降で使用できます。
miniIconUrl	string	アイコンの URL。このアイコン URL は、Spring '10 で導入された現在の Salesforce テーマに使用される 16×16 アイコン、またはカスタムアイコン (存在する場合) に対応します。
name	string	アクションの名前。
contextSobjectType	string	アクションに使用するオブジェクト。バージョン 29.0 以前の名前付き sourceSobjectType。
showQuickActionVfHeader	boolean	Visualforce クイックアクションヘッダーとフッターを表示するかどうか。`false` に設定すると、クイックアクションのタイトルが含まれるヘッダーと、[保存] および [キャンセル] ボタンが含まれるフッターの両方が非表示になります。
targetParentField	string	アクションの親オブジェクト種別。対象オブジェクトを親オブジェクトにリンクします。たとえば、対象オブジェクトが取引先責任者であり、親オブジェクトが取引先である場合、取引先を使用します。
targetRecordTypeId	ID	対象レコードのレコードタイプ。
targetSobjectType	string	アクションの対象オブジェクト種別。
type	string	アクションの種別。有効な値は、次のとおりです。 `Canvas` `Create` `Flow` (この値は API バージョン 41.0 以降でベータとして使用できます) `LightningComponent` (この値は API バージョン 38.0 以降で使用できます)。 `LogACall` `Post` `SendEmail` (この値は API バージョン 31.0 以降で使用できます)。 `SocialPost` `Update` `VisualforcePage`
visualforcePageName	string	type が Visualforce の場合、アクションに関連付けられたページのページ名。
visualforcePageUrl	string	type が Visualforce の場合、アクションに関連付けられたページの URL。
width	int	カスタムアクションを作成する場合、この値がアクションペインの幅 (ピクセル単位) になります。

DescribeQuickActionDefaultValue

デフォルトレイアウトで使用する項目のデフォルト値を表します。

名前	型	説明
defaultValue	string	自動的に取り込まれたデフォルトアクションの値。
field	string	アクションの項目名。

DescribeLayoutSection

DescribeLayout のセクションを表し、1 つ以上の列および 1 つ以上の行から構成されます (DescribeLayoutRow の配列)。

名前	型	説明
columns	int	この DescribeLayoutSection の列数。
heading	string	この DescribeLayoutSection のヘッダーのテキスト (表示ラベル)。
layoutRows	DescribeLayoutRow[]	1 つ以上の DescribeLayoutRow オブジェクトの配列。
parentLayoutId	ID	この DescribeLayoutSection が存在するレイアウトの ID。この項目は、API バージョン 35.0 以降で使用できます。
rows	int	この DescribeLayoutSection の行数。
tabOrder	string	編集ビューのセクションの項目のタブ順序を示します。有効な値は、次のとおりです。 LeftToRight TopToBottom この項目は、API バージョン 31.0 以降で使用できます。
useCollapsibleSection	boolean	この DescribeLayoutSection が折りたたみ可能な (「twistie」な) セクションかどうかを示します (可能な場合は `true`、不可能な場合は `false`)。
useHeading	boolean	heading を表示するか (`true`)、否か (`false`) を示します。

DescribeLayoutRow

DescribeLayoutSection の行を表します。DescribeLayoutRow は DescribeLayoutItem で構成されています。それぞれの DescribeLayoutRow について、DescribeLayoutItem は特定の項目または「空白の」 DescribeLayoutItem (DescribeLayoutComponent オブジェクトを含まない DescribeLayoutItem) を参照します。空の DescribeLayoutItem は、指定された DescribeLayoutRow がまばらである場合返されます (たとえば、左の列より右の列の方が項目が多い場合)。レイアウトに空白がある場合、空の DescribeLayoutItem がプレースホルダとして返されます。

名前	型	説明
layoutItems	DescribeLayoutItem[]	特定の項目または「空」の LayoutItem (DescribeLayoutComponent オブジェクトを含まない LayoutItem) を参照します。
numItems	int	layoutItems の数。この情報は冗長ですが、一般的な SOAP ツールキットのバグによる逐次化の問題を避けるために必要です。

DescribeLayoutItem

DescribeLayoutRow の個別のアイテムを表します。DescribeLayoutItem はコンポーネントセット (DescribeLayoutComponent) で構成され、それぞれは項目または境界です。レイアウトのほとんどの項目で、1 つのレイアウトアイテムごとにコンポーネントは 1 つだけです。ただし、表示のみのビューでは、DescribeLayoutItem は個別項目の組み合わせである場合があります (たとえば、住所は町名、市区郡、都道府県、国、郵便番号のデータから構成することができます)。対応する編集ビューでは、住所項目のそれぞれのコンポーネントは、別個の DescribeLayoutItem に分けられます。

名前	型	説明
editable	boolean	この DescribeLayoutItem が編集可能であるか (`true`)、否か (`false`) を示します。この項目は、API バージョン 30.0 以前で使用できます。API バージョン 31.0 では、editableForNew および editableForUpdate 項目に置き換わりました。
editableForNew	boolean	レコードの新規作成時に、新規 DescribeLayoutItem を編集できるか (`true`)、否か (`false`) を示します。この項目は、API バージョン 31.0 以降で使用できます。
editableForUpdate	boolean	レコードの編集時に、既存の DescribeLayoutItem を編集できるか (`true`)、否か (`false`) を示します。この項目は、API バージョン 31.0 以降で使用できます。
label	string	この DescribeLayoutItem の表示ラベルテキスト。
layoutComponents	DescribeLayoutComponent[]	この DescribeLayoutItem の DescribeLayoutComponent。
placeholder	boolean	この DescribeLayoutItem がプレースホルダか (`true`)、否か (`false`) を示します。`true` の場合、この DescribeLayoutItem は空白となります。
required	boolean	この DescribeLayoutItem が必須項目か (`true`)、否か (`false`) を示します。この機能は、目立つ色 (赤など) で必須項目を表示する場合などに便利です。

DescribeLayoutComponent

レイアウトの最小単位である項目または境界を表します。表示するための項目の参照において、クライアントアプリケーションは LayoutComponent.fieldName の表記法を使用して describeSObjects() コールの項目を参照します。

名前	型	説明
displayLines	int	編集ビューの項目に表示される垂直な線の数。`textarea` および複数選択リストに適用されます。
tabOrder	int	行のアイテムのタブの順序を示します。
type	LayoutComponentType	この LayoutComponent の LayoutComponentType。
value	string	この LayoutComponent の値。LayoutComponentType の値が `Field` の場合、項目の名前。LayoutComponentType 値が `Canvas` の場合のキャンバスアプリケーションの API 名。

LayoutComponentType

DescribeLayoutComponent のタイプを表します。次のいずれかの値が含まれます。

AnalyticsCloud — ページレイアウト上の Analytics ダッシュボード。API バージョン 34.0 以降で利用できます。
Canvas — ページレイアウトのキャンバスコンポーネント。このレイアウトコンポーネントの種類は、API バージョン 31.0 以降で使用できます。
CustomLink — ページレイアウトのカスタムリンク。
EmptySpace — ページレイアウトの空白スペース。
ExpandedLookup — ページレイアウトのモバイルカードセクションにある拡張ルックアップコンポーネント。
Field — 項目名。describeSObjectResult の name 項目への対応付け。
ReportChart — ページレイアウトのレポートグラフ。
SControl — 今後の使用のための予約。
Separator — セミコロン (:) やスラッシュ (/) などの区切り文字。
VisualforcePage — ページレイアウトの Visualforce コンポーネント。