Get a Planning Unit Owner Photo

Returns an image for the requested planning unit owner if a photo is uploaded for the owner.

REST Resource

GET /HyperionPlanning/rest/{api_version}/applications/{application}/users/{userId}/photo

Request

Supported Media Types: application/json

Parameters:

The following table summarizes the client request.

Table 5-48 Parameters

Name Description Type Required Default
api_version Version of the API you are developing with Path Yes None
application The name of the application Path Yes None
userID The identifier of the user for whom to retrieve a photo Path Yes  

Example URL

https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v3/applications/PS4app1/users/5000100/photo

Response

Supported Media Types: In case of success, returns application/octet-stream. In case of error, returns application/json.

Error Response:

Table 5-49 Parameters

Name Description
detail Detail about the status of the planning unit photo for this user. For example: PU photo not available, make sure that a valid user identifier is provided.
status HTTP status, such as 400.
message Informational message about the status of the photo for this user.
localizedMessage A localized informational message about the status.

Example of Error Response Body

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

{
    "detail": "PU photo not available, make sure the a valid user identifier is provided.",
    "status": 400,
    "message": "java.lang.RuntimeException: PU photo not available, make sure the a valid user identifier is provided.",
    "localizedMessage": "java.lang.RuntimeException: PU photo not available, make sure the a valid user identifier is provided."
}