Jump to

• Request
• Response
• Examples

Grant or Revoke Preferences for Users

put

/ic/api/process/v1/preferences/bulk

Grant or revoke preferences for one or more users. You must be an administrator to use this API.

Request

Supported Media Types

• application/json

Query Parameters

• operation(optional): string
  Operation - grant OR revoke. Default operation is grant

  Default Value: grant

Body ()

PreferenceBulkRequest Object

Root Schema : preferencesResponse

Type: object

Show Source

• deleteAllUserPreferences(optional): boolean
• userPrefKeys(optional): array userPrefKeys
• userPrefReq(optional): object userPrefReq
  Additional Properties Allowed: additionalProperties
• users(optional): array users

{
    "type":"object",
    "properties":{
        "users":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "userPrefReq":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "userPrefKeys":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "deleteAllUserPreferences":{
            "type":"boolean"
        }
    },
    "xml":{
        "name":"preferencesResponse",
        "namespace":"http://xmlns.oracle.com/bpm/rest/preference"
    }
}

Nested Schema : userPrefKeys

Type: array

Show Source

• Array of: string

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

Nested Schema : userPrefReq

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

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

Nested Schema : users

Type: array

Show Source

• Array of: string

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

Nested Schema : additionalProperties

Type: object

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : preferencesResponse

Type: object

Show Source

• appPrefResponse(optional): object appPrefResponse
  Additional Properties Allowed: additionalProperties
• invalidUsers(optional): array invalidUsers
• levels(optional): integer(int32)
• links(optional): array links
• message(optional): string
• title(optional): string
• userPrefResponse(optional): 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(optional): string
• mediaType(optional): string
• rel(optional): 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 set or update user preferences for multiple users by submitting a PUT request on the REST resource.

Example: Set the notification time zone and task list size for users dsmith, jlondon, jcooper

Send Request:

PUT https://example.com/ic/api/process/v1/preferences/bulk

Request Body:

Start and end date must be in ISO-8601 format.

{
   "users" : ["dsmith","jlondon", "jcooper"],
   "userPrefReq" : { "NOTIFICATION_TZ": "Hongkong" , "TASKLIST_FETCH_SIZE" : "50"}
}

Example: Delegate tasks to user jcooper when users htwain, jlondon, dsmith are on vacation

Send Request:

PUT https://example.com/ic/api/process/v1/preferences/bulk

Request Body:

Start and end date must be in ISO-8601 format.

{
   "users" : ["htwain","jlondon", "dsmith"],
   "userPrefReq" : { "VACATION_RULE": {
                            "targetUser" : "jcooper",
                            "detail" : { "action":"DELEGATE", "startDate" : "2019-10-07", "endDate" : "2019-12-09"}
                                      }
                    }
}

Back to Top