PATCH PreferenceDescriptionLine/{id}

Some tooltip text!

• 4 minutes to read

 • 4 minutes to read

PATCH /api/v1/PreferenceDescriptionLine/{id}

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

See RFC6902 and RFC 7396. NsApiSlow threshold: 1000 ms. 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.IPreferenceAgent} service SavePreferenceDescriptionLine.

Path Part	Type	Description
id	int32	The PreferenceDescriptionLine 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/PreferenceDescriptionLine/{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:

PreferenceDescriptionLine updated.

Response	Description
200	PreferenceDescriptionLine updated.
404	PreferenceDescriptionLine 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 PreferenceDescriptionLine has changed since the requested If-Unmodified-Since timestamp.

Response body: PreferenceDescriptionLineWithLinks

Property Name	Type	Description
PrefDescLineId	int32	Primary key
PrefDescId	int32	Preference description (parent)
PrefValue	string	Possible value
PrefShowValue	string	Descriptive value, multilang-parsed, to put in list
Description	string	Description of preference value, multi-language parsed
IsBuiltin	bool	1 = This row populated and maintained by SuperOffice
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/PreferenceDescriptionLine/{id}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: *
Content-Type: application/json; charset=utf-8

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

Sample response

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

{
  "PrefDescLineId": 160,
  "PrefDescId": 810,
  "PrefValue": "dolorem",
  "PrefShowValue": "adipisci",
  "Description": "Ergonomic local open system",
  "IsBuiltin": true,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 611
    }
  },
  "_Links": {
    "Self": "https://www.example.com/api/v1/project/321",
    "Archive": "https://www.example.com/api/v1/project"
  }
}