List the potential change impacts to a data model

Deprecated

Lists the potential change impacts to an existing data model by providing a different version of the XML schema of this data model into the request. By performing this call, no change will be applied to the existing data model though.

For more information about the data model change impact level, see Data model changes and their impact levels.

Note: Only the Super Admin type users with the administration role have access to this API. For more information about MDM user types, see MDM user types and system roles.

Request	`POST /services/rest/system/models/{model}`
Parameters	model: This is a String value which represents the name of the data model whose potential change impacts you want to list. lang: This is a String value of the language code which specifies the language in which the change impacts description will be returned, for example, `en` for English. If this parameter is not specified, the change impacts description in English will be returned.
Headers	Content-Type: `application/xml` or `text/xml` Information noteNote: If the XML declaration is included in the XML request content and the encoding attribute is used, you must set its value to `UTF-8`. Authorization: Basic Authentication scheme
Response	The potential data model change impacts description in XML format.
Status	200 OK: The operation is executed successfully. 400 BAD REQUEST: The request contains invalid parameter. 401 UNAUTHORIZED: Login fails, invalid username or password. 403 FORBIDDEN: Missing required permission. 404 NOT FOUND: The resource does not exist, for example, invalid data model name. 500 INTERNAL SERVER ERROR: Other errors, for example, incorrect schema.

Sample response

The following sample shows the potential change impacts to the data model Company in Get the XML schema of a data model by providing a different version of its XML schema described in Update a data model with XSD.

<result>
    <high>
        <change>
            <message>Element 'Gender' was added.</message>
        </change>
    </high>
    <medium/>
    <low/>
    <entitiesToDrop>
        <entity>Employee</entity>
    </entitiesToDrop>
</result>

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here