Preview top level entities
post
/imports
Returns list of all entity physical type and names.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
xmlFile(required): string
Name of the XML file.
Exported XML or JSON file.
Root Schema : import-payload
Type:
Show Source
object
-
xl-ddm-data:
object xl-ddm-data
Contains the exported XML or JSON file.
Nested Schema : xl-ddm-data
Type:
object
Contains the exported XML or JSON file.
Security
-
basicAuth: basic
Type:
basic
Response
Supported Media Types
- application/json
- application/xml
200 Response
OK
Root Schema : previewentity-response
Type:
array
The request was successfully completed. The response body includes information about the entities.
Show Source
Nested Schema : previewentity-array
Type:
Show Source
object
-
entityName:
string
Name of the entity that matches the preview operation.
-
entityType:
string
Type of the entity that matches the preview operation.
-
entityTypeDisplay:
string
Specify the display name of entity type which is locale dependent.
-
message:
string
The text message of preview operation that can be displayed on the interface, if any.
Examples
This example retrieves list of all entity physical type and names. The information shown here is against a pseudo system and serves as a prototype.
cURL Example
curl -H "Content-Type: application/xml" -H Accept: application/json" -H "X-Requested-By: <anyvalue>" -X POST -u username:password https://pseudo.com/iam/governance/configmgmt/rest/imports?xmlFile=test.xml -d '<<Content of the xml file to be imported>>'
Example of GET Response Body
The following example shows the contents of the response body in JSON format.
[ { "entityType": "Organization", "entityTypeDisplay": "Organization", "entityName": "Top", "message": null }, { "entityType": "PasswordPolicy", "entityTypeDisplay": "Password Policy", "entityName": "Default Policy", "message": null }, ..