PATCH TicketType/{id}

• 5 minutes to read
 • 5 minutes to read 
PATCH /api/v1/TicketType/{id}

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

See RFC6902 and RFC 7396. NsApiSlow threshold: 5000 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.IListAgent} service SaveTicketTypeEntity.

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

TicketTypeEntity updated.

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

Response body: TicketTypeEntityWithLinks

Property Name Type Description
TicketTypeId int32 Primary key
Name string The list item
Rank int32 Rank order
Tooltip string Tooltip or other description
Icon string Name of the icon
DefaultTicketStatus int32 Default ticket status for new tickets
TicketStatuses array Relevant/available ticket statuses for this Request type. Empty field means all statuses are available.
DefaultTicketPriority int32 Default ticket priority for new tickets
TicketPriorities array Relevant/available ticket priorities for this Request type. Empty field means all priorities are available.
ReplyTemplate int32 Reply template to use when replying to a ticket of this type
IsExternalVisible bool Is this request type visible to external people and they can submit requests of this type
IsDefault bool Is this Ticket Type marked as default
ShowInNew bool Enables this request type to be accessible in +New in top bar
ExcludeSignature bool Do not insert user signature automatically
ExcludeEmailRecipients bool Create request without initially having to send outbound e-mail
ExternalAsDefault bool Ability to set external access level for this request type
VisibleForGroups array Array of references to the visible for groups
ReplyForwardNoSignature bool Do not insert user signature when replying or forwarding the message
ReplyExternalAsDefault bool Set external access level when replying the message
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/TicketType/{id}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

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

Sample response

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

{
  "TicketTypeId": 744,
  "Name": "Greenholt, Brekke and Mills",
  "Rank": 422,
  "Tooltip": "quia",
  "Icon": "eos",
  "DefaultTicketStatus": 962,
  "TicketStatuses": [
    678,
    210
  ],
  "DefaultTicketPriority": 387,
  "TicketPriorities": [
    155,
    341
  ],
  "ReplyTemplate": 553,
  "IsExternalVisible": false,
  "IsDefault": false,
  "ShowInNew": false,
  "ExcludeSignature": false,
  "ExcludeEmailRecipients": false,
  "ExternalAsDefault": false,
  "VisibleForGroups": [
    105,
    975
  ],
  "ReplyForwardNoSignature": true,
  "ReplyExternalAsDefault": false,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 460
    }
  },
  "_Links": {
    "Self": "https://www.example.com/api/v1/contact/321",
    "Archive": "https://www.example.com/api/v1/contact"
  }
}