createMetadata()

構文

使用方法

createMetadata() コールは、メタデータを拡張するすべてのコンポーネントの作成に使用します。同一コール内のすべてのコンポーネントは、同じ種類である必要があります。詳細は、「Metadata コンポーネントおよびメタデータ型」を参照してください。

このコールは同期して実行されます。つまり、コールは、操作が完了したときにのみ戻ります。

API バージョン 34.0 以降、このコールで AllOrNoneHeader ヘッダーがサポートされます。デフォルトでは、AllOrNoneHeader が API バージョン 34.0 以降で使用されていない場合、このコールでエラーのない一部のレコードを保存できます (AllOrNoneHeader=false に相当)。API バージョン 33.0 以前の場合、デフォルトでは、コール内のどのレコードにもエラーがない場合にのみ、すべてのレコードが保存されます (AllOrNoneHeader=true に相当)。

バージョン

API バージョン 30.0 以降で利用できます。

権限

クライアントアプリケーションは、「メタデータ API 関数を使用したメタデータの変更」権限または「すべてのデータの編集」権限でログインしている必要があります。

必須項目

作成しているメタデータコンポーネントにより必須項目が決まります。特定のコンポーネントの種類についての詳細は、「Metadata コンポーネントおよびメタデータ型」を参照してください。

有効なデータ値

項目のデータ型に対して有効な値を入力する必要があります。たとえば、整数項目については整数を入力します (英字は不可)。クライアントアプリケーションでは、使用しているプログラム言語および開発ツールに指定されたデータ形式ルールに従ってください (開発ツールは、SOAP メッセージのデータ型の適切な対応付けを処理します)。

文字列値

文字列項目に値を格納する場合、前後にある空白は API が切り捨てます。たとえば、label 項目の値に "MyObject " と入力されると、その値はデータベースに "MyObject" として保存されます。

メタデータコンポーネント作成の基本手順

メタデータコンポーネントを作成する手順は、次のとおりです。

1. 配列を設計し、作成するコンポーネントを挿入します。すべてのコンポーネントは同じ種類である必要があります。
2. 引数にコンポーネント配列を渡し、createMetadata() をコールします。
3. 作成しようとしたコンポーネントごとに SaveResult オブジェクトが返されます。このオブジェクトには、操作が成功したかどうか、作成されたコンポーネントの名前、操作が成功しなかった場合は返されたエラーに関する情報が含まれます。

サンプルコード — Java

引数

応答

SaveResult[]