PUT {bucket}/listitem/remove

Removes the entity (doesn't really remove but hides by adding an archive keyword in the "type" property).

Request Information

URI Parameters

NameDescriptionTypeAdditional information
bucket

The couchbase bucket, givent via the url (v2/v3...)

string

Required

Body Parameters

The entity model, given via the body and containing the last entity state + the mandatory ArchivedBy user

ListItemModel
NameDescriptionTypeAdditional information
Family

string

None.

Code

string

None.

Label

string

None.

Value

string

None.

SortOrder

integer

None.

ParentId

unsigned integer

None.

Level

integer

None.

Enabled

boolean

None.

EventInfoList

Collection of EventInfoModel

None.

Uid

unsigned integer

None.

Type

string

None.

Created

date

None.

Updated

date

None.

Archived

date

None.

CreatedBy

string

None.

UpdatedBy

string

None.

ArchivedBy

string

None.

Version

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Family": "sample string 1",
  "Code": "sample string 2",
  "Label": "sample string 3",
  "Value": "sample string 4",
  "SortOrder": 1,
  "ParentId": 1,
  "Level": 1,
  "Enabled": true,
  "EventInfoList": [
    {
      "ListEventActionId": 1,
      "ChuckNorrisId": 1,
      "Response": {
        "EventId": 1,
        "ErrorMessage": "sample string 1"
      }
    },
    {
      "ListEventActionId": 1,
      "ChuckNorrisId": 1,
      "Response": {
        "EventId": 1,
        "ErrorMessage": "sample string 1"
      }
    }
  ],
  "Uid": 1,
  "Type": "sample string 5",
  "Created": "2025-01-11T00:02:41.998479+01:00",
  "Updated": "2025-01-11T00:02:41.998479+01:00",
  "Archived": "2025-01-11T00:02:41.998479+01:00",
  "CreatedBy": "sample string 6",
  "UpdatedBy": "sample string 7",
  "ArchivedBy": "sample string 8",
  "Version": 1
}

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.