Metadata
The following operations can be performed on the metadata of the Business Directory:
| • | GET /metadata |
| • | PUT /metadata |
| • | GET /metadata/annotation/{tableName} |
| • | GET /metadata/ws |
GET /metadata
This API is used to export full metadata of Business Directory to a file.
Parameters
|
Name |
Description |
Parameter Type |
Data Type |
|
encryptionPassword |
Encryption password |
query |
string |
Example to export metadata
curl -u "admin:admin" -X GET "https://localhost:9502/rest/v2/metadata?encryptionPassword=testPassword" -o export001.car
Example to export metadata as ldap user with BD_ADMIN and ACCESS_DIRECTORY rights
curl -u "user@ldapDomain:password" -X GET "https://localhost:9502/rest/v2/metadata?encryptionPassword=testPassword" -o export001.car
PUT /metadata
This API is used to import full metadata of Business Directory from a file.
Parameters
|
Name |
Description |
Parameter Type |
Data Type |
|
file |
Name of the file to be imported. |
query |
object |
|
encryptionPassword |
Encryption Password |
query |
string |
|
overwrite |
Option to indicate whether to overwrite |
query |
boolean |
|
ignoreEncryption |
Option to indicate whether encryption errors can be ignored |
query |
boolean |
Note: If the option ignoreEncryption is used, then all backup data will be imported regardless of whether a valid encryption key was provided. This means that the import will not fail. This option can be used to allow partially importing any backed up data. However, the import process will only import data that is not encrypted or can be decrypted using the provided encryption key. All encrypted portions of the backup data that cannot be decrypted will be imported as empty values and the import will otherwise succeed.
This affects all encrypted values in the backup data, which includes, but is not limited to data source and LDAP domain connection passwords.
Example to import metadata
curl -u "admin:admin" -i -F "encryptionPassword=testPassword" -F "overwrite=true" -F "file=@export001.car" -X PUT "https://localhost:9502/rest/v2/metadata"
Example to import metadata as ldap user with BD_ADMIN and ACCESS_DIRECTORY rights
curl -u "user@ldapDomain:password" -i -F "encryptionPassword=testPassword" -F "overwrite=true" -F "file=@export001.car" -X PUT "https://localhost:9502/rest/v2/metadata"
Example to import metadata (X-HTTP-Method-Override)
curl -u "admin:admin" -i -H "X-HTTP-Method-Override:PUT" -F "encryptionPassword=testPassword" -F "overwrite=true" -F "file=@export001.car" -X POST "https://localhost:9502/rest/v2/metadata"
Example to import metadata (ignoring encryption errors)
curl -u "admin:admin" -i -F "encryptionPassword=testPassword" -F "overwrite=true" -F "ignoreEncryption=true" -F "file=@export001.car" -X PUT "https://localhost:9502/rest/v2/metadata"
GET /metadata/annotation/{tableName}
This API is used to retrieve annotation for a given table
Parameters
|
Name |
Description |
Parameter Type |
Data Type |
|
tableName |
|
path |
string |
Example
curl -X GET -u admin:admin "https://localhost:9502/rest/v2/metadata/annotation/SYS_SITES"
GET /metadata/ws
This API is used to get web service metadata, such as url, soap version, protocol etc. Returns a set of tuples in a JSON array: [{key:value, key:value, key:value}, {key:value, key:value, key:value}].
Parameters
|
Name |
Description |
Parameter Type |
Data Type |
|
clientWSPath |
client web service path |
query |
string |
Example
curl -X GET -u admin:admin "https://localhost:9502/rest/v2/metadata/ws?clientWSPath=/services/webservices/localhost_9400/soap_test/binding_test"