delete

Purpose

Moves the specified data record to the Recycle Bin. The output parameter is optional.

For objects in dedicated tables, you must specify the objName parameter.

HTTP Method

DELETE or GET

URL

https://app.infiniteblue.com/rest/api/delete

URL Parameters

sessionId

The session ID obtained from the body of the response when calling login.

objName

The object integration name.

id

Record's ID.

output

Optional parameter specifying the output format, one of: xml (default) or json.

Permissions Required

Delete permission for the requested object type.

Response

Standard success or failure output

Example

Output example:

<resp status="ok">
<Msg>Record has been deleted</Msg>
</resp>