v1

latestOpenAPI 3.0.0MITraw.githubusercontent.com2019-08-017572.7 KB
items

Patch a single data item, by ID

Request an update to the definition of an existing data item (as a partial update).

A request can only be raised for one field of the item at a time.

In a future version of the API, the response will include a link to the resulting request resource (but this isn't implemented yet).

patch/v1/entities/{name}/items/{id}

Path parameters

namestring required

The name of the entity.

idstring required

The id of the data item to be updated.

Query parameters

fieldstring required
Example:name

The field that the change is being requested for.

newValuestring required
Example:Belize

The new value being requested.

Response

Accepted

statusstring
codeinteger
typestring
detailstring

Example response

{
  "status": "success",
  "code": 202,
  "type": "accepted",
  "detail": "The request has been accepted for processing, but the processing has not been completed. The request might or might not eventually be acted upon, as it might be disallowed when processing actually takes place."
}