PATCH List/{id}

Some tooltip text!

• 5 minutes to read

 • 5 minutes to read

PATCH /api/v1/List/{id}

Update a ListEntity with changes, as described in a JSON Patch or a JSON Merge Patch document.

See RFC6902 and RFC 7396. Update the Department field to "foo" can be done either as a JSON PATCH:

[ { "op": "replace", "path": "/Department", "value": "foo" } ]

or as a JSON MERGE PATCH, which describes the change directly:

{ "Department": "foo" }

JSON PATCH supports operations 'add', 'replace', 'remove' and 'test'. The path is case insensitive, and the leading slash is optional, so the paths "/department", "Department" and "department" are all equivalent.

Calls the {SuperOffice.CRM.Services.IListAgent} service SaveListEntity.

Path Part	Type	Description
id	int32	The ListEntity id to update. Required

Query String Parameters

Parameter Name	Type	Description
$select	string	Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category" Default = show all fields.

PATCH /api/v1/List/{id}?$select=name,department,category/id

Request Headers

Parameter Name	Description
Authorization	Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN	If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type	Content-type of the request body:
Accept	Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language	Convert string references and multi-language values into a specified language (iso2) code.
SO-Language	Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture	Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone	Specify the timezone code that you would like date/time responses converted to.
SO-AppToken	The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: changes

JSON-Patch array of operations+path+value, or a MERGE-PATCH object (which will be converted to a list of JSON-PATCH operations).

Property Name	Type	Description
op	String	"add", "replace", "remove", "test" "move" and "copy" not supported
path	String	The property names to modify. "/users/0/email", "/users/-",
value	Object	New/Replaced value - string or object.

Response:

ListEntity updated.

Response	Description
200	ListEntity updated.
404	ListEntity with given id does not exist in the db.
409	Update blocked because a 'test' operation has detected a conflict with the entity value.
412	Update aborted because ListEntity has changed since the requested If-Unmodified-Since timestamp.

Response body: ListEntityWithLinks

Property Name	Type	Description
Id	int32	The identity of the list
Name	string	The name of the list
Tooltip	string	The tooltip of the list
Deleted	bool	True if the list item is marked as deleted
Rank	int32	The rank of the list
IsCustomList	bool	Indicates if this is a custom list or a standard list
IsMDOList	bool	Indicates if this is a MDO list
UseGroupsAndHeadings	bool	Indicates if this list should use groups and headings
ListType	string	The type of this list, often indicated by the database name, but not necessarily
InUseByUserDefinedFields	bool	True if this in use by one or more udfields
TableRight	TableRight	The carrier's table right
FieldProperties	object	Field property dictionary mapping field names to field access rights.
_Links	object

Sample request

PATCH /api/v1/List/{id}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

[
  {
    "op": "add",
    "path": "eos",
    "value": {}
  },
  {
    "op": "add",
    "path": "eos",
    "value": {}
  }
]

Sample response

HTTP/1.1 200 ListEntity  updated.
Content-Type: application/json; charset=utf-8

{
  "Id": 305,
  "Name": "Beer, Hudson and Bashirian",
  "Tooltip": "itaque",
  "Deleted": false,
  "Rank": 508,
  "IsCustomList": false,
  "IsMDOList": true,
  "UseGroupsAndHeadings": false,
  "ListType": "error",
  "InUseByUserDefinedFields": false,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 847
    }
  },
  "_Links": {
    "Self": "https://www.example.com/api/v1/project/321",
    "Archive": "https://www.example.com/api/v1/project"
  }
}