From 3cca2e0b087a6c9446c1cb4ff2d81138dd55dabd Mon Sep 17 00:00:00 2001 From: Christopher Gallo Date: Thu, 12 Apr 2018 18:02:16 -0500 Subject: [PATCH] ticket examples --- classes/index.xml | 4 +- classes/softlayer_ticket/index.html | 10 + classes/softlayer_ticket/index.xml | 12 +- .../index.html | 10 + .../index.xml | 12 +- index.xml | 126 +++++++- rest/index.html | 10 + rest/index.xml | 12 +- rest/tickets/index.html | 306 ++++++++++++++++++ sitemap.xml | 33 +- tags/index.xml | 8 +- tags/objectfilter/index.html | 5 + tags/objectfilter/index.xml | 12 +- tags/objectmask/index.html | 5 + tags/objectmask/index.xml | 12 +- tags/resultlimit/index.html | 5 + tags/resultlimit/index.xml | 12 +- tags/ticket/index.html | 10 + tags/ticket/index.xml | 12 +- 19 files changed, 578 insertions(+), 38 deletions(-) create mode 100644 rest/tickets/index.html diff --git a/classes/index.xml b/classes/index.xml index e2602e2a9d6..d7c5a149d1c 100644 --- a/classes/index.xml +++ b/classes/index.xml @@ -9617,7 +9617,7 @@ Softlayer_ticket https://softlayer.github.io/classes/softlayer_ticket/ - Mon, 12 Feb 2018 00:00:00 +0000 + Tue, 10 Apr 2018 00:00:00 +0000 https://softlayer.github.io/classes/softlayer_ticket/ @@ -9671,7 +9671,7 @@ Softlayer_ticket_attachment_file https://softlayer.github.io/classes/softlayer_ticket_attachment_file/ - Mon, 12 Feb 2018 00:00:00 +0000 + Tue, 10 Apr 2018 00:00:00 +0000 https://softlayer.github.io/classes/softlayer_ticket_attachment_file/ diff --git a/classes/softlayer_ticket/index.html b/classes/softlayer_ticket/index.html index 2aab5f98057..29f61ac49ef 100644 --- a/classes/softlayer_ticket/index.html +++ b/classes/softlayer_ticket/index.html @@ -461,6 +461,16 @@

reference

+

rest

+
    + +
  • + Tickets +
    Examples of how to use and interact with tickets
    +
    • + +
+

ruby

    diff --git a/classes/softlayer_ticket/index.xml b/classes/softlayer_ticket/index.xml index 54116f554ac..0459da41d75 100644 --- a/classes/softlayer_ticket/index.xml +++ b/classes/softlayer_ticket/index.xml @@ -6,11 +6,21 @@ Recent content in Softlayer_ticket on SoftLayer API Hugo -- gohugo.io en-us - Mon, 12 Feb 2018 00:00:00 +0000 + Tue, 10 Apr 2018 00:00:00 +0000 + + Tickets + https://softlayer.github.io/rest/tickets/ + Tue, 10 Apr 2018 00:00:00 +0000 + + https://softlayer.github.io/rest/tickets/ + Tickets Tickets are how SoftLayer and you communicate and resolve problems. They can be about anything from general questions, requests for upgrades, monitoring alerts, or anything else that might come up. +Viewing Tickets To start off, lets see how to go about getting tickets that already exist on our account. There are a variety of helper functions on the SoftLayer_Account service that deal with tickets, and they all work basically the same way. + + SoftLayer_Ticket https://softlayer.github.io/reference/services/SoftLayer_Ticket/ diff --git a/classes/softlayer_ticket_attachment_file/index.html b/classes/softlayer_ticket_attachment_file/index.html index 9a2df91ef60..a44ec25c51d 100644 --- a/classes/softlayer_ticket_attachment_file/index.html +++ b/classes/softlayer_ticket_attachment_file/index.html @@ -141,6 +141,16 @@

    reference

+

rest

+
    + +
  • + Tickets +
    Examples of how to use and interact with tickets
    +
    • + +
+ diff --git a/classes/softlayer_ticket_attachment_file/index.xml b/classes/softlayer_ticket_attachment_file/index.xml index fc37aaf6229..d2bb2ce5c1e 100644 --- a/classes/softlayer_ticket_attachment_file/index.xml +++ b/classes/softlayer_ticket_attachment_file/index.xml @@ -6,11 +6,21 @@ Recent content in Softlayer_ticket_attachment_file on SoftLayer API Hugo -- gohugo.io en-us - Mon, 12 Feb 2018 00:00:00 +0000 + Tue, 10 Apr 2018 00:00:00 +0000 + + Tickets + https://softlayer.github.io/rest/tickets/ + Tue, 10 Apr 2018 00:00:00 +0000 + + https://softlayer.github.io/rest/tickets/ + Tickets Tickets are how SoftLayer and you communicate and resolve problems. They can be about anything from general questions, requests for upgrades, monitoring alerts, or anything else that might come up. +Viewing Tickets To start off, lets see how to go about getting tickets that already exist on our account. There are a variety of helper functions on the SoftLayer_Account service that deal with tickets, and they all work basically the same way. + + SoftLayer_Ticket_Attachment_File https://softlayer.github.io/reference/services/SoftLayer_Ticket_Attachment_File/ diff --git a/index.xml b/index.xml index 64043c5fe2f..54eacb68d4a 100644 --- a/index.xml +++ b/index.xml @@ -6,7 +6,121 @@ en-US Enthusiastic Hugo User Copyright (c) 2014, Enthusiastic Hugo User; all rights reserved. - Fri, 06 Apr 2018 00:00:00 UTC + Tue, 10 Apr 2018 00:00:00 UTC + + + Tickets + https://softlayer.github.io/rest/tickets/ + Tue, 10 Apr 2018 00:00:00 UTC + Enthusiastic Hugo User + https://softlayer.github.io/rest/tickets/ + + +<h1 id="tickets">Tickets</h1> + +<p>Tickets are how SoftLayer and you communicate and resolve problems. They can be about anything from general questions, requests for upgrades, monitoring alerts, or anything else that might come up.</p> + +<h2 id="viewing-tickets">Viewing Tickets</h2> + +<p>To start off, lets see how to go about getting tickets that already exist on our account. There are a variety of helper functions on the <a href="https://softlayer.github.io/reference/services/SoftLayer_Account/">SoftLayer_Account</a> service that deal with tickets, and they all work basically the same way. <a href="reference/services/SoftLayer_Account/getTickets/">SoftLayer_Account::getTickets</a> and <a href="reference/services/SoftLayer_Account/getOpenTickets/">SoftLayer_Account::getOpenTickets</a> are the most basic of these.</p> +<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4">curl -u $SL_USER:$SL_APIKEY -X GET -H &#34;Accept: */*&#34; -H &#34;Accept-Encoding: gzip, deflate, compress&#34; &#39;https://api.softlayer.com/rest/v3.1/SoftLayer_Account/getOpenTickets.json&#39;</pre></div> +<p>Output:</p> +<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4">[ + { + &#34;accountId&#34;: 307608, + &#34;assignedUserId&#34;: 244956, + &#34;createDate&#34;: &#34;2018-03-30T14:41:47-06:00&#34;, + &#34;groupId&#34;: 1004, + &#34;id&#34;: 57894695, + &#34;lastEditDate&#34;: null, + &#34;lastEditType&#34;: &#34;USER&#34;, + &#34;lastResponseDate&#34;: &#34;2018-03-30T14:41:48-06:00&#34;, + &#34;modifyDate&#34;: &#34;2018-03-30T14:41:48-06:00&#34;, + &#34;notifyUserOnUpdateFlag&#34;: false, + &#34;priority&#34;: 0, + &#34;status&#34;: { + &#34;id&#34;: 1001, + &#34;name&#34;: &#34;Open&#34; + }, + &#34;statusId&#34;: 1001, + &#34;subjectId&#34;: null, + &#34;title&#34;: &#34;Virtual Server Cancellation - 03/30/18&#34;, + &#34;totalUpdateCount&#34;: 1, + &#34;userEditableFlag&#34;: true + },</pre></div> +<p>From there, the <a href="https://softlayer.github.io/reference/datatypes/SoftLayer_Ticket/">SoftLayer_Ticket</a> datatype has quite a few fields we might be interested in. Here is how you would get the updates for the ticket, along with whatever hardware was attached.</p> + +<p><a href="https://api.softlayer.com/rest/v3.1/SoftLayer_Account/getOpenTickets.json?">https://api.softlayer.com/rest/v3.1/SoftLayer_Account/getOpenTickets.json?</a> +objectMask=mask[id, title, updates, attachedHardware[hostname, id]]</p> + +<blockquote> +<p>Reminder: When requesting a LOCAL property, the result will remove all local properties not specified. When requesting a RELATIONAL property, that property, along with any of its default properties, will be added</p> +</blockquote> +<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4">curl -u $SL_USER:$SL_APIKEY -X GET -H &#34;Accept: */*&#34; -H &#34;Accept-Encoding: gzip, deflate, compress&#34; &#39;https://api.softlayer.com/rest/v3.1/SoftLayer_Account/getOpenTickets.json?objectMask=mask%5Bid%2Ctitle%2Cupdates%2CattachedHardware%5Bhostname%2Cid%5D%5D&#39;</pre></div> +<p>Output:</p> +<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"> { + &#34;attachedHardware&#34;: [ + { + &#34;hostname&#34;: &#34;fmirdal13&#34;, + &#34;id&#34;: 1477781 + } + ], + &#34;id&#34;: 58043007, + &#34;title&#34;: &#34;Server Cancellation - 04/04/2018&#34;, + &#34;updates&#34;: [ + { + &#34;createDate&#34;: &#34;2018-04-03T09:38:36-06:00&#34;, + &#34;editorId&#34;: 205, + &#34;editorType&#34;: &#34;AUTO&#34;, + &#34;entry&#34;: &#34;A cancellation request has been submitted for the following:\nServer: fmirdal13.insomnia.com\nPublic IP: 169.60.129.46\nPrivate IP: 10.186.96.230\nServers and services must be cancelled prior to Apr 03, 2018 23:59:59 CDT.\n=================\nCustomer Note:\n&#34;, + &#34;id&#34;: 358332963, + &#34;ticketId&#34;: 58043007 + } + ] + },</pre></div> +<p>To get information about just one ticket, the <a href="https://softlayer.github.io/reference/services/SoftLayer_Ticket/getObject">SoftLayer_Ticket::getObject</a> method would be used.</p> +<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4">curl -u $SL_USER:$SL_APIKEY -X GET -H &#34;Accept: */*&#34; -H &#34;Accept-Encoding: gzip, deflate, compress&#34; &#39;https://api.softlayer.com/rest/v3.1/SoftLayer_Ticket/58043007/getObject.json?objectMask=mask%5Bid%2Ctitle%2Cupdates%2CattachedHardware%5Bhostname%2Cid%5D%5D&#39;</pre></div> +<h2 id="creating-tickets">Creating Tickets</h2> + +<p>There are a few create options in the SoftLayer_Ticket service, the only difference being which internal group they get routed to, and should be obvious based on the method name which one you need. If in doubt, use the standard ticket, <a href="reference/services/SoftLayer_Ticket/createStandardTicket/">SoftLayer_Ticket::createStandardTicket</a></p> + +<p>The bare minimum to create a ticket is the following command:</p> +<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4">curl -u $SL_USER:$SL_APIKEY -X POST -H &#34;Accept: */*&#34; -H &#34;Accept-Encoding: gzip, deflate, compress&#34; -d &#39;{&#34;parameters&#34;: [{&#34;subjectId&#34;: 1021}, &#34;Content of the ticket goes here&#34;]}&#39; &#39;https://api.softlayer.com/rest/v3.1/SoftLayer_Ticket/createStandardTicket.json&#39;</pre></div> +<p>The result you get back will be a ticket object. <a href="https://softlayer.github.io/python/create_ticket/">This example</a> has some information about which ticket subjects match up with which Ids. The whole list can be retrieved with this call.</p> +<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4">curl -u $SL_USER:$SL_APIKEY -X GET -H &#34;Accept: */*&#34; -H &#34;Accept-Encoding: gzip, deflate, compress&#34; &#39;https://api.softlayer.com/rest/v3.1/SoftLayer_Ticket_Subject/getAllObjects.json&#39;</pre></div> +<p>The <code>parameters</code> array passed into the createStandardTicket method matches the order shown in the documentation for that method.</p> + +<p>Another example</p> +<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4">curl -u $SL_USER:$SL_APIKEY -X POST -H &#34;Accept: */*&#34; -H &#34;Accept-Encoding: gzip, deflate, compress&#34; -d &#39;{&#34;parameters&#34;: [{&#34;subjectId&#34;: 1021, &#34;title&#34;: &#34;Test API Ticket&#34;}, &#34;Content of the ticket goes here&#34;, 305250,&#34;FakePass&#34;,&#34;Test&#34;,22,&#34;HARDWARE&#34;]}&#39; &#39;https://api.softlayer.com/rest/v3.1/SoftLayer_Ticket/createStandardTicket.json&#39;</pre></div> +<h2 id="updating-tickets">Updating Tickets</h2> + +<p>Once a ticket is created, you may want to update it to respond to another update, or add more information. This is done through the <a href="https://softlayer.github.io/reference/services/SoftLayer_Ticket/addUpdate/">SoftLayer_Ticket::addUpdate</a> method.</p> +<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4">curl -u $SL_USER:$SL_APIKEY -X POST -H &#34;Accept: */*&#34; -H &#34;Accept-Encoding: gzip, deflate, compress&#34; -d &#39;{&#34;parameters&#34;: [{&#34;entry&#34;: &#34;Testing updates&#34;}]}&#39; &#39;https://api.softlayer.com/rest/v3.1/SoftLayer_Ticket/&lt;TICKET ID YOU WANT TO UDPATE&gt;/addUpdate.json&#39;</pre></div> +<h2 id="attachments">Attachments</h2> + +<h3 id="attach-files">Attach Files</h3> + +<p><a href="https://softlayer.github.io/reference/services/SoftLayer_Ticket/addAttachedFile/">SoftLayer_Ticket::addAttachedFile</a> is useful when you need to add a screenshot, PDF, or something else thats not plain text to a ticket.</p> + +<p>Our ticket ID for this example is 58504963.</p> + +<blockquote> +<p><em>NOTE</em> the <code>data</code> field MUST be base64 encoded, which can be tricky to do in bash. The base64 string needs to be enclosed with &ldquo;&rdquo;, but bash needs the $(base64 <file>) bit to be escaped from the &ldquo; string.</p> +</blockquote> +<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4">curl -u $SL_USER:$SL_APIKEY -X POST -H &#34;Accept: */*&#34; -H &#34;Accept-Encoding: gzip, deflate, compress&#34; --data &#39;{&#34;parameters&#34;: [{&#34;data&#34;: &#34;&#39;&#34;$(base64 test.txt)&#34;&#39;&#34;, &#34;filename&#34;: &#34;test2.txt&#34;}]}&#39; &#39;https://api.softlayer.com/rest/v3.1/SoftLayer_Ticket/58504963/addAttachedFile&#39;</pre></div> +<h3 id="attach-hardware">Attach Hardware</h3> + +<p>For the best response from Support, you should attach any relevant hardware or virtual guests to the ticket, so Support knows which servers you are specifically talking about.</p> + +<p>There are different methods if you want to attach a bare metal or virtual server, but they behave the same.</p> +<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4">curl -u $SL_USER:$SL_APIKEY -X POST -H &#34;Accept: */*&#34; -H &#34;Accept-Encoding: gzip, deflate, compress&#34; --data &#39;{&#34;parameters&#34;: [481966]}&#39; &#39;https://api.softlayer.com/rest/v3.1/SoftLayer_Ticket/58504963/addAttachedHardware&#39; + +curl -u $SL_USER:$SL_APIKEY -X POST -H &#34;Accept: */*&#34; -H &#34;Accept-Encoding: gzip, deflate, compress&#34; --data &#39;{&#34;parameters&#34;: [27500547]}&#39; &#39;https://api.softlayer.com/rest/v3.1/SoftLayer_Ticket/58504963/addAttachedVirtualGuest&#39;</pre></div> +<h2 id="final-bits">Final Bits</h2> + +<p>Hopefully that helps explain most of the actions you can do with tickets.</p> + + Release notes: April 6, 2018 @@ -1579,15 +1693,5 @@ If you start to experience connection errors on the transition date, the best co - - SoftLayer ObjectStorage API - https://softlayer.github.io/reference/objectstorageapi/ - Mon, 12 Feb 2018 00:00:00 UTC - Enthusiastic Hugo User - https://softlayer.github.io/reference/objectstorageapi/ - <p>SoftLayer Object Storage is built from <a href="https://docs.openstack.org/swift/latest/">Open Stack Swift</a></p> - - - \ No newline at end of file diff --git a/rest/index.html b/rest/index.html index 59b80fcccc4..472d2f7802a 100644 --- a/rest/index.html +++ b/rest/index.html @@ -107,6 +107,16 @@

+ Tickets Apr 10, 2018
+ Examples of how to use and interact with tickets +

+ View Example +
+
+ +
+
+

Events Apr 5, 2018
Going over Events with some examples of what each might look like

diff --git a/rest/index.xml b/rest/index.xml index 09648cebc3a..02393c24e62 100644 --- a/rest/index.xml +++ b/rest/index.xml @@ -6,11 +6,21 @@ Recent content in Rest on SoftLayer API Hugo -- gohugo.io en-us - Thu, 05 Apr 2018 00:00:00 +0000 + Tue, 10 Apr 2018 00:00:00 +0000 + + Tickets + https://softlayer.github.io/rest/tickets/ + Tue, 10 Apr 2018 00:00:00 +0000 + + https://softlayer.github.io/rest/tickets/ + Tickets Tickets are how SoftLayer and you communicate and resolve problems. They can be about anything from general questions, requests for upgrades, monitoring alerts, or anything else that might come up. +Viewing Tickets To start off, lets see how to go about getting tickets that already exist on our account. There are a variety of helper functions on the SoftLayer_Account service that deal with tickets, and they all work basically the same way. + + Events https://softlayer.github.io/rest/events/ diff --git a/rest/tickets/index.html b/rest/tickets/index.html new file mode 100644 index 00000000000..a260f7a7408 --- /dev/null +++ b/rest/tickets/index.html @@ -0,0 +1,306 @@ + + + + + + + + + + + Tickets - https://softlayer.github.io/ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+
+

April 10, 2018

+
+
+
+ + Classes + + SoftLayer_Ticket + + SoftLayer_Ticket_Attachment_File + +
+ Tags + + resultlimit + + objectmask + + objectfilter + + ticket + +
+
+
+
+
+
+

Tickets
Examples of how to use and interact with tickets

+ + + + + +

Tickets

+ +

Tickets are how SoftLayer and you communicate and resolve problems. They can be about anything from general questions, requests for upgrades, monitoring alerts, or anything else that might come up.

+ +

Viewing Tickets

+ +

To start off, lets see how to go about getting tickets that already exist on our account. There are a variety of helper functions on the SoftLayer_Account service that deal with tickets, and they all work basically the same way. SoftLayer_Account::getTickets and SoftLayer_Account::getOpenTickets are the most basic of these.

+
curl -u $SL_USER:$SL_APIKEY -X GET -H "Accept: */*" -H "Accept-Encoding: gzip, deflate, compress"  'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/getOpenTickets.json'
+

Output:

+
[
+    {
+        "accountId": 307608,
+        "assignedUserId": 244956,
+        "createDate": "2018-03-30T14:41:47-06:00",
+        "groupId": 1004,
+        "id": 57894695,
+        "lastEditDate": null,
+        "lastEditType": "USER",
+        "lastResponseDate": "2018-03-30T14:41:48-06:00",
+        "modifyDate": "2018-03-30T14:41:48-06:00",
+        "notifyUserOnUpdateFlag": false,
+        "priority": 0,
+        "status": {
+            "id": 1001,
+            "name": "Open"
+        },
+        "statusId": 1001,
+        "subjectId": null,
+        "title": "Virtual Server Cancellation - 03/30/18",
+        "totalUpdateCount": 1,
+        "userEditableFlag": true
+    },
+

From there, the SoftLayer_Ticket datatype has quite a few fields we might be interested in. Here is how you would get the updates for the ticket, along with whatever hardware was attached.

+ +

https://api.softlayer.com/rest/v3.1/SoftLayer_Account/getOpenTickets.json? +objectMask=mask[id, title, updates, attachedHardware[hostname, id]]

+ +
+

Reminder: When requesting a LOCAL property, the result will remove all local properties not specified. When requesting a RELATIONAL property, that property, along with any of its default properties, will be added

+
+
curl -u $SL_USER:$SL_APIKEY -X GET -H "Accept: */*" -H "Accept-Encoding: gzip, deflate, compress"  'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/getOpenTickets.json?objectMask=mask%5Bid%2Ctitle%2Cupdates%2CattachedHardware%5Bhostname%2Cid%5D%5D'
+

Output:

+
   {
+        "attachedHardware": [
+            {
+                "hostname": "fmirdal13",
+                "id": 1477781
+            }
+        ],
+        "id": 58043007,
+        "title": "Server Cancellation - 04/04/2018",
+        "updates": [
+            {
+                "createDate": "2018-04-03T09:38:36-06:00",
+                "editorId": 205,
+                "editorType": "AUTO",
+                "entry": "A cancellation request has been submitted for the following:\nServer: fmirdal13.insomnia.com\nPublic IP: 169.60.129.46\nPrivate IP: 10.186.96.230\nServers and services must be cancelled prior to Apr 03, 2018 23:59:59 CDT.\n=================\nCustomer Note:\n",
+                "id": 358332963,
+                "ticketId": 58043007
+            }
+        ]
+    },
+

To get information about just one ticket, the SoftLayer_Ticket::getObject method would be used.

+
curl -u $SL_USER:$SL_APIKEY -X GET -H "Accept: */*" -H "Accept-Encoding: gzip, deflate, compress"  'https://api.softlayer.com/rest/v3.1/SoftLayer_Ticket/58043007/getObject.json?objectMask=mask%5Bid%2Ctitle%2Cupdates%2CattachedHardware%5Bhostname%2Cid%5D%5D'
+

Creating Tickets

+ +

There are a few create options in the SoftLayer_Ticket service, the only difference being which internal group they get routed to, and should be obvious based on the method name which one you need. If in doubt, use the standard ticket, SoftLayer_Ticket::createStandardTicket

+ +

The bare minimum to create a ticket is the following command:

+
curl -u $SL_USER:$SL_APIKEY -X POST -H "Accept: */*" -H "Accept-Encoding: gzip, deflate, compress" -d '{"parameters": [{"subjectId": 1021}, "Content of the ticket goes here"]}' 'https://api.softlayer.com/rest/v3.1/SoftLayer_Ticket/createStandardTicket.json'
+

The result you get back will be a ticket object. This example has some information about which ticket subjects match up with which Ids. The whole list can be retrieved with this call.

+
curl -u $SL_USER:$SL_APIKEY -X GET -H "Accept: */*" -H "Accept-Encoding: gzip, deflate, compress"  'https://api.softlayer.com/rest/v3.1/SoftLayer_Ticket_Subject/getAllObjects.json'
+

The parameters array passed into the createStandardTicket method matches the order shown in the documentation for that method.

+ +

Another example

+
curl -u $SL_USER:$SL_APIKEY -X POST -H "Accept: */*" -H "Accept-Encoding: gzip, deflate, compress" -d '{"parameters": [{"subjectId": 1021, "title": "Test API Ticket"}, "Content of the ticket goes here", 305250,"FakePass","Test",22,"HARDWARE"]}' 'https://api.softlayer.com/rest/v3.1/SoftLayer_Ticket/createStandardTicket.json'
+

Updating Tickets

+ +

Once a ticket is created, you may want to update it to respond to another update, or add more information. This is done through the SoftLayer_Ticket::addUpdate method.

+
curl -u $SL_USER:$SL_APIKEY -X POST -H "Accept: */*" -H "Accept-Encoding: gzip, deflate, compress" -d '{"parameters": [{"entry": "Testing updates"}]}' 'https://api.softlayer.com/rest/v3.1/SoftLayer_Ticket/<TICKET ID YOU WANT TO UDPATE>/addUpdate.json'
+

Attachments

+ +

Attach Files

+ +

SoftLayer_Ticket::addAttachedFile is useful when you need to add a screenshot, PDF, or something else thats not plain text to a ticket.

+ +

Our ticket ID for this example is 58504963.

+ +
+

NOTE the data field MUST be base64 encoded, which can be tricky to do in bash. The base64 string needs to be enclosed with “”, but bash needs the $(base64 ) bit to be escaped from the “ string.

+
+
curl -u $SL_USER:$SL_APIKEY -X POST -H "Accept: */*" -H "Accept-Encoding: gzip, deflate, compress" --data '{"parameters": [{"data": "'"$(base64 test.txt)"'", "filename": "test2.txt"}]}' 'https://api.softlayer.com/rest/v3.1/SoftLayer_Ticket/58504963/addAttachedFile'
+

Attach Hardware

+ +

For the best response from Support, you should attach any relevant hardware or virtual guests to the ticket, so Support knows which servers you are specifically talking about.

+ +

There are different methods if you want to attach a bare metal or virtual server, but they behave the same.

+
curl -u $SL_USER:$SL_APIKEY -X POST -H "Accept: */*" -H "Accept-Encoding: gzip, deflate, compress" --data '{"parameters": [481966]}' 'https://api.softlayer.com/rest/v3.1/SoftLayer_Ticket/58504963/addAttachedHardware'
+
+curl -u $SL_USER:$SL_APIKEY -X POST -H "Accept: */*" -H "Accept-Encoding: gzip, deflate, compress" --data '{"parameters": [27500547]}' 'https://api.softlayer.com/rest/v3.1/SoftLayer_Ticket/58504963/addAttachedVirtualGuest'
+

Final Bits

+ +

Hopefully that helps explain most of the actions you can do with tickets.

+ +
+
+ +
+
+
+ +
+ +
+
+

More Documentation

+
+
+ SoftLayer API Reference
 + softlayer-java
 + softlayer-perl
 + softlayer-php
 + softlayer-python
 + softlayer-ruby
 +
+
+ +
+
+ + + + + +
+
+ +
+
+
+ Feedback? +

+ We would love to hear it
+ Open an issue +

+
+
+ +
+
+
+
+
+

© SoftLayer 2015
+ Built with Hugo

+
+
+
+
+ + + + + + +/rest/tickets/ diff --git a/sitemap.xml b/sitemap.xml index e7e9c16ae03..0dd7e6d8ede 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -1,6 +1,11 @@ + + https://softlayer.github.io/rest/tickets/ + 2018-04-10T00:00:00+00:00 + + https://softlayer.github.io/release_notes/2018/20180406/ 2018-04-06T00:00:00+00:00 @@ -5109,7 +5114,7 @@ https://softlayer.github.io/tags/objectfilter/ - 2018-04-05T00:00:00+00:00 + 2018-04-10T00:00:00+00:00 0 @@ -5121,7 +5126,7 @@ https://softlayer.github.io/tags/objectmask/ - 2018-04-05T00:00:00+00:00 + 2018-04-10T00:00:00+00:00 0 @@ -5337,13 +5342,13 @@ https://softlayer.github.io/rest/ - 2018-04-05T00:00:00+00:00 + 2018-04-10T00:00:00+00:00 0 https://softlayer.github.io/tags/resultlimit/ - 2018-04-05T00:00:00+00:00 + 2018-04-10T00:00:00+00:00 0 @@ -5433,7 +5438,7 @@ https://softlayer.github.io/ - 2018-04-06T00:00:00+00:00 + 2018-04-10T00:00:00+00:00 0 @@ -17383,7 +17388,7 @@ https://softlayer.github.io/classes/softlayer_ticket/ - 2018-02-12T00:00:00+00:00 + 2018-04-10T00:00:00+00:00 0 @@ -17419,7 +17424,7 @@ https://softlayer.github.io/classes/softlayer_ticket_attachment_file/ - 2018-02-12T00:00:00+00:00 + 2018-04-10T00:00:00+00:00 0 @@ -18114,13 +18119,13 @@ - https://softlayer.github.io/classes/swift/ + https://softlayer.github.io/tags/swift/ 2017-09-13T00:00:00+00:00 0 - https://softlayer.github.io/tags/swift/ + https://softlayer.github.io/classes/swift/ 2017-09-13T00:00:00+00:00 0 @@ -18151,7 +18156,7 @@ https://softlayer.github.io/tags/ticket/ - 2018-02-12T00:00:00+00:00 + 2018-04-10T00:00:00+00:00 0 @@ -18252,14 +18257,14 @@ - https://softlayer.github.io/classes/virtual_guest/ - 2016-01-29T00:00:00+00:00 + https://softlayer.github.io/tags/virtual_guest/ + 2015-02-15T00:00:00+00:00 0 - https://softlayer.github.io/tags/virtual_guest/ - 2015-02-15T00:00:00+00:00 + https://softlayer.github.io/classes/virtual_guest/ + 2016-01-29T00:00:00+00:00 0 diff --git a/tags/index.xml b/tags/index.xml index aaf7ced04f7..55a243a18fa 100644 --- a/tags/index.xml +++ b/tags/index.xml @@ -968,7 +968,7 @@ Objectfilter https://softlayer.github.io/tags/objectfilter/ - Thu, 05 Apr 2018 00:00:00 +0000 + Tue, 10 Apr 2018 00:00:00 +0000 https://softlayer.github.io/tags/objectfilter/ @@ -986,7 +986,7 @@ Objectmask https://softlayer.github.io/tags/objectmask/ - Thu, 05 Apr 2018 00:00:00 +0000 + Tue, 10 Apr 2018 00:00:00 +0000 https://softlayer.github.io/tags/objectmask/ @@ -1265,7 +1265,7 @@ Resultlimit https://softlayer.github.io/tags/resultlimit/ - Thu, 05 Apr 2018 00:00:00 +0000 + Tue, 10 Apr 2018 00:00:00 +0000 https://softlayer.github.io/tags/resultlimit/ @@ -1481,7 +1481,7 @@ Ticket https://softlayer.github.io/tags/ticket/ - Mon, 12 Feb 2018 00:00:00 +0000 + Tue, 10 Apr 2018 00:00:00 +0000 https://softlayer.github.io/tags/ticket/ diff --git a/tags/objectfilter/index.html b/tags/objectfilter/index.html index 13b6ff72cf1..2a9d18c123a 100644 --- a/tags/objectfilter/index.html +++ b/tags/objectfilter/index.html @@ -204,6 +204,11 @@

python

rest

    +
  • + Tickets +
    Examples of how to use and interact with tickets
    +
    • +
  • Events
    Going over Events with some examples of what each might look like
    diff --git a/tags/objectfilter/index.xml b/tags/objectfilter/index.xml index 94c35d2201b..b4d007ca7e4 100644 --- a/tags/objectfilter/index.xml +++ b/tags/objectfilter/index.xml @@ -6,11 +6,21 @@ Recent content in Objectfilter on SoftLayer API Hugo -- gohugo.io en-us - Thu, 05 Apr 2018 00:00:00 +0000 + Tue, 10 Apr 2018 00:00:00 +0000 + + Tickets + https://softlayer.github.io/rest/tickets/ + Tue, 10 Apr 2018 00:00:00 +0000 + + https://softlayer.github.io/rest/tickets/ + Tickets Tickets are how SoftLayer and you communicate and resolve problems. They can be about anything from general questions, requests for upgrades, monitoring alerts, or anything else that might come up. +Viewing Tickets To start off, lets see how to go about getting tickets that already exist on our account. There are a variety of helper functions on the SoftLayer_Account service that deal with tickets, and they all work basically the same way. + + Events https://softlayer.github.io/rest/events/ diff --git a/tags/objectmask/index.html b/tags/objectmask/index.html index 3a6e12b6058..ac9baff1ece 100644 --- a/tags/objectmask/index.html +++ b/tags/objectmask/index.html @@ -249,6 +249,11 @@

    python

    rest

      +
    • + Tickets +
      Examples of how to use and interact with tickets
      +
      • +
    • Events
      Going over Events with some examples of what each might look like
      diff --git a/tags/objectmask/index.xml b/tags/objectmask/index.xml index d539de4d4af..c9bfd59ca3f 100644 --- a/tags/objectmask/index.xml +++ b/tags/objectmask/index.xml @@ -6,11 +6,21 @@ Recent content in Objectmask on SoftLayer API Hugo -- gohugo.io en-us - Thu, 05 Apr 2018 00:00:00 +0000 + Tue, 10 Apr 2018 00:00:00 +0000 + + Tickets + https://softlayer.github.io/rest/tickets/ + Tue, 10 Apr 2018 00:00:00 +0000 + + https://softlayer.github.io/rest/tickets/ + Tickets Tickets are how SoftLayer and you communicate and resolve problems. They can be about anything from general questions, requests for upgrades, monitoring alerts, or anything else that might come up. +Viewing Tickets To start off, lets see how to go about getting tickets that already exist on our account. There are a variety of helper functions on the SoftLayer_Account service that deal with tickets, and they all work basically the same way. + + Events https://softlayer.github.io/rest/events/ diff --git a/tags/resultlimit/index.html b/tags/resultlimit/index.html index 5941b71d285..2e7ca391d87 100644 --- a/tags/resultlimit/index.html +++ b/tags/resultlimit/index.html @@ -134,6 +134,11 @@

      python

      rest

        +
      • + Tickets +
        Examples of how to use and interact with tickets
        +
        • +
      • Events
        Going over Events with some examples of what each might look like
        diff --git a/tags/resultlimit/index.xml b/tags/resultlimit/index.xml index bcba522efc3..d2ed8b0f4f3 100644 --- a/tags/resultlimit/index.xml +++ b/tags/resultlimit/index.xml @@ -6,11 +6,21 @@ Recent content in Resultlimit on SoftLayer API Hugo -- gohugo.io en-us - Thu, 05 Apr 2018 00:00:00 +0000 + Tue, 10 Apr 2018 00:00:00 +0000 + + Tickets + https://softlayer.github.io/rest/tickets/ + Tue, 10 Apr 2018 00:00:00 +0000 + + https://softlayer.github.io/rest/tickets/ + Tickets Tickets are how SoftLayer and you communicate and resolve problems. They can be about anything from general questions, requests for upgrades, monitoring alerts, or anything else that might come up. +Viewing Tickets To start off, lets see how to go about getting tickets that already exist on our account. There are a variety of helper functions on the SoftLayer_Account service that deal with tickets, and they all work basically the same way. + + Events https://softlayer.github.io/rest/events/ diff --git a/tags/ticket/index.html b/tags/ticket/index.html index 9077d234af7..4971923c5a9 100644 --- a/tags/ticket/index.html +++ b/tags/ticket/index.html @@ -781,6 +781,16 @@

        reference

      +

      rest

      +
        + +
      • + Tickets +
        Examples of how to use and interact with tickets
        +
        • + +
      +

      ruby

        diff --git a/tags/ticket/index.xml b/tags/ticket/index.xml index 71c4d9b8adc..28dc594a4b4 100644 --- a/tags/ticket/index.xml +++ b/tags/ticket/index.xml @@ -6,11 +6,21 @@ Recent content in Ticket on SoftLayer API Hugo -- gohugo.io en-us - Mon, 12 Feb 2018 00:00:00 +0000 + Tue, 10 Apr 2018 00:00:00 +0000 + + Tickets + https://softlayer.github.io/rest/tickets/ + Tue, 10 Apr 2018 00:00:00 +0000 + + https://softlayer.github.io/rest/tickets/ + Tickets Tickets are how SoftLayer and you communicate and resolve problems. They can be about anything from general questions, requests for upgrades, monitoring alerts, or anything else that might come up. +Viewing Tickets To start off, lets see how to go about getting tickets that already exist on our account. There are a variety of helper functions on the SoftLayer_Account service that deal with tickets, and they all work basically the same way. + + SoftLayer_Ticket https://softlayer.github.io/reference/services/SoftLayer_Ticket/