updateMetadata()
構文
1SaveResult[] = metadataConnection.updateMetadata(Metadata[] metadata);使用方法
updateMetadata() コールは、メタデータを拡張するすべてのコンポーネントの更新に使用します。同一コール内のすべてのコンポーネントは、同じ種類である必要があります。詳細は、「Metadata コンポーネントおよびメタデータ型」を参照してください。
このコールは同期して実行されます。つまり、コールは、操作が完了したときにのみ戻ります。
API バージョン 34.0 以降、このコールで AllOrNoneHeader ヘッダーがサポートされます。デフォルトでは、AllOrNoneHeader が API バージョン 34.0 以降で使用されていない場合、このコールでエラーのない一部のレコードを保存できます (AllOrNoneHeader=false に相当)。API バージョン 33.0 以前の場合、デフォルトでは、コール内のどのレコードにもエラーがない場合にのみ、すべてのレコードが保存されます (AllOrNoneHeader=true に相当)。
バージョン
API バージョン 30.0 以降で利用できます。
権限
クライアントアプリケーションは、「メタデータ API 関数を使用したメタデータの変更」権限または「すべてのデータの編集」権限でログインしている必要があります。
必須項目
コンポーネント内のすべての必須項目に値を指定する必要があります。
有効な項目値
項目のデータ型に対して有効な値を入力する必要があります。たとえば、整数項目については整数を入力します (英字は不可)。クライアントアプリケーションでは、使用しているプログラム言語および開発ツールに指定されたデータ形式ルールに従ってください (開発ツールは、SOAP メッセージのデータ型の適切な対応付けを処理します)。
文字列値
String 項目に値を保存する場合、API は先頭および末尾の空白文字を削除します。たとえば、label 項目の値に "MyObject " と入力されると、その値はデータベースに "MyObject" として保存されます。
メタデータコンポーネント更新の基本手順
メタデータコンポーネントを更新するには、次のプロセスを使用します。
- 更新するコンポーネントの配列を作成します。すべてのコンポーネントは同じ種類である必要があります。
-
updateMetadata() コールを呼び出し、更新するメタデータコンポーネントの配列を渡します。
更新しようとするコンポーネントごとに SaveResult オブジェクトが返されます。このオブジェクトには、操作が成功したかどうか、更新されたコンポーネントの名前、操作が成功しなかった場合は返されたエラーに関する情報が含まれます。
サンプルコード — Java
1public void updateCustomObjectSync() {
2 try {
3 CustomObject co = new CustomObject();
4 String name = "MyCustomObject1";
5 co.setFullName(name + "__c");
6 co.setDeploymentStatus(DeploymentStatus.Deployed);
7 co.setDescription("Updated description");
8 co.setLabel(name + " Object Update");
9 co.setPluralLabel(co.getLabel() + "s");
10 co.setSharingModel(SharingModel.ReadWrite);
11
12 // Name field with a type and label is required
13 CustomField cf = new CustomField();
14 cf.setType(FieldType.Text);
15 cf.setLabel(co.getFullName() + " Name");
16 co.setNameField(cf);
17
18 SaveResult[] results = metadataConnection
19 .updateMetadata(new Metadata[] { co });
20
21 for (SaveResult r : results) {
22 if (r.isSuccess()) {
23 System.out.println("Updated component: " + r.getFullName());
24 } else {
25 System.out
26 .println("Errors were encountered while updating "
27 + r.getFullName());
28 for (Error e : r.getErrors()) {
29 System.out.println("Error message: " + e.getMessage());
30 System.out.println("Status code: " + e.getStatusCode());
31 }
32 }
33 }
34 } catch (ConnectionException ce) {
35 ce.printStackTrace();
36 }
37}引数
| 名前 | 型 | 説明 |
|---|---|---|
| metadata | Metadata[] | 更新する 1 つ以上のメタデータコンポーネントの配列。 上限: 10。(CustomMetadata および CustomApplication の場合のみ、上限は 200)。 1 つの種類のコンポーネントの配列を送信する必要があります。たとえば、10 個のカスタムオブジェクトの配列または 10 個のプロファイルの配列を送信できますが、両方の種類を混ぜて送信することはできません。 |