Create a program preference
post
/fscmRestApi/resources/11.13.18.05/projectProgramUsers/{PersonId}/child/ProgramPreferences
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DefaultFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the performance measure is displayed in the default view of the program analysis user interface. When the value is true, the measure is displayed. -
DisplaySequence: integer
(int64)
Title:
Display Sequence
Default Value:1
The order in which the preference value displays. -
PreferencePropertyEight: string
Maximum Length:
150
An additional property of the preference value. -
PreferencePropertyFive: string
Maximum Length:
150
An additional property of the preference value. -
PreferencePropertyFour: string
Maximum Length:
150
An additional property of the preference value. -
PreferencePropertyNine: string
Maximum Length:
150
An additional property of the preference value. -
PreferencePropertyOne: string
Maximum Length:
150
An additional property of the preference value. -
PreferencePropertySeven: string
Maximum Length:
150
An additional property of the preference value. -
PreferencePropertySix: string
Maximum Length:
150
An additional property of the preference value. -
PreferencePropertyTen: string
Maximum Length:
150
An additional property of the preference value. -
PreferencePropertyThree: string
Maximum Length:
150
An additional property of the preference value. -
PreferencePropertyTwo: string
Maximum Length:
150
An additional property of the preference value. -
PreferenceType: string
Title:
Preference Type
Maximum Length:30
The code that represents the type of preference. Examples for preference type include program currency, watchlists, and preferred performance measures for program analysis. A list of accepted values is defined in the lookup type ORA_PJS_PREFERENCE_TYPES. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. -
PreferenceValue: string
Title:
Preference Value
Maximum Length:240
The value for the display preference. The value depends on the preference type. For program analysis and highlights, provide the performance measure REST API attribute name. Replace the person ID in the REST API path with the value -1 to get a list of valid attribute names for performance measures enabled for programs by your project application administrator. For a program watchlist, provide the program ID. Provide the project ID for a project watchlist. Provide the ISO currency code for your preferred program currency. -
RelatedPreferenceValue: string
Title:
Related Preference Value
Maximum Length:240
The additional context for your display preference. For example, the program ID is the related preference value for a project added to the watchlist.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : projectProgramUsers-ProgramPreferences-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
DefaultFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the performance measure is displayed in the default view of the program analysis user interface. When the value is true, the measure is displayed. -
DisplaySequence: integer
(int64)
Title:
Display Sequence
Default Value:1
The order in which the preference value displays. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PreferenceId: integer
(int64)
Title:
Preference ID
Read Only:true
The unique identifier of the display preference. -
PreferencePropertyEight: string
Maximum Length:
150
An additional property of the preference value. -
PreferencePropertyFive: string
Maximum Length:
150
An additional property of the preference value. -
PreferencePropertyFour: string
Maximum Length:
150
An additional property of the preference value. -
PreferencePropertyNine: string
Maximum Length:
150
An additional property of the preference value. -
PreferencePropertyOne: string
Maximum Length:
150
An additional property of the preference value. -
PreferencePropertySeven: string
Maximum Length:
150
An additional property of the preference value. -
PreferencePropertySix: string
Maximum Length:
150
An additional property of the preference value. -
PreferencePropertyTen: string
Maximum Length:
150
An additional property of the preference value. -
PreferencePropertyThree: string
Maximum Length:
150
An additional property of the preference value. -
PreferencePropertyTwo: string
Maximum Length:
150
An additional property of the preference value. -
PreferenceType: string
Title:
Preference Type
Maximum Length:30
The code that represents the type of preference. Examples for preference type include program currency, watchlists, and preferred performance measures for program analysis. A list of accepted values is defined in the lookup type ORA_PJS_PREFERENCE_TYPES. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. -
PreferenceValue: string
Title:
Preference Value
Maximum Length:240
The value for the display preference. The value depends on the preference type. For program analysis and highlights, provide the performance measure REST API attribute name. Replace the person ID in the REST API path with the value -1 to get a list of valid attribute names for performance measures enabled for programs by your project application administrator. For a program watchlist, provide the program ID. Provide the project ID for a project watchlist. Provide the ISO currency code for your preferred program currency. -
PreferenceValueTranslation: string
Read Only:
true
Maximum Length:255
The user-defined name for the performance measure. -
RelatedPreferenceValue: string
Title:
Related Preference Value
Maximum Length:240
The additional context for your display preference. For example, the program ID is the related preference value for a project added to the watchlist.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.