solarwinds-itsm-api-definitions 0.1.1 → 0.1.6

data/lib/definitions/common/examples/catalog_item.json

@@ -0,0 +1,70 @@
+{
+  "examples": {
+    "request": {
+      "json": {
+        "catalog_item": {
+          "name": "CI Name",
+          "site_id": 1,
+          "department_id": 1,
+          "description": "description",
+          "state": "Approved",
+          "default_assignee_id": "1",
+          "category": { "name": "Facilities" },
+          "subcategory": { "name": "Equipment" },
+          "expected_delivery_time": "1 day",
+          "currency": "USD",
+          "price": "1",
+          "show_price": true,
+          "add_to_tag_list": "tag1",
+          "remove_from_tag_list": "tag2",
+          "tag_list": "tag1"
+        }
+      }
+    },
+    "response": {
+      "json": {
+        "catalog_item": {
+          "id": "10000",
+          "number": "1000",
+          "name": "CI Name",
+          "description": "description",
+          "created_at": "2025-01-01T00:00:00.000+01:00",
+          "site": {
+            "id": "1",
+            "name": "Austin TX, USA",
+            "location": "AUS",
+            "description": "",
+            "time_zone": ""
+          },
+          "department": {
+            "id": "1",
+            "name": "Support",
+            "description": "",
+            "default_assignee_id": "1"
+          },
+          "category": { 
+            "id": "10000",
+            "name": "Facilities",
+            "default_tags": "tagA, tagB",
+            "parent_id": "null",
+            "default_assignee_id": "1"
+          },
+          "subcategory": { 
+            "id": "1000",
+            "name": "Equipment",
+            "default_tags": "",
+            "parent_id": "10000",
+            "default_assignee_id": "1"
+          },
+          "expected_delivery_time": "1 day",
+          "currency": "USD",
+          "price": "1",
+          "show_price": true,
+          "tags": [{ "id": 1, "name": "tag1", "taggings_count": 1 }],
+          "origin": "api",
+          "incidents": [{ "id": "100", "href": "https://mydomain.com/incidents/100"}]
+        }
+      }
+    }
+  }
+}

data/lib/definitions/common/examples/change.json

@@ -0,0 +1,127 @@
+{
+  "examples": {
+    "request": {
+      "json": {
+        "change": {
+          "name": "Change Name",
+          "change_type": 1,
+          "site_id": 1,
+          "department_id": 1,
+          "description": "description",
+          "state_id": 1,
+          "assignee": { "email": "john.doe@email.com" },
+          "requester": { "email": "john.doe@email.com" },
+          "priority": "High",
+          "change_plan": "change plan",
+          "rollback_plan": "rollback plan",
+          "test_plan": "test plan" ,
+          "planned_start_at": "2025-01-01 00:00" ,
+          "planned_end_at": "2025-01-01 05:00",
+          "add_to_tag_list": "tag1, tag2",
+          "remove_from_tag_list": "tag3",
+          "tag_list": "tag1, tag2",
+          "custom_fields_values_attributes": [
+            { "id": 10, "custom_field_id": 1, "value": "content" },
+            { "id": 100, "custom_field_id": 2, "value": "1" }
+          ],
+          "custom_fields_values": {
+            "custom_fields_value": [
+              { "name": "Text custom field", "value": "content" },
+              { "name": "User custom field", "user_value": { "email": "john.doe@email.com" } }
+            ]
+          },
+          "incidents": [{ "number": "100" }],
+          "problems": [{ "number": "100" }],
+          "releases": [{ "number": "100" }],
+          "configuration_item_ids":["100"]
+        }
+      }
+    },
+    "response": {
+      "json": {
+        "change": {
+          "id": "10000",
+          "number": "1000",
+          "name": "Change Name",
+          "description": "description",
+          "state": "New",
+          "site": {
+            "id": "1",
+            "name": "Austin TX, USA",
+            "location": "AUS",
+            "description": "",
+            "time_zone": ""
+          },
+          "department": {
+            "id": "1",
+            "name": "Support",
+            "description": "",
+            "default_assignee_id": "1"
+          },
+          "priority": "High",
+          "assignee": {
+            "group_id": "1",
+            "is_user": "true",
+            "id":  "1",
+            "name": "John Doe",
+            "email": "john.doe@email.com",
+            "avatar": {
+                "type": "initials",
+                "color": "#fd4165",
+                "initials": "JD"
+            }
+          },
+          "requester": {
+            "id": "1",
+            "account_id": "1",
+            "user_id": "1",
+            "email": "john.doe@email.com",
+            "name": "John Doe",
+            "disabled": false,
+            "avatar": {
+              "type": "initials",
+              "color": "#fd4165",
+              "initials": "JD"
+            }
+          },
+          "custom_fields_values": [
+            {
+              "id": "10",
+              "custom_field_id": "1",
+              "name": "Text custom field",
+              "value": "content",
+              "options": "",
+              "type_name": "Text"
+            },
+            {
+              "id": "100",
+              "custom_field_id": "2",
+              "name": "User custom field",
+              "value": "1",
+              "options": "",
+              "type_name": "User",
+              "user": {
+                "group_id": 1,
+                "is_user": true,
+                "id": 1,
+                "name": "John Doe",
+                "email": "john.doe@email.com"
+              }
+            }
+          ],
+          "change_plan": "change plan",
+          "rollback_plan": "rollback plan",
+          "test_plan": "test plan" ,
+          "planned_start_at": "2025-01-01T00:00:00.000+01:00" ,
+          "planned_end_at": "2025-01-01T05:00:00.000+01:00",
+          "origin": "api",
+          "created_at": "2025-01-01T00:00:00.000+01:00",
+          "incidents": [{ "id": "100", "href": "https://mydomain.com/incidents/100"}],
+          "problems": [{ "id": "100", "href": "https://mydomain.com/problems/100"}],
+          "releases": [{ "id": "100", "href": "https://mydomain.com/releases/100"}],
+          "configuration_items": [{ "id": "100", "href": "https://mydomain.com/configuration_items/100"}]
+        }
+      }
+    }
+  }
+}

data/lib/definitions/common/examples/change_catalog.json

@@ -0,0 +1,92 @@
+{
+  "examples": {
+    "request": {
+      "json": {
+        "change_catalog": {
+          "name": "Change Catalog Name",
+          "change_type": 1,
+          "site_id": 1,
+          "department_id": 1,
+          "description": "description",
+          "state_id": 1,
+          "default_assignee_id": 1,
+          "priority": "High",
+          "change_plan": "change plan",
+          "rollback_plan": "rollback plan",
+          "test_plan": "test plan" ,
+          "add_to_tag_list": "tag1, tag2",
+          "remove_from_tag_list": "tag3",
+          "tag_list": "tag1, tag2",
+          "custom_fields_values_attributes": [
+            { "id": 10, "custom_field_id": 1, "value": "content" },
+            { "id": 100, "custom_field_id": 2, "value": "1" }
+          ],
+          "custom_fields_values": {
+            "custom_fields_value": [
+              { "name": "Text custom field", "value": "content" },
+              { "name": "User custom field", "user_value": { "email": "john.doe@email.com" } }
+            ]
+          },
+          "show_in_portal": true
+        }
+      }
+    },
+    "response": {
+      "json": {
+        "change_catalog": {
+          "id": "1",
+          "number": "1",
+          "name": "Change Catalog Name",
+          "description": "description",
+          "state": "Approved",
+          "site": {
+            "id": "1",
+            "name": "Austin TX, USA",
+            "location": "AUS",
+            "description": "",
+            "time_zone": ""
+          },
+          "department": {
+            "id": "1",
+            "name": "Support",
+            "description": "",
+            "default_assignee_id": "1"
+          },
+          "priority": "High",
+          "default_assignee_id": 1,
+          "custom_fields_values": [
+            {
+              "id": "10",
+              "custom_field_id": "1",
+              "name": "Text custom field",
+              "value": "content",
+              "options": "",
+              "type_name": "Text"
+            },
+            {
+              "id": "100",
+              "custom_field_id": "2",
+              "name": "User custom field",
+              "value": "1",
+              "options": "",
+              "type_name": "User",
+              "user": {
+                "group_id": 1,
+                "is_user": true,
+                "id": 1,
+                "name": "John Doe",
+                "email": "john.doe@email.com"
+              }
+            }
+          ],
+          "change_plan": "change plan",
+          "rollback_plan": "rollback plan",
+          "test_plan": "test plan",
+          "origin": "api",
+          "created_at": "2025-01-01T00:00:00.000+01:00",
+          "show_in_portal": true
+        }
+      }
+    }
+  }
+}

data/lib/definitions/common/examples/configuration_item.json

@@ -0,0 +1,108 @@
+{
+  "examples": {
+    "request": {
+      "json": {
+        "configuration_item": {
+          "name": "Configuration Item Name",
+          "description": "Description",
+          "type": { "name": "Building" },
+          "type_id": 1,
+          "asset_tag": "ConfigurationItemTag",
+          "site_id": 1,
+          "department_id": 1,
+          "state": "Active",
+          "manager": { "email": "john.doe@email.com" },
+          "user": { "email": "jane.doe@email.com" },
+          "add_to_tag_list": "tag1, tag2",
+          "remove_from_tag_list": "tag3",
+          "tag_list": "tag1, tag2",
+          "custom_fields_values_attributes": [
+            { "id": "1", "custom_field_id": 1, "value": "content" }
+          ],
+          "incident_ids": [100],
+          "problem_ids": [100],
+          "itsm_change_ids": [100],
+          "release_ids": [100],
+          "purchase_order_ids":[100]
+        }
+      }
+    },
+    "response": {
+      "json": {
+        "configuration_item": {
+          "id": "10000",
+          "number": "1000",
+          "name": "Configuration Item Name",
+          "description": "description",
+          "asset_tag": "ConfigurationItemTag",
+          "type": {
+            "id": 1,
+            "name": "Building",
+            "description": "Configuration Item - Building",
+            "parent_id": 1,
+            "custom": false,
+            "updated_at": "2025-01-01T00:00:00.000+01:00",
+            "icon_name": "BUILDING"
+          },
+          "type_id": 1,
+          "state": "Active",
+          "site": {
+            "id": "1",
+            "name": "Austin TX, USA",
+            "location": "AUS",
+            "description": "",
+            "time_zone": ""
+          },
+          "department": {
+            "id": "1",
+            "name": "Support",
+            "description": "",
+            "default_assignee_id": "1"
+          },
+          "manager_id": {
+            "group_id": "1",
+            "is_user": "true",
+            "id":  "1",
+            "name": "John Doe",
+            "email": "john.doe@email.com",
+            "avatar": {
+              "type": "initials",
+              "color": "#fd4165",
+              "initials": "JD"
+            }
+          },
+          "user_id": {
+            "group_id": "1",
+            "is_user": "true",
+            "id":  "1",
+            "name": "Jane Doe",
+            "email": "jane.doe@email.com",
+            "avatar": {
+              "type": "initials",
+              "color": "#fd4165",
+              "initials": "JD"
+            }
+          },
+          "custom_fields_values": [
+            {
+              "id": "1000",
+              "custom_field_id": "1",
+              "name": "field name",
+              "value": "content",
+              "options": "",
+              "type_name": "Text"
+            }
+          ],
+          "updated_at": "2025-01-01T00:00:00.000+01:00",
+          "created_at": "2025-01-01T00:00:00.000+01:00",
+          "origin": "api",
+          "incidents": [{ "id": "100", "href": "https://mydomain.com/incidents/100"}],
+          "problems": [{ "id": "100", "href": "https://mydomain.com/problems/100"}],
+          "changes": [{ "id": "100", "href": "https://mydomain.com/changes/100"}],
+          "releases": [{ "id": "100", "href": "https://mydomain.com/releases/100"}],
+          "purchase_orders": [{ "id": "100", "href": "https://mydomain.com/releases/100"}]
+        }
+      }
+    }
+  }
+}

data/lib/definitions/common/examples/hardware.json

@@ -0,0 +1,125 @@
+{
+  "examples": {
+    "request": {
+      "hardware": {
+        "name": "Hardware Name",
+        "description": "description",
+        "category": { "name": "Laptop" },
+        "site_id": 1,
+        "department_id": 1,
+        "ip_address": "0.0.0.0",
+        "external_ip": "0.0.0.0",
+        "status": { "name": "Operational" },
+        "technical_contact": { "email": "john.doe@email.com" },
+        "owner": { "email": "john.doe@email.com" },
+        "notes": "Hardware notes",
+        "barcode_encoding_format": "Code1A",
+        "cpu": "hardware_cpu",
+        "processor_speed": "processor_speed",
+        "memory":1024,
+        "swap": "MB",
+        "operating_system": "Windows 10",
+        "domain": "domain description",
+        "active_directory": "Workgroup of the OS",
+        "address": "Site 1, Building 1, Department 1",
+        "longitude": "0.000",
+        "latitude":"0.000",
+        "product_number":"1",
+        "custom_fields_values_attributes": [
+          { "id": 10, "custom_field_id": 1, "value": "content" },
+          { "id": 100, "custom_field_id": 2, "value": "1" }
+        ],
+        "custom_fields_values": {
+          "custom_fields_value": [
+            { "name": "Text custom field", "value": "content" },
+            { "name": "User custom field", "user_value": { "email": "john.doe@email.com" } }
+          ]
+        },
+        "bio": {
+          "manufacturer":"Dell",
+          "ssn":"1",
+          "model":"model description",
+          "version":"1",
+          "bios_date":"2020-01-01 00:00"
+        },
+        "tag": "tag",
+        "asset_tag": 1
+      }
+    },
+    "response": {
+      "hardware": {
+        "id": 1,
+        "name": "Hardware Name",
+        "description": "description",
+        "category": { "id": 1, "name": "Laptop" },
+        "site": {
+            "id": "1",
+            "name": "Austin TX, USA",
+            "location": "AUS",
+            "description": "",
+            "time_zone": ""
+        },
+        "department": {
+            "id": "1",
+            "name": "Support",
+            "description": "",
+            "default_assignee_id": "1"
+        },
+        "ip": "0.0.0.0",
+        "external_ip": "0.0.0.0",
+        "status": { "name": "Operational" },
+        "technical_contact": { "email": "john.doe@email.com" },
+        "owner": { "email": "john.doe@email.com" },
+        "notes": "Hardware notes",
+        "barcode_encoding_format": "Code1A",
+        "cpu": "hardware_cpu",
+        "processor_speed": "processor_speed",
+        "memory":1024,
+        "swap": "MB",
+        "operating_system": "Windows 10",
+        "domain": "domain description",
+        "active_directory": "Workgroup of the OS",
+        "address": "Site 1, Building 1, Department 1",
+        "longitude": "0.000",
+        "latitude": "0.000",
+        "product_number": "1",
+        "custom_fields_values": [
+          {
+            "id": "10",
+            "custom_field_id": "1",
+            "name": "Text custom field",
+            "value": "content",
+            "options": "",
+            "type_name": "Text"
+          },
+          {
+            "id": "100",
+            "custom_field_id": "2",
+            "name": "User custom field",
+            "value": "1",
+            "options": "",
+            "type_name": "User",
+            "user": {
+              "group_id": 1,
+              "is_user": true,
+              "id": 1,
+              "name": "John Doe",
+              "email": "john.doe@email.com"
+            }
+          }
+        ],
+        "bioses": [{
+          "id": 1,
+          "manufacturer": "Dell",
+          "ssn": "1",
+          "model": "model description",
+          "version": "1",
+          "bios_date": "2020-01-01 00:00",
+          "reported_at": "2020-01-01 00:00"
+        }],
+        "tag": "tag",
+        "asset_tag": "1"
+      }
+    }
+  }
+}