Jump to

• Request
• Response
• Examples

Delete User Preferences for Users

delete

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

Delete user preferences for mulitple users. You must be an administrator to use this API.

Request

Supported Media Types

• application/json

Body ()

PreferenceBulkDeleteRequest Object

Root Schema : preferencesResponse

Type: object

Show Source

• deleteAllUserPreferences: boolean
• userPrefKeys: array userPrefKeys
• users: array users

{
    "type":"object",
    "properties":{
        "users":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "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 : users

Type: array

Show Source

• Array of: string

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

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 example shows how to delete user preferences for multiple users by submitting a DELETE request on the REST resource.

Example: Delete all user preferences for users htwain, jlondon

Send Request:

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

Request Body:

{
    "users" : ["htwain","jlondon"],
    "deleteAllUserPreferences" : true
}

Example: Delete specific user preferences for users htwain, hlondon

Send Request:

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

Request Body:

{
    "users" : ["htwain","jlondon"],
    "userPrefKeys" : ["VACATION_RULE","NOTIFICATION_TZ"]
}

Back to Top