メタデータ API 開発者ガイド
jrenameMetadata()
構文
1SaveResult = metadataConnection.renameMetadata(string metadataType, String oldFullname, String newFullname);使用方法
renameMetadata() コールを使用して、組織の 1 つのメタデータコンポーネントの名前を変更します。このコールは同期して実行されます。つまり、コールは、操作が完了したときにのみ戻ります。
このコールは、Metadata を拡張するいずれかのオブジェクトの名前を変更するために使用できます。詳細は、「Metadata コンポーネントおよびメタデータ型」を参照してください。
バージョン
API バージョン 30.0 以降で利用できます。
権限
クライアントアプリケーションは、「メタデータ API 関数を使用したメタデータ���変更」権限または「すべてのデータの編集」権限でログインしている必要があります。
メタデータコンポーネントの名前変更の基本手順
メタデータコンポーネントの名前を変更する手順は、次のとおりです。
- 名前を変更するコンポーネントのメタデータ型、現在の完全名、および新しい完全名を判別します。fullName 項目についての詳細は、「Metadata」を参照してください。
-
renameMetadata() コールを呼び出します。最初の引数で、メタデータ型の名前を渡します。2 つ目の引数として以前の完全名、最後の引数として新しい完全名を渡します。
操作が成功したかどうかに関する情報を含む SaveResult オブジェクトが返されます。成功した場合、オブジェクトには名前変更後のコンポーネントの名前 (新しい名前) が含まれます。成功しなかった場合、オブジェクトはエラーを返します。
サンプルコード — Java
1public void renameCustomObjectSync() {
2 try {
3 SaveResult[] results = metadataConnection.renameMetadata(
4 "CustomObject", "MyCustomObject1__c","MyCustomObject1New__c");
5 for (SaveResult r : results) {
6 if (r.isSuccess()) {
7 System.out.println("Renamed component: " + r.getName());
8 }
9 else {
10 System.out.println("Errors were encountered while renaming " + r.getName());
11 for(Error e : r.getErrors()) {
12 System.out.println("Error message: " + e.getMessage());
13 System.out.println("Status code: " + e.getStatusCode());
14 }
15 }
16 }
17 } catch (ConnectionException ce) {
18 ce.printStackTrace();
19 } catch (InterruptedException ie) {
20 ie.printStackTrace();
21 }
22}引数
| 名前 | 型 | 説明 |
|---|---|---|
| metadataType | string | 名前を変更するコンポーネントのメタデータ型。 |
| oldFullName | string | コンポーネントの現在の完全名。 |
| newFullName | string | 新規コンポーネントの完全名。 |