Page tree


In This Document 



Have a suggestion for the Armor Knowledge Base? Send a message to kb@armor.com.




Overview

This API call applies to both Armor Complete and Armor Anywhere users.

The Add a Tag to a Ticket API adds a tag to a ticket. 

You can use the Get Ticket Meta-Data API to find the ticket number.

Sample request

POST https://api.armor.com/tickets/271/tag

{
  tag: "Web"
}

Input

The following table describes the different parts of this API call: 

API Call / URLMethod / Type
tickets/{ticketNumber}/tickets POST

The following table describes the parameter (or parameters) for this API call:

ParameterDescriptionFormatRequired or optionalExample
ticketNumber (route)The number of the ticketIntegerRequired271
Tag (body)The tag to addStringRequiredWeb

Sample return

StatusResponse
200
{
   "tags": [
       "Web"
   ],
   "comments": [
       {
           "id": "fc229de0-7ecc-48f2-a626-361152aa61d8",
           "text": "Check VM",
           "commentorId": "e4009140-a3c2-459d-b6ff-fcbbfc9b75f7",
           "commentorName": "Robert Smith",
           "commentorEmail": "robert.smith@armor.com",
           "date": "2015-01-07T03:23:32.09",
           "isPublic": true,
           "attachments": [],
           "feedback": 0,
           "reason": 0,
           "read": false
       }
   ],
   "recipients": [
       {
           "id": 2152,
           "firstName": "Addison",
           "lastName": "Smith",
           "emailAddress": "addison.smith@armor.com",
           "account": false,
           "billing": false,
           "technical": false,
           "partner": false
       },
       {
           "id": 1100,
           "firstName": "Robert",
           "lastName": "Smith",
           "emailAddress": "robert.smith@armor.com",
           "account": false,
           "billing": false,
           "technical": false,
           "partner": false
       }
   ],
   "relatedServers": [],
   "relatedTickets": [
       {
           "ticketNumber": 1478,
           "title": "Check VM"
       }
   ],
   "ticketNumber": 1486,
   "title": "VM Check",
   "type": "ticket",
   "status":"Open",
   "isClosed": false,
   "priority": 0,
   "sensitivity": null,
   "dateCreated": "2015-01-07T03:23:31.763",
   "dateModified": "2015-01-07T03:23:31.763",
   "createdByUserId":1100,
   "lastResponderName":"Robert Smith",
   "lastResponderExcerpt": "Check VM",
   "lastResponseDate": "2015-01-07T03:23:32.09",
   "starred": false,
   "read": false,
   "userRating": 0
}
400
Bad Request