Jump to

• Request
• Response

Reset user preferences

post

/fscmRestApi/resources/11.13.18.05/projectProgramUsers/{PersonId}/action/resetPreferences

Reset program preferences enables you to restore your program management preferences to the default values set by your application administrator for person ID with a value of -1. This reset option can restore preferences for the program financial analysis and the progress analysis defined in the lookup type ORA_PJS_PREFERENCE_TYPES.

Request

Path Parameters

• PersonId(required): number
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• preferencePropertyOne: string
  An additional property of the preference value. Currently, this is for future usage and is optional.
• preferenceType: string
  This code specifies the type of preference, of which there are only two acceptable values. These values include codes for both program financial analysis and progress analysis preferences, which are defined in the lookup type ORA_PJS_PREFERENCE_TYPES
• preferenceValue: string
  The value for the display preference. The value depends on the preference type. Currently, this is for future usage and is optional.
• relatedPreferenceValue: string
  The additional context for your display preference. Currently, this is for future usage and is optional.

{
    "type":"object",
    "properties":{
        "preferenceType":{
            "type":"string",
            "description":"This code specifies the type of preference, of which there are only two acceptable values. These values include codes for both program financial analysis and progress analysis preferences, which are defined in the lookup type ORA_PJS_PREFERENCE_TYPES",
            "nullable":true
        },
        "preferenceValue":{
            "type":"string",
            "description":"The value for the display preference. The value depends on the preference type. Currently, this is for future usage and is optional.",
            "nullable":true
        },
        "relatedPreferenceValue":{
            "type":"string",
            "description":"The additional context for your display preference. Currently, this is for future usage and is optional.",
            "nullable":true
        },
        "preferencePropertyOne":{
            "type":"string",
            "description":"An additional property of the preference value. Currently, this is for future usage and is optional.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  After resetting user preferences, the system returns a status indicating whether the operation was successful. This status can either be Success or Failure.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"After resetting user preferences, the system returns a status indicating whether the operation was successful. This status can either be Success or Failure."
        }
    },
    "additionalProperties":false
}

Back to Top