Set Restricted Data Access

The Set Restricted Data Access REST API enables/disables the selection of "Submit Application Snapshot" by the Service Administrator while submitting Provide Feedback.

This REST API is version v2.

Required Roles

Service Administrator

REST Resource

PUT /interop/rest/{api_version}/config/services/restricteddataaccess

Note:

Before using the REST resources, you must understand how to access the REST resources and other important concepts. See Implementation Best Practices for EPM Cloud REST APIs. Using this REST API requires prerequisites. See Prerequisites.

Request

Supported Media Types: application/json

The following table summarizes the PUT request parameters:

Table 10-4 Parameters

Name Description Type Required Default
api_version Specific API version Path Yes None
dataAccessRestriction Enable/Disable restricted data access; possible values are true and false Payload Yes None

Example of Request Body

{
    "dataAccessRestriction": "true"
}

Response

Supported Media Types: application/json

Table 10-5 Parameters

Name Description
details Detailed status of the operation performed.
status See Migration Status Codes
links Detailed information about the link and HTTP call type
href Links to API call or status API
action The HTTP call type
rel Possible values: self or Job Status. If the value is set to Job Status, you can use the href to get the status
error Detailed information about the error
data Parameters as key value pairs passed in the request

Example of Response Body

{
    "details": null,
    "status": 0,
    "items": null,
    "links": [
        {
            "href": "<uri>/interop/rest/v2/config/services/restricteddataaccess",
            "action": "PUT",
            "rel": "self",
            "data": null
        }
    ]
}

Sample cURL command

curl -X PUT -s -u '<USERNAME>:<PASSWORD>' -o response.txt -D respHeader.txt -H 
'Content-Type: application/json' -d '{"dataAccessRestriction":"true"}' 'https://<BASE-URL>/interop/rest/v2/config/services/restricteddataaccess'