Jump to

• Request
• Response
• Examples

Export operation on entities

post

/exports

Export list of entities based on entity type and entity name.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• dependencies: string
  Supported values are yes and /no. Yes indicates export entities along with all dependencies and children. No indicates only export entities without any dependency and children.
• description: string
  A short description to identify the export components.

Body ()

The request body defines the list of entities to be exported.

Root Schema : export-postpayload

Type: object

Show Source

• entity(optional): array entity
  The request body defines the list of entities to be exported.

{
    "properties":{
        "entity":{
            "type":"array",
            "description":"The request body defines the list of entities to be exported.",
            "items":{
                "$ref":"#/definitions/export-postpayload-array"
            }
        }
    }
}

Nested Schema : entity

Type: array

The request body defines the list of entities to be exported.

Show Source

• Array of: object export-postpayload-array
  Defines the entity type and entity name of entities.

{
    "type":"array",
    "description":"The request body defines the list of entities to be exported.",
    "items":{
        "$ref":"#/definitions/export-postpayload-array"
    }
}

Nested Schema : export-postpayload-array

Type: object

Defines the entity type and entity name of entities.

Show Source

• entityName(optional): string
  Defines the name of the entity.
• entityType(optional): string
  Defines the type of the entity.

{
    "description":"Defines the entity type and entity name of entities.",
    "properties":{
        "entityType":{
            "type":"string",
            "description":"Defines the type of the entity."
        },
        "entityName":{
            "type":"string",
            "description":"Defines the name of the entity."
        }
    }
}

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Body ()

Root Schema : exportentity-response

Type: object

Show Source

• xl-ddm-data(optional): object xl-ddm-data
  Contains the entity type objects that is exported.

{
    "properties":{
        "xl-ddm-data":{
            "type":"object",
            "description":"Contains the entity type objects that is exported."
        }
    }
}

Nested Schema : xl-ddm-data

Type: object

Contains the entity type objects that is exported.

Back to Top

Examples

This example retrieves list of entities to be exported. The information shown here is against a pseudo system and serves as a prototype.

cURL Example

curl  -H "Content-Type: application/json"  -H Accept: application/xml"  -H "X-Requested-By: <anyvalue>"  -X POST -u username:password  https://pseudo.com/iam/governance/configmgmt/rest/exports?description=testing&dependencies=yes  -d  '{entity":[{"entityType":"AdminRole","entityName":"OrclOIMSystemConfigurator"},{"entityType":"AdminRole","entityName":"OrclOIMCatalogAdmin"},{"entityType":"ScheduledTask", "entityName":"ADTrustedRecon"},{"entityType":"ApplicationInstance", " entityName":"ADApp"}]}'

Example of Response Body

The following example shows the contents of the response body in JSON format.

[
<?xml version = '1.0' encoding = 'UTF-8'?>
xl-ddm-data version="11.1.2.3.0" user="XELSYSADM" database="jdbc:oracle:thin:@slc05sab:1521:oimdb" exported-date="1458029888796" description="SampleExport">
    AdminRole repo-type="API" name="OrclOIMSystemAdministrator">
        scopedOrgList><scope><id>3</id><isHierarchical>true</isHierarchical><name>Top</name></scope>/scopedOrgList>
        scoped>false/scoped>
        roleDisplayName>System Administrator/roleDisplayName>
        roleId>1/roleId>
        custom>false/custom>
        roleDescription>OIM System Administrator Role with All Privileges/roleDescription>
        scopeIds Organization="Top"/>
    AdminRole
    AdminRole repo-type="API" name="OrclOIMSystemConfigurator">
        scopedOrgList><scope><id>3</id><isHierarchical>true</isHierarchical><name>Top</name></scope>/scopedOrgList>
        capabilities


curl  -H "Content-Type: application/xml"  -H "Accept: application/json" -X POST -u username:password  https://pseudo.com/iam/governance/configmgmt/rest/exportsdescription=testing&dependencies=yes  -d  ???{ "entityList": [  { "entityType":"AdminRole","entityName":"OrclOIMSystemConfigurator"},               
{ 
  "entityType":"AdminRole", 
  "entityName":"OrclOIMCatalogAdmin"
},
 {
  "entityType":"ScheduledTask", "entityName":"ADTrustedRecon"
},
{
"entityType":"ApplicationInstance", " entityName":"ADApp"
}
]
}???

Back to Top