solarwinds-itsm-api-definitions 0.1.3 → 0.1.8

data/lib/definitions/common/schemas/service_desk/solution.json

@@ -0,0 +1,61 @@
+{
+    "components": {
+      "schemas": {
+        "request": {
+          "post": {
+            "type": "object",
+            "xml": { "name": "/" },
+            "properties": {
+              "solution": {
+                "type": "object",
+                "required": ["name"],
+                "properties": { "$ref": "solution.json#/components/schemas/request_properties" }
+              }
+            }
+          },
+          "put": {
+            "type": "object",
+            "xml": { "name": "/" },
+            "properties": {
+              "solution": {
+                "type": "object",
+                "properties": { "$ref": "solution.json#/components/schemas/request_properties" }
+              }
+            }
+          }
+        },
+        "request_properties": {
+          "name": { "type": "string", "example": "Solution Name" },
+          "site_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
+          "department_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
+          "description": { "type": "string", "example": "description" },
+          "state": { "type": "string", "example": "Approved" },
+          "category": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
+          "subcategory": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
+          "add_to_tag_list": { "type": "string", "example": "tag1, tag2" },
+          "remove_from_tag_list": { "type": "string", "example": "tag3" },
+          "tag_list": { "type": "string", "example": "tag1, tag2" },
+          "custom_fields_values": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values" },
+          "custom_fields_values_attributes": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values_attributes" },
+          "incident_ids": { "$ref": "../../components.json#/components/common/schemas/ids_array" }
+        },
+        "response": {
+          "type": "object",
+          "xml": { "name": "/", "wrapped": true },
+          "properties": {
+            "solution": {
+              "type": "object",
+              "properties": {
+                "id": { "$ref": "../../components.json#/components/response/schemas/id" },
+                "name": { "type": "string", "example": "Solution Name" },
+                "description": { "type": "string", "example": "description" },
+                "creator": { "$ref": "../../components.json#/components/response/schemas/creator" },
+                "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" },
+                "origin": { "type": "string", "example": "api" }
+              }
+            }
+          }
+        }
+      }
+    }
+  }

data/lib/definitions/common/schemas/service_desk/time_track.json

@@ -0,0 +1,37 @@
+{
+  "components": {
+    "schemas": {
+      "request": {
+        "type": "object",
+        "xml": { "name": "/" },
+        "properties": {
+          "time_track": {
+            "type": "object",
+            "properties": {
+              "name": { "type": "string", "example": "Time Track Name" },
+              "minutes_parsed": { "type": "string", "example": "2h" }
+            }
+          }
+        }
+      },
+      "response": {
+        "type": "object",
+        "xml": { "name": "/", "wrapped": true },
+        "properties": {
+          "time_track": {
+            "type": "object",
+            "properties": {
+              "id": { "$ref": "../../components.json#/components/response/schemas/id" },
+              "name": { "type": "string", "example": "Time Track Name" },
+              "minutes": { "type": "string", "example": "120" },
+              "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" },
+              "creator": { "$ref": "../../components.json#/components/response/schemas/user_details" },
+              "parent": { "$ref": "../../components.json#/components/response/schemas/parent_object" }
+            }
+          }
+        }
+      }
+    }
+  }
+}

data/lib/definitions/common/schemas/setup/category.json

@@ -0,0 +1,54 @@
+{
+  "components": {
+    "schemas": {
+      "request": {
+        "post": {
+          "type": "object",
+          "xml": { "name": "/" },
+          "properties": {
+            "category": {
+              "type": "object",
+              "required": ["name"],
+              "properties": { "$ref": "category.json#/components/schemas/request_properties" }
+            }
+          }
+        },
+        "put": {
+          "type": "object",
+          "xml": { "name": "/" },
+          "properties": {
+            "category": {
+              "type": "object",
+              "properties": { "$ref": "category.json#/components/schemas/request_properties" }
+            }
+          }
+        }
+      },
+      "request_properties": {
+        "name": { "type": "string", "example": "Equipment" },
+        "parent": {
+          "$ref": "../../components.json#/components/request/schemas/association_by_name",
+          "example": { "name": "Facilities" }
+        },
+        "default_assignee_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
+        "default_tags": { "type": "string", "example": "equipment" }
+      },
+      "response": {
+        "type": "object",
+        "xml": { "name": "/", "wrapped": true },
+        "properties": {
+          "category": {
+            "type": "object",
+            "properties": {
+              "id": { "$ref": "../../components.json#/components/response/schemas/id" },
+              "name": { "type": "string", "example": "Equipment" },
+              "parent_id": { "$ref": "../../components.json#/components/response/schemas/id" },
+              "default_tags": { "type": "string", "example": "equipment" },
+              "default_assignee_id": { "$ref": "../../components.json#/components/response/schemas/id" }
+            }
+          }
+        }
+      }
+    }
+  }
+}

data/lib/definitions/common/schemas/setup/department.json

@@ -0,0 +1,48 @@
+{
+  "components": {
+    "schemas": {
+      "request": {
+        "post": {
+          "type": "object",
+          "xml": { "name": "/" },
+          "properties": {
+            "department": {
+              "type": "object",
+              "required": ["name"],
+              "properties": { "$ref": "department.json#/components/schemas/request_properties" }
+            }
+          }
+        },
+        "put": {
+          "type": "object",
+          "xml": { "name": "/" },
+          "properties": {
+            "department": {
+              "type": "object",
+              "properties": { "$ref": "department.json#/components/schemas/request_properties" }
+            }
+          }
+        }
+      },
+      "request_properties": {
+        "name": { "type": "string", "example": "Support" },
+        "description": { "type": "string", "example": "Support Department" }
+      },
+      "response": {
+        "type": "object",
+        "xml": { "name": "/", "wrapped": true },
+        "properties": {
+          "department": {
+            "type": "object",
+            "required": ["name"],
+            "properties": {
+              "id": { "$ref": "../../components.json#/components/response/schemas/id" },
+              "name": { "type": "string", "example": "Support" },
+              "description": { "type": "string", "example": "Support Department" }
+            }
+          }
+        }
+      }
+    }
+  }
+}

data/lib/definitions/common/schemas/setup/group.json

@@ -0,0 +1,65 @@
+{
+  "components": {
+    "schemas": {
+      "request": {
+        "post": {
+          "type": "object",
+          "xml": { "name": "/" },
+          "properties": {
+            "group": {
+              "type": "object",
+              "required": ["name"],
+              "properties": { "$ref": "group.json#/components/schemas/request_properties" }
+            }
+          }
+        },
+        "put": {
+          "type": "object",
+          "xml": { "name": "/" },
+          "properties": {
+            "group": {
+              "type": "object",
+              "properties": { "$ref": "group.json#/components/schemas/request_properties" }
+            }
+          }
+        }
+      },
+      "request_properties": {
+        "name": { "type": "string", "example": "Group Name" },
+        "description": { "type": "string", "example": "Group Description" },
+        "superviser_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
+        "custom_fields_values": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values" },
+        "custom_fields_values_attributes": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values_attributes" }
+      },
+      "response": {
+        "type": "object",
+        "xml": { "name": "/", "wrapped": true },
+        "properties": {
+          "group": {
+            "type": "object",
+            "required": ["name"],
+            "properties": {
+              "id": { "$ref": "../../components.json#/components/response/schemas/id" },
+              "name": { "type": "string", "example": "Group Name" },
+              "description": { "type": "string", "example": "Group Description" },
+              "is_user": { "type": "boolean", "example": false },
+              "reports_to": { "$ref": "../../components.json#/components/response/schemas/group_details" },
+              "avatar": { "$ref": "../../components.json#/components/response/schemas/avatar" },
+              "send_notifications": { "type": "boolean", "example": true },
+              "memberships": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "id": { "$ref": "../../components.json#/components/response/schemas/id" },
+                    "user": { "type": "string", "example": "John Doe" }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

data/lib/definitions/common/schemas/setup/role.json

@@ -0,0 +1,51 @@
+{
+  "components": {
+    "schemas": {
+      "request": {
+        "post": {
+          "type": "object",
+          "xml": { "name": "/" },
+          "properties": {
+            "role": {
+              "type": "object",
+              "required": ["name"],
+              "properties": { "$ref": "role.json#/components/schemas/request_properties" }
+            }
+          }
+        },
+        "put": {
+          "type": "object",
+          "xml": { "name": "/" },
+          "properties": {
+            "role": {
+              "type": "object",
+              "properties": { "$ref": "role.json#/components/schemas/request_properties" }
+            }
+          }
+        }
+      },
+      "request_properties": {
+        "name": { "type": "string", "example": "Support Agent" },
+        "description": { "type": "string", "example": "Support Agent role" },
+        "portal": { "type": "boolean", "example": true }
+      },
+      "response": {
+        "type": "object",
+        "xml": { "name": "/", "wrapped": true },
+        "properties": {
+          "role": {
+            "type": "object",
+            "required": ["name"],
+            "properties": {
+              "id": { "$ref": "../../components.json#/components/response/schemas/id" },
+              "name": { "type": "string", "example": "Support Agent" },
+              "description": { "type": "string", "example": "Support Agent role" },
+              "portal": { "type": "boolean", "example": true },
+              "show_my_tasks": { "type": "boolean", "example": false }
+            }
+          }
+        }
+      }
+    }
+  }
+}

data/lib/definitions/common/schemas/setup/site.json

@@ -0,0 +1,64 @@
+{
+  "components": {
+    "schemas": {
+      "request": {
+        "post": {
+          "type": "object",
+          "xml": { "name": "/" },
+          "properties": {
+            "site": {
+              "type": "object",
+              "required": ["name", "location"],
+              "properties": { "$ref": "site.json#/components/schemas/request_properties" }
+            }
+          }
+        },
+        "put": {
+          "type": "object",
+          "xml": { "name": "/" },
+          "properties": {
+            "site": {
+              "type": "object",
+              "properties": { "$ref": "site.json#/components/schemas/request_properties" }
+            }
+          }
+        }
+      },
+      "request_properties": {
+        "name": { "type": "string", "example": "Austin TX, USA" },
+        "location": { "type": "string", "example": "AUS" },
+        "description": { "type": "string", "example": "Description Austin TX, USA" },
+        "time_zone": { "type": "string", "example": "Texas" },
+        "language": { "type": "string", "minLength": 2, "maxLength": 2, "example": "en" },
+        "manager_id": {
+          "$ref": "../../components.json#/components/common/schemas/association_by_id",
+          "description": "user only, not group"
+        },
+        "default_assignee_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
+        "business_record": {
+          "type": "object",
+          "properties": { "id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" } }
+        }
+      },
+      "response": {
+        "type": "object",
+        "xml": { "name": "/", "wrapped": true },
+        "properties": {
+          "site": {
+            "type": "object",
+            "required": ["name"],
+            "properties": {
+              "id": { "$ref": "../../components.json#/components/response/schemas/id" },
+              "name": { "type": "string", "example": "Austin TX, USA" },
+              "location": { "type": "string", "example": "AUS" },
+              "description": { "type": "string", "example": "Description Austin TX, USA" },
+              "time_zone": { "type": "string", "example": "Texas" },
+              "language": { "type": "string", "minLength": 2, "maxLength": 2, "example": "en" },
+              "business_record": { "type": "string", "example": "1" }
+            }
+          }
+        }
+      }
+    }
+  }
+}

data/lib/definitions/common/schemas/setup/user.json

@@ -0,0 +1,67 @@
+{
+  "components": {
+    "schemas": {
+      "request": {
+        "post": {
+          "type": "object",
+          "xml": { "name": "/" },
+          "properties": {
+            "user": {
+              "type": "object",
+              "required": ["name", "email"],
+              "properties": { "$ref": "user.json#/components/schemas/request_properties" }
+            }
+          }
+        },
+        "put": {
+          "type": "object",
+          "xml": { "name": "/" },
+          "properties": {
+            "user": {
+              "type": "object",
+              "properties": { "$ref": "user.json#/components/schemas/request_properties" }
+            }
+          }
+        }
+      },
+      "request_properties": {
+        "name": { "type": "string", "example": "John Doe" },
+        "title": { "type": "string", "example": "Support Agent" },
+        "email": { "type": "string", "format": "email", "example": "john.doe@email.com" },
+        "disabled": { "type": "boolean", "example": false },
+        "phone": { "type": "string", "example": "+10000000" },
+        "mobile_phone": { "type": "string", "example": "+10000000" },
+        "role": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
+        "site": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
+        "department": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
+        "reports_to": { "$ref": "../../components.json#/components/request/schemas/reports_to" },
+        "custom_fields_values": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values" }
+      },
+      "response": {
+        "type": "object",
+        "xml": { "name": "/", "wrapped": true },
+        "properties": {
+          "user": {
+            "type": "object",
+            "properties": {
+              "id": { "$ref": "../../components.json#/components/response/schemas/id" },
+              "name": { "type": "string", "example": "John Doe" },
+              "title": { "type": "string", "example": "Support Agent" },
+              "email": { "type": "string", "format": "email", "example": "john.doe@email.com" },
+              "phone": { "type": "string", "example": "+10000000" },
+              "mobile_phone": { "type": "string", "example": "+10000000" },
+              "role": { "$ref": "../../components.json#/components/response/schemas/role" },
+              "site": { "$ref": "../../components.json#/components/response/schemas/site_response" },
+              "department": { "$ref": "../../components.json#/components/response/schemas/department_response" },
+              "custom_fields_values": { "$ref": "../../components.json#/components/response/schemas/custom_fields_values" },
+              "avatar": { "$ref": "../../components.json#/components/response/schemas/avatar" },
+              "reports_to": { "$ref": "../../components.json#/components/response/schemas/group_details" },
+              "group_ids": { "$ref": "../../components.json#/components/common/schemas/ids_array" },
+              "created_at": { "type": "string", "example": "2020-01-01T00:00:00.000+00:00" }
+            }
+          }
+        }
+      }
+    }
+  }
+}