solarwinds-itsm-api-definitions 0.1.3 → 0.1.8

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

@@ -0,0 +1,150 @@
+{
+  "examples": {
+    "request": {
+      "json": {
+        "release": {
+          "name": "Release Name",
+          "site_id": 1,
+          "department_id": 1,
+          "description": "description",
+          "state": 1,
+          "plan": "plan description" ,
+          "build": "build description",
+          "deploy": "deploy description",
+          "planned_start_at": "2025-01-01 00:00",
+          "planned_end_at": "2025-01-01 05:00" ,
+          "assignee": { "email": "john.doe@email.com" },
+          "requester": { "email": "john.doe@email.com" },
+          "priority": "High",
+          "add_to_tag_list": "tag1",
+          "remove_from_tag_list": "tag2",
+          "tag_list": "tag1",
+          "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" } }
+            ]
+          },
+          "approval_levels_attributes": [
+            { "id": "1", "approver_ids": "1", "approval_condition": "1" }
+          ],
+          "itsm_change_ids": [100],
+          "configuration_item_ids":[100]
+        }
+      }
+    },
+    "response": {
+      "json": {
+        "release": {
+          "id": "10000",
+          "number": "1000",
+          "name": "Release Name",
+          "description": "description",
+          "state": "New",
+          "plan": "plan description" ,
+          "build": "build description",
+          "deploy": "deploy description",
+          "planned_start_at": "2025-01-01T00:00:00.000+01:00",
+          "planned_end_at": "2025-01-01T05:00:00.000+01:00" ,
+          "site": {
+            "id": "1",
+            "name": "Austin TX, USA",
+            "location": "AUS",
+            "description": "Austin TX, USA"
+          },
+          "department": {
+            "id": "1",
+            "name": "Support",
+            "description": "Support Department",
+            "default_assignee_id": "1"
+          },
+          "priority": "High",
+          "created_by": {
+            "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"
+            }
+        },
+          "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"
+              }
+            }
+          ],
+          "tags": [{ "id": 1, "name": "tag1", "taggings_count": 1 }],
+          "approvers": [
+            {
+              "group_id": "1",
+              "is_user": "true",
+              "id":  "1",
+              "name": "John Doe",
+              "email": "john.doe@email.com",
+              "avatar": {
+                "type": "initials",
+                "color": "#fd4165",
+                "initials": "JD"
+              }
+            }
+          ],
+          "changes": [{ "id": "100", "href": "https://mydomain.com/changes/100"}],
+          "configuration_items": [{ "id": "100", "href": "https://mydomain.com/configuration_items/100"}]
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,28 @@
+{
+  "examples": {
+    "incident": {
+      "site_id": "1",
+      "department_id": "1",
+      "requester_name": "john.doe@email.com",
+      "priority": "High",
+      "due_at": "Jan 01,2025",
+      "add_to_tag_list": "tag1, tag2",
+      "remove_from_tag_list": "tag3",
+      "tag_list": "tag1, tag2",
+      "request_variables_attributes": [
+        {
+          "name": "Variable name",
+          "value": "Content"
+        },
+        {
+          "name": "User Variable",
+          "user_value": { "email": "john.doe@email.com" }
+        },
+        {
+          "name": "MultyPickList variable",
+          "value": "option1#dlmtr#option2"
+        }
+      ]
+    }
+  }
+}

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

@@ -0,0 +1,49 @@
+{
+  "examples": {
+    "request": {
+      "json": {
+        "solution": {
+          "name": "Solution Name",
+          "site_id": 1,
+          "department_id": 1,
+          "description": "description",
+          "state": "Approved",
+          "category": { "name": "Facilities" },
+          "subcategory": { "name": "Equipment" },
+          "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" } }
+            ]
+          },
+          "incident_ids": [100]
+        }
+      }
+    },
+    "response": {
+      "json": {
+        "solution": {
+          "id": "10000",
+          "number": "1000",
+          "name": "Solution Name",
+          "description": "description",
+          "created_at": "2025-01-01T00:00:00.000+01:00",
+          "creator": {
+            "id": "1",
+            "name": "John Doe",
+            "email": "john.doe@email.com"
+          },
+          "origin": "api",
+          "incidents": [{ "id": "100", "href": "https://mydomain.com/incidents/100"}]
+        }
+      }
+    }
+  }
+}

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

@@ -1,76 +1,106 @@
 {
-    "examples": {
-        "request": {
-            "json": {
-                "user": {
-                    "name": "John Doe",
-                    "email": "john.doe@email.com",
-                    "title": "Support Agent",
-                    "site": { "name": "AUS" },
-                    "department": { "name": "Support" },
-                    "role": { "name": "Requester" },
-                    "phone": "+10000000",
-                    "mobile_phone": "+10000000",
-                    "reports_to": { "email": "john.boe@email.com" },
-                    "custom_field_values": {
-                        "custom_field_value": [
-                            { "name": "field name", "value": "content" }
-                        ]
-                    }
-                }
+  "examples": {
+    "request": {
+      "json": {
+        "user": {
+          "name": "John Doe",
+          "email": "john.doe@email.com",
+          "title": "Support Agent",
+          "site": { "name": "AUS" },
+          "department": { "name": "Support" },
+          "role": { "name": "Requester" },
+          "phone": "+10000000",
+          "mobile_phone": "+10000000",
+          "reports_to": { "email": "jane.doe@email.com" },
+          "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" } }
+            ]
+          }
+        }
+      }
+    },
+    "response": {
+      "json": {
+        "user": {
+          "id": "10000",
+          "name": "John Doe",
+          "title": "Support Agent",
+          "disabled": false,
+          "email": "john.doe@email.com",
+          "created_at": "2030-01-01T00:00:00.000+00:00",
+          "phone": "+10000000",
+          "mobile_phone": "+10000000",
+          "site": {
+            "id": "1",
+            "name": "Austin TX, USA",
+            "location": "AUS",
+            "description": "",
+            "time_zone": ""
+          },
+          "department": {
+            "id": "1",
+            "name": "Support",
+            "description": "",
+            "default_assignee_id": "1"
+          },
+          "role": {
+            "id": 1,
+            "name": "Requester",
+            "description": "Requester role.",
+            "portal": true,
+            "show_my_tasks": true
+          },
+          "group_ids": [1],
+          "avatar": {
+            "type": "initials",
+            "color": "#fd4165",
+            "initials": "JD"
+          },
+          "reports_to": {
+            "group_id": "1",
+            "is_user": "true",
+            "id":  "100",
+            "name": "Jane Doe",
+            "email": "jane.doe@email.com",
+            "avatar": {
+                "type": "initials",
+                "color": "#fd4166",
+                "initials": "JD"
             }
-        },
-        "response": {
-            "json": {
-                "user": {
-                    "id": "10000",
-                    "name": "John Doe",
-                    "title": "Support Agent",
-                    "disabled": false,
-                    "email": "john.doe@email.com",
-                    "created_at": "2030-01-01T00:00:00.000+00:00",
-                    "phone": "+10000000",
-                    "mobile_phone": "+10000000",
-                    "site": {
-                        "id": "1",
-                        "name": "Austin TX, USA",
-                        "location": "AUS",
-                        "description": "",
-                        "time_zone": ""
-                    },
-                    "department": {
-                        "id": "1",
-                        "name": "Support",
-                        "description": "",
-                        "default_assignee_id": "1"
-                    },
-                    "role": {
-                        "id": 1,
-                        "name": "Requester",
-                        "description": "Requester role.",
-                        "portal": true,
-                        "show_my_tasks": true
-                    },
-                    "group_ids": [1],
-                    "avatar": {
-                        "type": "initials",
-                        "color": "#fd4165",
-                        "initials": "JD"
-                    },
-                    "reports_to": {
-                        "group_id": "1",
-                        "is_user": "true",
-                        "id":  "100",
-                        "name": "John Boe",
-                        "email": "john.boe@email.com",
-                        "avatar": {
-                            "type": "initials",
-                            "color": "#fd4166",
-                            "initials": "JB"
-                        }
-                    }
-                }
+          },
+          "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"
+              }
             }
+          ]
         }
+      }
     }
+  }
 }

data/lib/definitions/common/schemas/analytics/audit.json

@@ -0,0 +1,28 @@
+{
+  "components": {
+    "schemas": {
+      "response": {
+        "type": "object",
+        "xml": { "name": "/", "wrapped": true },
+        "properties": {
+          "audit": {
+            "type": "object",
+            "properties": {
+              "id": { "$ref": "../../components.json#/components/response/schemas/id" },
+              "message": { "type": "string", "example": "State changed from New to On Hold" },
+              "action": { "type": "string", "example": "Update" },
+              "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" },
+              "source_type": { "type": "string", "example": "Incident" },
+              "source_id": { "$ref": "../../components.json#/components/response/schemas/id" },
+              "user_id": { "$ref": "../../components.json#/components/response/schemas/id" },
+              "user": { "$ref": "../../components.json#/components/response/schemas/user_details" },
+              "site": { "$ref": "../../components.json#/components/response/schemas/site_response" },
+              "department": { "$ref": "../../components.json#/components/response/schemas/department_response" },
+              "note": { "type": "string", "example": "Audit note" }
+            }
+          }
+        }
+      }
+    }
+  }
+}

data/lib/definitions/common/schemas/analytics/risk.json

@@ -0,0 +1,28 @@
+{
+  "components": {
+    "schemas": {
+      "response": {
+        "type": "object",
+        "xml": { "name": "/", "wrapped": true },
+        "properties": {
+          "id": { "$ref": "../../components.json#/components/response/schemas/id" },
+          "name": { "type": "string", "example": "Risk name" },
+          "severity": { "type": "string", "example": "Medium" },
+          "category": { "type": "string", "example": "Inventory" },
+          "discarded": { "type": "boolean", "example": false },
+          "resolved": { "type": "boolean", "example": false },
+          "affected_assets": {
+            "type": "object",
+            "properties": {
+              "id": { "$ref": "../../components.json#/components/response/schemas/id" },
+              "name": { "type": "string", "example": "Computer name" },
+              "type": { "type": "string", "example": "Hardware" }
+            }
+          },
+          "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" },
+          "updated at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }
+        }
+      }
+    }
+  }
+}