DELETE api/matrix/{id}/row?sheet={sheet}&version={version}&useIdentifier={useIdentifier}

Deletes a specific row from a metadata matrix.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The matrix ID.

integer

Required

sheet

Optional sheet name. Defaults to the matrix default sheet.

string

None.

version

Optional version identifier. Defaults to the active version.

string

None.

useIdentifier

Unused — delete mode is determined automatically from the values supplied.

boolean

Default value is False

Body Parameters

Row values used to locate the row for deletion. Supply only identifier column values to delete by identifier, or the full set of column values to delete by exact row match.

Collection of string

Request Formats

application/json, text/json, application/scim+json

Sample:
[
  "sample string 1",
  "sample string 2"
]

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

On success: HTTP 200 OK indicating the row was deleted successfully. On failure: HTTP 400 Bad Request with a message indicating the error.

IHttpActionResult

None.

Response Formats

application/json, text/json, application/scim+json

Sample:

Sample not available.