From edff3cd2f00a3eb3bbd18d304fba28f98e5e8000 Mon Sep 17 00:00:00 2001 From: timschaeren Date: Thu, 26 Sep 2024 08:17:53 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20swisspos?= =?UTF-8?q?t/myit-api-doc@032340b9f8060ddf82a7f176f5089f6b938d9a6e=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- dispoAPI/index.html | 447 +++++++++++++++++++++++++++++ incidentRestAPI.html => index.html | 0 2 files changed, 447 insertions(+) create mode 100644 dispoAPI/index.html rename incidentRestAPI.html => index.html (100%) diff --git a/dispoAPI/index.html b/dispoAPI/index.html new file mode 100644 index 0000000..a5f945d --- /dev/null +++ b/dispoAPI/index.html @@ -0,0 +1,447 @@ + + + + + + + DispoAPI + + + + + + + + + +
API docs by Redocly

DispoAPI (0.0.1)

Download OpenAPI specification:Download

handles inventory changes in MyIT cmdb for DispoTool.

+

Switches one device for another in the cmdb, including any children the old device might have had.

tbd

+
Authorizations:
BasicAuth
Request Body schema: application/json
inventoryNumber_old
required
string

The asset tag of the old device.

+
inventoryNumber_new
required
string

The asset tag of the new device.

+
storage_location
required
string

The sys-id of the storage location of the old device.

+
technician
required
string

The technician performing the action. This string will appear in the activity stream.

+
comment
required
string

A comment composed by the technician that will appear in the activity stream.

+

Responses

Request samples

Content type
application/json
{
  • "inventoryNumber_old": "string",
  • "inventoryNumber_new": "string",
  • "storage_location": "string",
  • "technician": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "message": "Device 23282978 was switched for 23271091 successfully."
}

Installs a device in the cmdb

tbd

+
Authorizations:
BasicAuth
Request Body schema: application/json
inventoryNumber
required
string

The asset tag of the device.

+
location
required
string

The location of the device.

+
technician
required
string

The technician performing the action. This string will appear in the activity stream.

+
comment
required
string

A comment composed by the technician that will appear in the activity stream.

+
assigned_to
string

The sys-id of the user of the device.

+
cost_center
string

The sys-id of the cost-center of the device.

+
children
Array of arrays

Any children to install alongside the device containing the sys-id of the child as well as the name of the relation.

+
parents
Array of arrays

Any parents the device has containing the sys-id of the parent as well as the name of the relation.

+

Responses

Request samples

Content type
application/json
{
  • "inventoryNumber": "string",
  • "location": "string",
  • "technician": "string",
  • "comment": "string",
  • "assigned_to": "string",
  • "cost_center": "string",
  • "children": [
    ],
  • "parents": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Device 23282978 was installed successfully."
}

Uninstalls a device in the cmdb including any children passed in the request.

tbd

+
Authorizations:
BasicAuth
Request Body schema: application/json
inventoryNumber
required
string

The asset tag of the device.

+
storage_location
required
string

The sys-id of the storage location of the device.

+
technician
required
string

The technician performing the action. This string will appear in the activity stream.

+
comment
required
string

A comment composed by the technician that will appear in the activity stream.

+
children
Array of arrays

The list of sys-id's of children to uninstall alongside the parent-device. This has to exactly match the existing children in the cmdb.

+

Responses

Request samples

Content type
application/json
{
  • "inventoryNumber": "string",
  • "storage_location": "string",
  • "technician": "string",
  • "comment": "string",
  • "children": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Device 23282978 was uninstalled successfully."
}
+ + + + diff --git a/incidentRestAPI.html b/index.html similarity index 100% rename from incidentRestAPI.html rename to index.html