@manyos/smileconnect-api 1.28.0

package/docs/howto/cmdbobjects.md

@@ -0,0 +1,339 @@
+---
+layout: page
+title: Access CMDBObjects
+subtitle: In this guide you will learn to do the basic operations with an CMDB Objects.
+use-site-title: true
+gh-badge: [star, fork, follow]
+gh-repo: daattali/beautiful-jekyll
+---
+
+# Read a CMDBObject
+
+We can query every cmdbobject we have access to with a simple get request.
+
+## Request Definition
+
+To read a cmdbobject you need to do a GET request to the /v1/cmdbobjects/*id* endpoint of your API
+
+### URL
+
+*URL*: https://*api-fqdn*/v1/cmdbobjects/*id*
+
+*api-fqdn*: The hostname of your API Server
+
+*id*: The instance id of the cmdbobjects you want to read.
+
+### Headers
+
+*Content-Type*: application/json
+
+### Authorization
+
+*Type*: Bearer
+
+Use your [API Token](token.md)
+
+### Sample Response
+
+GET:https://*api-fqdn*/v1/cmdbobjects/AGGarserver000PMIYWAPL1SMUB5AZ
+
+{% highlight json linenos %}
+{
+    "data": {
+        "id": "AGGarserver000PMIYWAPL1SMUB5AZ",
+        "tagNumber": null,
+        "name": "Hallo22",
+        "assetlifecycleStatus": "Deployed",
+        "category": "Hardware",
+        "item": "Server",
+        "type": "Processing Unit",
+        "productName": null,
+        "classId": "BMC_COMPUTERSYSTEM",
+        "reconId": "REGarserver000PMIYWAPL1SMUB5BC",
+        "shortDescription": "Shorty",
+        "federatedLink": "https://myit.de/smart-it/REGarserver000PMIYWAPL1SMUB5BC/BMC_COMPUTERSYSTEM",
+        "relations": {
+            "relatedCIs": [
+                {
+                    "ciId": "AGGarserver000PMIX6MPL1RH6B3Y8",
+                    "ciClass": "BMC_COMPUTERSYSTEM",
+                    "direction": "child",
+                    "relationClass": "BMC.CORE:BMC_DEPENDENCY"
+                }
+            ],
+            "relatedPersons": [
+                {
+                    "personId": "PPL000000000014",
+                    "role": "Used by"
+                },
+                {
+                    "personId": "PPL000000000015",
+                    "role": "Used by"
+                },
+                {
+                    "personId": "PPL000000000016",
+                    "role": "Used by"
+                },
+                {
+                    "personId": "PPL000000000017",
+                    "role": "Used by"
+                },
+                {
+                    "personId": "PPL000000000020",
+                    "role": "Owned by"
+                }
+            ],
+            "relatedOrganisations": [
+                {
+                    "organisationId": "POR000000000012",
+                    "role": "Owned by"
+                }
+            ],
+            "relatedSupportGroups": [
+                {
+                    "groupId": "SGP000000000011",
+                    "role": "Supported by"
+                }
+            ]
+        }
+    },
+   "included": {
+       "persons": [
+           {
+               "id": "PPL000000000014",
+               "name": "Bob Baxter",
+               "department": "Customer Service",
+               "login": "Bob",
+               "mail": "B.Baxter@calbroservices.com",
+               "supportGroups": [
+                   {
+                       "supportGroupId": "SGP000000000013",
+                       "isDefault": "No",
+                       "assignmentAvailability": "Yes",
+                       "roles": []
+                   },
+                   {
+                       "supportGroupId": "SGP000000000011",
+                       "isDefault": "No",
+                       "assignmentAvailability": "Yes",
+                       "roles": []
+                   },
+                   {
+                       "supportGroupId": "SGP000000000010",
+                       "isDefault": "No",
+                       "assignmentAvailability": "Yes",
+                       "roles": []
+                   }
+               ]
+           },
+           {
+               "id": "PPL000000000015",
+               "name": "Michel Dupond",
+               "department": null,
+               "login": "Michel",
+               "mail": "M.Dupond@calbroservices.com",
+               "supportGroups": []
+           },
+           {
+               "id": "PPL000000000016",
+               "name": "Mary Mann",
+               "department": "Customer Service",
+               "login": "Mary",
+               "mail": "M.Mann@calbroservices.com",
+               "supportGroups": [
+                   {
+                       "supportGroupId": "SGP000000000010",
+                       "isDefault": "No",
+                       "assignmentAvailability": "Yes",
+                       "roles": [
+                           "Support Group Manager",
+                           "Infrastructure Change Manager",
+                           "Infrastructure Change Approver"
+                       ]
+                   },
+                   {
+                       "supportGroupId": "SGP000000000011",
+                       "isDefault": "Yes",
+                       "assignmentAvailability": "Yes",
+                       "roles": [
+                           "Support Group Manager",
+                           "Infrastructure Change Manager",
+                           "Infrastructure Change Approver"
+                       ]
+                   }
+               ]
+           },
+           {
+               "id": "PPL000000000017",
+               "name": "Hans Mueller",
+               "department": null,
+               "login": "Hans",
+               "mail": "H.Mueller@calbroservices.com",
+               "supportGroups": []
+           },
+           {
+               "id": "PPL000000000020",
+               "name": "Manuel Ramirez",
+               "department": null,
+               "login": "Manuel",
+               "mail": "M.Ramirez@calbroservices.com",
+               "supportGroups": []
+           }
+       ],
+       "organisations": [
+           {
+               "id": "POR000000000012",
+               "company": "Calbro Services",
+               "organisation": "Human Resources",
+               "department": "Payroll"
+           }
+       ],
+       "supportgroups": [
+           {
+               "id": "SGP000000000011",
+               "supportGroup": "Service Desk",
+               "company": "Calbro Services",
+               "supportOrganisation": "IT Support",
+               "supportRole": "Help Desk",
+               "persons": [
+                   {
+                       "personId": "PPL000000000013",
+                       "isDefaultGroup": "Yes",
+                       "assignmentAvailability": "Yes",
+                       "roles": [
+                           "Support Group Manager",
+                           "Support Group Admin",
+                           "Availability Manager",
+                           "Incident Manager",
+                           "Problem Coordinator",
+                           "Service Level Manager",
+                           "Release Coordinator",
+                           "Broadcast Submitter",
+                           "Release Approver",
+                           "Work Order Manager"
+                       ]
+                   },
+                   {
+                       "personId": "PPL000000000016",
+                       "isDefaultGroup": "Yes",
+                       "assignmentAvailability": "Yes",
+                       "roles": [
+                           "Support Group Manager",
+                           "Infrastructure Change Manager",
+                           "Infrastructure Change Approver"
+                       ]
+                   },
+                   {
+                       "personId": "PPL000000000021",
+                       "isDefaultGroup": "Yes",
+                       "assignmentAvailability": "Yes",
+                       "roles": [
+                           "Support Group Lead"
+                       ]
+                   },
+                   {
+                       "personId": "PPL000000000012",
+                       "isDefaultGroup": "Yes",
+                       "assignmentAvailability": "No",
+                       "roles": []
+                   },
+                   {
+                       "personId": "PPL000000000014",
+                       "isDefaultGroup": "No",
+                       "assignmentAvailability": "Yes",
+                       "roles": []
+                   },
+                   {
+                       "personId": "PPL000000000105",
+                       "isDefaultGroup": "Yes",
+                       "assignmentAvailability": "Yes",
+                       "roles": [
+                           "Work Order Manager",
+                           "Problem Coordinator"
+                       ]
+                   },
+                   {
+                       "personId": "PPL000000000106",
+                       "isDefaultGroup": "Yes",
+                       "assignmentAvailability": "Yes",
+                       "roles": [
+                           "Work Order Manager"
+                       ]
+                   }
+               ]
+           }
+       ]
+   }
+}
+{% endhighlight %}
+
+# Search for CMDBObjects
+
+You can search for object by sending a POST request custom query. Let's assume you want to find all objects where the names starts with Computer.
+
+## Request Definition
+
+To search for objects do a POST to the /v1/cmdbobjects/search endpoint of your API
+
+### URL
+
+*URL*: https://*api-fqdn*/v1/cmdbobjects/search
+
+*api-fqdn*: The hostname of your API Server
+
+### Headers
+
+*Content-Type*: application/json
+
+### Authorization
+
+*Type*: Bearer
+
+Use your [API Token](token.md)
+
+### Body
+
+Provide the searchString you want to use
+
+### Sample Request
+
+POST:https://*api-fqdn*/v1/cmdbobjects/search
+
+{% highlight json linenos %}
+{
+	"searchString":"'name' LIKE \"Computer%\"",
+	"getRelations":true,
+	"fields": [
+		"name",
+		"id",
+		"assetlifecycleStatus"
+	],
+	"sort" : {
+		"name" : 1,
+		"productName": -1
+	},
+	"limit": 100,
+	"offset": 4
+}
+{% endhighlight %}
+
+### Sample Response
+
+{% highlight json linenos %}
+{
+    "data": [
+        {
+            "id": "OI-1B9D2CFA1A9311E9878D0242AC12000A",
+            "name": "Computer1",
+            "assetlifecycleStatus": "Deployed",
+            "relations": {
+                "relatedPersons": [],
+                "relatedOrganisations": [],
+                "relatedSupportGroups": [],
+                "relatedCIs": []
+            }
+        }
+    ],
+    "included": {}
+}
+{% endhighlight %}

package/docs/howto/incident-worklogs.md

@@ -0,0 +1,186 @@
+---
+layout: page
+title: Worklogs
+subtitle: In this guide we'll show you how to create and read worklogs.
+use-site-title: true
+gh-badge: [star, fork, follow]
+gh-repo: daattali/beautiful-jekyll
+---
+
+In this guide we'll show you how to create and read worklogs. Worklogs can be used with the following object types:
+
+* Incident
+* Problem
+* Change
+* Workorder
+* Workorder Tasks
+
+In this guide we'll show the usage on Incidents. For all other request types the functionality is implemented in the same way.
+
+# Get all worklogs for an Incident
+
+You will receive all worklogs for this incident.
+
+## Request Definition
+
+You need to do a GET request to the /v1/incidents/*incidentId*/worklogs endpoint of your API
+
+### URL
+
+*URL*: https://*api-fqdn*/v1/incidents/*incidentId*/worklogs
+
+*api-fqdn*: The hostname of your API Server
+
+*incidentId*: The id of the incident you want to read.
+
+### Headers
+
+*Content-Type*: application/json
+
+### Authorization
+
+*Type*: Bearer
+
+Use your [API Token](token.md)
+
+### Sample Response
+
+GET:https://*api-fqdn*/v1/incidents/INC000000000217/worklogs
+
+{% highlight json linenos %}
+{
+    "data": [
+        {
+            "summary": "Status Change",
+            "text": "Status Marked: Resolved by Allen",
+            "id": "WLG000000000533"
+        },
+        {
+            "summary": "Assignment Change",
+            "text": "Assigned To: Bob by Remedy Application Service",
+            "id": "WLG000000000531"
+        },
+        {
+            "summary": "Created",
+            "text": "Incident created by ITSM-API",
+            "id": "WLG000000000532"
+        }
+    ]
+}
+{% endhighlight %}
+
+# Get a specifc worklog for an Incident
+
+You will receive one specific worklog for this incident.
+
+## Request Definition
+
+You need to do a GET request to the /v1/incidents/*incidentId*/worklogs/*worklogid* endpoint of your API
+
+### URL
+
+*URL*: https://*api-fqdn*/v1/incidents/*incidentId*/worklogs/*worklogid*
+
+*api-fqdn*: The hostname of your API Server
+
+*incidentId*: The id of the incident you want to read.
+*worklogid*: The id of the worklog you want to read.
+
+### Headers
+
+*Content-Type*: application/json
+
+### Authorization
+
+*Type*: Bearer
+
+Use your [API Token](token.md)
+
+### Sample Response
+
+GET:https://*api-fqdn*/v1/incidents/INC000000000217/worklogs/WLG000000000533
+
+{% highlight json linenos %}
+{
+    "data": {
+        "summary": "Status Change",
+        "text": "Status Marked: Resolved by Allen",
+        "id": "WLG000000000533"
+    },
+    "urls": [
+        {
+            "attachmentUrl": "/v1/incidents/INC000000000217/worklogs/WLG000000000533/attachment"
+        },
+        {
+            "self": "/v1/incidents/INC000000000217/worklogs/WLG000000000533"
+        }
+    ]
+}
+{% endhighlight %}
+
+# Create a new worklog
+
+You can document your work on a request in the worklog. Simply create a new one.
+
+## Request Definition
+
+To create a worklog you need to do a POST to the /v1/incidents/*incidentid*/worklog endpoint of your API
+
+### URL
+
+*URL*: https://*api-fqdn*/v1/incidents/*incidentid*/worklogs
+
+*api-fqdn*: The hostname of your API Server
+*incidentId*: The id of the incident you want to read.
+
+### Headers
+
+*Content-Type*: application/json
+
+### Authorization
+
+*Type*: Bearer
+
+Use your [API Token](token.md)
+
+### Body
+
+Provide a summary and a detailed text within the *data* attribute.
+
+{: .box-note}
+**Note:** In smartit only the detailed text is shown.
+
+### Sample Request
+
+POST:https://*api-fqdn*/v1/incidents/INC000000000217/worklogs
+
+{% highlight json linenos %}
+{
+    "data": {
+        "summary": "Implementation update",
+        "text": "The implementation will be completed soon. Please stand by."
+    }
+}
+{% endhighlight %}
+
+### Sample Response
+
+{% highlight json linenos %}
+{
+    "data": {
+        "summary": "Implementation update",
+        "text": "The implementation will be completed soon. Please stand by.",
+        "id": "WLG000000001239"
+    },
+    "urls": [
+        {
+            "attachmentUrl": "/v1/incidents/INC000000000217/worklogs/WLG000000001239/attachment"
+        },
+        {
+            "self": "/v1/incidents/INC000000000217/worklogs/WLG000000001239"
+        }
+    ]
+}
+{% endhighlight %}
+
+To learn how to hanle attachments click [here](./worklog-attachment.md)