Jump to

• Request
• Response
• Examples

Import operation on entities

put

/imports

Import list of entities provided in the input XML or JSON file.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• objectExists: string
  This parameter specifies how objects in target system are handled. Supported values are Skip and Override. Skip specifies that skip the object of input and keep the object of target system. Override specifies that target system object should be overridden or updated with the input object.
• role: string
  Role value to be replaced in all references. Supported values are keepOriginal and change. Change should be passed as change=.
• user: string
  User value to be replaced in all references. Supported values are keepOriginal and change. Change should be passed as change=.
• xmlFile: string
  Name of the XML file.

Body ()

Exported XML/JSON file

Root Schema : import-payload

Type: object

Show Source

• xl-ddm-data(optional): object xl-ddm-data
  Contains the exported XML or JSON file.

{
    "properties":{
        "xl-ddm-data":{
            "type":"object",
            "description":"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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Back to Top

Examples

This example retrieves list of entities provided in the input XML or JSON file that has to be imported. 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 PUT -u username:password  https://pseudo.com/iam/governance/configmgmt/rest/imports?xmlFile=test.xml&user=chang=John&role=keepOriginal&objectExists=skip  -d '<<Content of the xml file to be imported>>'

Example of Response Body

The following example shows the contents of the response body.

Import successful 

Back to Top