Oracle Prime Projects REST API

View User Preferences by Setting Name

get

/primeapi/restapi/userPreferences/name/{name}

This endpoint returns user preferences that meet the following requirements:

The object has a name that matches the value of the {name} path parameter.

Request

Path Parameters

name: string

The name of a user preference.

Allowed Values: [ "ActivitiesViewSettings", "ActivityNetworkSettings", "ReportsSummaryGridViewConfig", "DecimalPlaces", "NumberDecimalPlaces", "CurrencySymbol", "FourDigitYear", "LeadingZeros", "MonthName", "Separator", "DateFormat", "DigitGroupingSeparator", "DecimalSeparator", "DigitGroupingAndDecimalSymbols", "DigitGroupingStyle", "CurrencyNegativeFormat", "CurrencyPositiveFormat", "TabOrder", "AppVisibilityAndOrder", "ProjectCodesViewConfig", "ProfileImage", "ReportColWidth", "ReportScheduleColWidth", "ScheduleColWidth", "WorkspaceAndProjectDisplayFormat", "AnnouncementsLastReadTime", "LocationsViewConfig", "workflowTasksPrefs", "WorkflowViewLogViewConfig", "monitorWorkflowsPrefs", "startWorkflowsPrefs", "workflowDesignsPrefs", "workflowConfigsPrefs", "monitorWorkflowTasksPrefs", "formTemplatesPrefs", "formPreviewPrefs", "userDashboardPref", "SearchAll", "SearchWorkspaces", "SearchProjects", "SearchScopeItems", "SearchProjectPortfolio", "SearchProjectCodes", "SearchGenericPortfolios", "SearchActivities", "SearchDocuments", "SearchUsers", "SearchRisks", "SearchIdeas", "NumberResultsPerSearchResultsPage", "SpatialSearchDefaultUnits", "SpatialSearchDefaultDistance", "SpatialSearchAllProjectsKeywords", "TimeFormat", "DisplayTime", "StatusUpdateActivitySortOrder", "StatusUpdateActivitySortField", "StatusUpdateProjectFilter", "StatusUpdateProjectFilterArray", "StatusUpdateTaskStatusFilter", "StatusUpdateTimeframeFilter", "StatusUpdateWBSFilter", "StatusUpdateFromDateFilter", "StatusUpdateToDateFilter", "ScheduleCheckBeiTarget", "SmLayoutLatestView", "UserAppliedFilterIdList", "ShowMinutes", "ResourceAnalysisDataView", "ResourceAssignmentDataView", "DisplayUnits", "UnitsSubUnits", "UnitsLabel", "UnitsPerTimeFormat", "DisplayDuration", "DurationSubUnits", "DurationLabel", "WhenAssigningResourceToExistingActivity", "UnitsDecimalPlaces", "UnitsNumberDecimalPlaces", "DurationDecimalPlaces", "DurationNumberDecimalPlaces", "ImportClobberOptions", "HomeRecentsVisible", "UserFirstName", "UserLastName", "UserTitle", "UserLocale", "UserAlternateEmail", "UserPhoneNumber", "UserMobileNumber", "UserFaxNumber", "UserTimeZone", "OnboardedForVersion", "CookiesAcknowledged", "PlaAccepted", "LastSearchIndexRequest", "displayScheduleLog", "LastAccessedWorkPackageId", "LastSearchIndexCompleted" ]

Response

Supported Media Types

application/json

200 Response

successful operation

Root Schema : schema

Type: array

Show Source

[0]: object ApiEntityApplicationUserSetting

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntityApplicationUserSetting"
    }
}

Nested Schema : ApiEntityApplicationUserSetting

Type: object

Show Source

applicationUserId(optional): integer(int64)

The unique identifier of a user's settings.
applicationUserSettingId(optional): integer(int64)

The unique identifier of a user's settings.
link(optional): string(url)

Read Only: true
namespace(optional): string

Allowed Values: [ "Length[1-255]" ]

The namespace to which a user is assigned.
settingName(optional): string

Allowed Values: [ "Length[1-255]" ]

The name of a user setting.
settingValue(optional): string

Allowed Values: [ "Length[1-255]" ]

The value of a user setting.
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "namespace":{
            "type":"string",
            "description":"The namespace to which a user is assigned.",
            "enum":[
                "Length[1-255]"
            ]
        },
        "settingValue":{
            "type":"string",
            "description":"The value of a user setting.",
            "enum":[
                "Length[1-255]"
            ]
        },
        "settingName":{
            "type":"string",
            "description":"The name of a user setting.",
            "enum":[
                "Length[1-255]"
            ]
        },
        "applicationUserSettingId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a user's settings."
        },
        "applicationUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a user's settings."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

204 Response

Successful operation with no content.

404 Response

The requested user preferences object does not exist or you do not have access to it.