Step Details

Using the Step Details handler, a user has access to detailed information of an editing step. Requesting the step requires read permission for the current user to the given ticket and editing step id.

GET /api/ticket/<ticket-id>/steps/<step-id>

Returns the JSON representation of the editing step.

REQUEST Parameter	Value Type	Description
fields	string	An optional comma separated list of field and attribute names that are reported back to the client

RESPONSE Fields	Value Type	Description
id	number	The editing step id
actionID	number	The id of the ticket action applied when creating this editing step
actionDisplayName	string	The display name of the applied ticket action
lastModified	number	The timestamp of the last modification of this editing step
userGUID	string	The GUID of the user who applied the ticket action
text	string	The text content of the editing step
htmlContent	boolean	An value of: `true`, if the `text` contains HTML content; `false` otherwise
fields	map<string,string>	A map of editing step fields. The map can be reduced by sending the optional parameter `fields` (see above)
attributes	map<string,string>	A map of editing step attributes. The map can be reduced by sending the optional parameter `fields` (see above)

Note: For security purposes it is possible - and advisable - to reduce the amount of ticket fields and attributes transmitted back to the client.

Example Request

# Request
GET /api/ticket/1/steps/1 HTTP/1.1
Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u
 
# Response
HTTP/1.1 200 OK
Content-Type: application/json
 
{
  "id": 1,
  "actionID": 4,
  "actionDisplayName": "Anfrage erzeugen",
  "userID": "sys02qmoxwlwprnnovhrxtx7n",
  "userDisplayName": "Administrator",
  "text": "...",
  "htmlContent": true,
  "attributes": {
    "reastepuserid": "sys02qmoxwlwprnnovhrxtx7n",
    "bundle_visible": false,
    "reasteporgbunid": 1,
    "reastepactionid": 4,
    "reastephastext": true,
    "reastepbunid": 1,
    "reasteplumpsum": 0.0,
    "reastephourlyrate": 0.0
  },
  "fields": {
    "reastepprocessingtime": {
      "start": 1601011754753,
      "end": 1601011754753
    },
    "reastepdisplayname": "Administrator"
  }
}

Example Request with reduced fields

# Request
GET /api/ticket/1/steps/1?fields=reastepuserid,reastepdisplayname HTTP/1.1
Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u
 
# Response
HTTP/1.1 200 OK
Content-Type: application/json
 
{
  "id": 1,
  "actionID": 4,
  "actionDisplayName": "Anfrage erzeugen",
  "userID": "sys02qmoxwlwprnnovhrxtx7n",
  "userDisplayName": "Administrator",
  "text": "...",
  "htmlContent": true,
  "attributes": {
    "reastepuserid": "sys02qmoxwlwprnnovhrxtx7n",
  },
  "fields": {
    "reastepdisplayname": "Administrator"
  }
}

Application Example

# Browser access
http://127.0.0.1:9000/api/ticket/1/steps/1
 
# Shell access using curl
curl -LsH "Authorization: Bearer <access_token>" "http://127.0.0.1:9000/api/ticket/1/steps/1"
 
# Shell access using curl using username and password
curl -Lsu username:password "http://127.0.0.1:9000/api/ticket/1/steps/1"

Step Details

GET /api/ticket/<ticket-id>/steps/<step-id>

Example Request

Example Request with reduced fields

Application Example

{{welcome.getConfig().welcomeTitle}}

Help - /<step-id>