Jump to

• Request
• Response
• Examples

Get User and Application Preferences for the Logged in User

get

/ic/api/process/v1/preferences

Get user and application preferences for the logged in user. Also allows admin to list preferences of other users

Request

Query Parameters

• key: string
  Preference key.

  Valid values for keys with preference type USER:

  • NOTIFICATION_TZ
  • TASKLIST_FETCH_SIZE
  • TASKLIST_DEFAULT_GROUPING
  • VACATION_RULE

  Valid values for keys with preference type APPLICATION:

  • TASKLIST_FETCH_SIZE
  • TASKLIST_DEFAULT_GROUPING
• type: string
  Preference type. Valid values: USER, APPLICATION, ALL.

  Default Value: ALL

  Allowed Values: [ "USER", "APPLICATION", "ALL" ]
• user: string
  User Id

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : preferencesResponse

Type: object

Show Source

• appPrefResponse: object appPrefResponse
  Additional Properties Allowed: additionalProperties
• invalidUsers: array invalidUsers
• levels: integer(int32)
• links: array links
• message: string
• title: string
• userPrefResponse: object userPrefResponse
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "userPrefResponse":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "appPrefResponse":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "levels":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        },
        "links":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"links"
                },
                "$ref":"#/definitions/Link"
            }
        },
        "title":{
            "type":"string"
        },
        "invalidUsers":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "message":{
            "type":"string"
        }
    },
    "xml":{
        "name":"preferencesResponse",
        "namespace":"http://xmlns.oracle.com/bpm/rest/preference"
    }
}

Nested Schema : appPrefResponse

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : invalidUsers

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "xml":{
            "name":"links"
        },
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : userPrefResponse

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

400 Response

Bad request

401 Response

Unauthorized

500 Response

Internal Server Error

Back to Top

Examples

The following examples show how to retrieve user and application preferences for the logged in user by submitting a GET request on the REST resource.

Example: Get all user and application preferences for the logged in user

Send Request:

GET https://example.com/ic/api/process/v1/preferences

Example: Get only vacation preferences for the logged in user

Send Request:

GET https://example.com/ic/api/process/v1/preferences?key=VACATION_RULE&type=USER

Example: Get only user preferences for the logged in user

Send Request:

GET https://example.com/ic/api/process/v1/preferences?type=USER

Example: Get only application preferences for the logged in user

Send Request:

GET https://example.com/ic/api/process/v1/preferences?type=APPLICATION

Back to Top