Jump to

• Request
• Response

View the applicable values for user preferences

get

/api/restapi/userPreferences/applicablePreferenceValues

Send a request to this endpoint to return the applicable values for the fields in user preferences.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityApplicablePreferenceValues>

Type: array

Title: List<ApiEntityApplicablePreferenceValues>

Show Source

• Array of: object ApiEntityApplicablePreferenceValues
  Title: ApiEntityApplicablePreferenceValues

{
    "title":"List<ApiEntityApplicablePreferenceValues>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityApplicablePreferenceValues",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityApplicablePreferenceValues

Type: object

Title: ApiEntityApplicablePreferenceValues

Show Source

• applicableType: string
  The type of user preference value.
• applicableValues: array applicableValues
  The list of applicable values for the user preference.
  Note: For userPreferenceType = DateFormat, applicableValues
  0 denotes Month, Day, Year
  1 denotes Day, Month, Year
  2 denotes Year, Month, Day
• dependentPreference: string
  The user preference on which this preference is dependent.
• isDependentType: boolean
  Indicates whether the user preference is dependent on another user preference.
• maximumRange: string
  The maximum allowed value for the given user preference.
• minimumRange: string
  The minimum allowed value for the given user preference.
• userPreferenceType: string
  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", "SearchProjectCodes", "SearchGenericPortfolios", "SearchActivities", "SearchDocuments", "SearchUsers", "SearchRisks", "SearchIdeas", "SearchPrograms", "NumberResultsPerSearchResultsPage", "SpatialSearchDefaultUnits", "SpatialSearchDefaultDistance", "SpatialSearchAllProjectsKeywords", "TimeFormat", "DisplayTime", "StatusUpdateActivitySortOrder", "StatusUpdateActivitySortField", "StatusUpdateProjectFilter", "StatusUpdateProjectFilterArray", "StatusUpdateTaskStatusFilter", "StatusUpdateTimeframeFilter", "StatusUpdateWBSFilter", "StatusUpdateFromDateFilter", "StatusUpdateToDateFilter", "ScheduleCheckBeiTarget", "SmLayoutLatestView", "UserAppliedFilterIdList", "ShowMinutes", "DataDateInPageBanners", "ActualDateIndicator", "ConstraintDateIndicator", "ResourceAnalysisDataView", "ResourceAssignmentDataView", "DisplayUnits", "UnitsSubUnits", "UnitsLabel", "UnitsPerTimeFormat", "DisplayDuration", "DurationSubUnits", "DurationLabel", "WhenAssigningResourceToExistingActivity", "WhenResourceAndRoleShareActivityAssignment", "UnitsDecimalPlaces", "UnitsNumberDecimalPlaces", "DurationDecimalPlaces", "DurationNumberDecimalPlaces", "ImportClobberOptions", "HomeRecentsVisible", "UserFirstName", "UserLastName", "UserTitle", "UserLocale", "UserAlternateEmail", "UserPhoneNumber", "UserMobileNumber", "UserFaxNumber", "UserDisplayDensity", "UserTimeZone", "OnboardedForVersion", "WorkPlanGettingStartedShown", "CookiesAcknowledged", "PlaAccepted", "LastSearchIndexRequest", "displayScheduleLog", "LastAccessedWorkPackageId", "LastSearchIndexCompleted", "ExperimentalEnhancedPrint", "ExperimentalColumnMenu", "AutoSaveNamedViews" ]

  The name of a user setting.

{
    "title":"ApiEntityApplicablePreferenceValues",
    "type":"object",
    "properties":{
        "applicableValues":{
            "type":"array",
            "description":"The list of applicable values for the user preference.<br>Note: For userPreferenceType = DateFormat, applicableValues<br>0 denotes Month, Day, Year<br>1 denotes Day, Month, Year<br>2 denotes Year, Month, Day",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "dependentPreference":{
            "type":"string",
            "description":"The user preference on which this preference is dependent.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "userPreferenceType":{
            "type":"string",
            "description":"The name of a user setting.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "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",
                "SearchProjectCodes",
                "SearchGenericPortfolios",
                "SearchActivities",
                "SearchDocuments",
                "SearchUsers",
                "SearchRisks",
                "SearchIdeas",
                "SearchPrograms",
                "NumberResultsPerSearchResultsPage",
                "SpatialSearchDefaultUnits",
                "SpatialSearchDefaultDistance",
                "SpatialSearchAllProjectsKeywords",
                "TimeFormat",
                "DisplayTime",
                "StatusUpdateActivitySortOrder",
                "StatusUpdateActivitySortField",
                "StatusUpdateProjectFilter",
                "StatusUpdateProjectFilterArray",
                "StatusUpdateTaskStatusFilter",
                "StatusUpdateTimeframeFilter",
                "StatusUpdateWBSFilter",
                "StatusUpdateFromDateFilter",
                "StatusUpdateToDateFilter",
                "ScheduleCheckBeiTarget",
                "SmLayoutLatestView",
                "UserAppliedFilterIdList",
                "ShowMinutes",
                "DataDateInPageBanners",
                "ActualDateIndicator",
                "ConstraintDateIndicator",
                "ResourceAnalysisDataView",
                "ResourceAssignmentDataView",
                "DisplayUnits",
                "UnitsSubUnits",
                "UnitsLabel",
                "UnitsPerTimeFormat",
                "DisplayDuration",
                "DurationSubUnits",
                "DurationLabel",
                "WhenAssigningResourceToExistingActivity",
                "WhenResourceAndRoleShareActivityAssignment",
                "UnitsDecimalPlaces",
                "UnitsNumberDecimalPlaces",
                "DurationDecimalPlaces",
                "DurationNumberDecimalPlaces",
                "ImportClobberOptions",
                "HomeRecentsVisible",
                "UserFirstName",
                "UserLastName",
                "UserTitle",
                "UserLocale",
                "UserAlternateEmail",
                "UserPhoneNumber",
                "UserMobileNumber",
                "UserFaxNumber",
                "UserDisplayDensity",
                "UserTimeZone",
                "OnboardedForVersion",
                "WorkPlanGettingStartedShown",
                "CookiesAcknowledged",
                "PlaAccepted",
                "LastSearchIndexRequest",
                "displayScheduleLog",
                "LastAccessedWorkPackageId",
                "LastSearchIndexCompleted",
                "ExperimentalEnhancedPrint",
                "ExperimentalColumnMenu",
                "AutoSaveNamedViews"
            ]
        },
        "isDependentType":{
            "type":"boolean",
            "description":"Indicates whether the user preference is dependent on another user preference.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "applicableType":{
            "type":"string",
            "description":"The type of user preference value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "maximumRange":{
            "type":"string",
            "description":"The maximum allowed value for the given user preference.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "minimumRange":{
            "type":"string",
            "description":"The minimum allowed value for the given user preference.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : applicableValues

Type: array

The list of applicable values for the user preference.
Note: For userPreferenceType = DateFormat, applicableValues
0 denotes Month, Day, Year
1 denotes Day, Month, Year
2 denotes Year, Month, Day

Show Source

• Array of: string

{
    "type":"array",
    "description":"The list of applicable values for the user preference.<br>Note: For userPreferenceType = DateFormat, applicableValues<br>0 denotes Month, Day, Year<br>1 denotes Day, Month, Year<br>2 denotes Year, Month, Day",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

Back to Top