Jump to

• Request
• Response
• Examples

Delete User and Application Preferences for the Logged in User

delete

/ic/api/process/v1/preferences

Delete user and application preferences for the logged in user. You must be an administrator to delete application preferences.

Request

Supported Media Types

• application/json

Body ()

PreferenceDeleteRequest Object

Root Schema : preferencesResponse

Type: object

Show Source

• appPrefKeys(optional): array appPrefKeys
• deleteAllAppPreferences(optional): boolean
• deleteAllUserPreferences(optional): boolean
• userPrefKeys(optional): array userPrefKeys

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

Nested Schema : appPrefKeys

Type: array

Show Source

• Array of: string

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

Nested Schema : userPrefKeys

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

Example: Delete vacation rules, notification time zone, and all application preferences

Users can delete their own user preferences but only administrators can delete application preferences.

Send Request:

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

Request Body:

{
    "userPrefKeys" : ["VACATION_RULE","NOTIFICATION_TZ"],
    "deleteAllAppPreferences" : true
} 

Example: Delete all user and application preferences

Users can delete their own user preferences but only administrators can delete application preferences.

Send Request:

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

Request Body:

{
    "deleteAllUserPreferences" : true,
    "deleteAllAppPreferences" : true
} 

Back to Top