losant_rest 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a8febd9df2e048e29e135b1db4c17e2132a6485
-  data.tar.gz: 78e7a33f4159244aedd42ea3b6c0defd5d4c078b
+  metadata.gz: 5d4984ce6e897781e101ef6a2b3ced5ef16aacbd
+  data.tar.gz: 864fe05a7e6190cbc4dd30d20ef780657407ae90
 SHA512:
-  metadata.gz: 63b50ed6cd120c8abfa915b45b074574f778d214a7c7461a5e48a14b61a40e0686ad6c0c1b640b7e034f90ec40e33ccc5138a35955aad5ca15273db17a89e2ac
-  data.tar.gz: 4ddf7b70d5ae181504c00cd5bc0febaa458951d3fb98d2a9a65ab2fd37833c6e50a955f0675ae8fef76ba9aab20c7491c9b08cdf905743d011f1864e02df6fe3
+  metadata.gz: 7df3f9e14c6fa970baa3133f9a5c5bdc9918bb7d051da7a0f5ed26b58bd5bd20e1b3c6b199f0364404029e49315f7c979fc825363e1a3ce7fb17838b588dad41
+  data.tar.gz: da6d8dbda68b947a5d5e5b706439819ced07073a2a11f556ef87f14348a0ccd480244c967e3477d3552e2476049b1ebe9bf69513a6dd8dfd109c3e4b48e9bc76

data/docs/_schemas.md

@@ -13,6 +13,7 @@
 *   [Application Post](#application-post)
 *   [Applications](#applications)
 *   [Authenticated Device](#authenticated-device)
+*   [Authenticated Solution User](#authenticated-solution-user)
 *   [Authenticated User](#authenticated-user)
 *   [Dashboard](#dashboard)
 *   [Dashboard Patch](#dashboard-patch)
@@ -64,6 +65,15 @@
 *   [Organizations](#organizations)
 *   [Recent Item](#recent-item)
 *   [Recent Item List](#recent-item-list)
+*   [Solution](#solution)
+*   [Solution Patch](#solution-patch)
+*   [Solution Post](#solution-post)
+*   [Solution User](#solution-user)
+*   [User Credentials](#user-credentials)
+*   [Solution User Patch](#solution-user-patch)
+*   [Solution User Post](#solution-user-post)
+*   [Solution Users](#solution-users)
+*   [Solutions](#solutions)
 *   [Success](#success)
 *   [Time Series Data](#time-series-data)
 *   [Time Series Query](#time-series-query)
@@ -1056,6 +1066,43 @@ Schema for the sucessful response when authenticating a Device
 
 <br/>
 
+## Authenticated Solution User
+
+Schema for the sucessful response when authenticating a Solution User
+
+### <a name="authenticated-solution-user-schema"></a> Schema
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "solutionUserId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "token": {
+      "type": "string",
+      "minLength": 1
+    }
+  },
+  "required": [
+    "solutionUserId",
+    "token"
+  ]
+}
+```
+### <a name="authenticated-solution-user-example"></a> Example
+
+```json
+{
+  "solutionUserId": "566116085df4b701000258e3",
+  "token": "token_to_use_for_authenticating_subsequent_requests"
+}
+```
+
+<br/>
+
 ## Authenticated User
 
 Schema for the sucessful response when authenticating a User
@@ -5125,6 +5172,9 @@ Schema for a single Organization
       "type": "string",
       "maxLength": 32767
     },
+    "solutionsEnabled": {
+      "type": "boolean"
+    },
     "members": {
       "type": "array",
       "items": {
@@ -5475,6 +5525,9 @@ Schema for a collection of Organizations
             "type": "string",
             "maxLength": 32767
           },
+          "solutionsEnabled": {
+            "type": "boolean"
+          },
           "members": {
             "type": "array",
             "items": {
@@ -5715,6 +5768,955 @@ Schema for an array of recent items
 
 <br/>
 
+## Solution
+
+Schema for a single Solution
+
+### <a name="solution-schema"></a> Schema
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "solutionId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "orgId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "creationDate": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "lastUpdated": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "description": {
+      "type": "string",
+      "maxLength": 32767
+    },
+    "slug": {
+      "type": "string",
+      "pattern": "^[0-9a-z_-]{1,255}$"
+    },
+    "allowSelfDeletion": {
+      "type": "boolean"
+    },
+    "allowSelfEmailChange": {
+      "type": "boolean"
+    },
+    "passwordReset": {
+      "type": "object",
+      "properties": {
+        "allowPasswordReset": {
+          "type": "boolean"
+        },
+        "emailSubject": {
+          "type": "string",
+          "maxLength": 255
+        },
+        "emailBody": {
+          "type": "string",
+          "maxLength": 32767
+        },
+        "emailFrom": {
+          "type": "string",
+          "format": "email",
+          "maxLength": 1024
+        }
+      }
+    },
+    "summary": {
+      "type": "object",
+      "properties": {
+        "solutionUserCount": {
+          "type": "number"
+        }
+      }
+    }
+  }
+}
+```
+### <a name="solution-example"></a> Example
+
+```json
+{
+  "id": "57955788124b37010084c053",
+  "solutionId": "57955788124b37010084c053",
+  "orgId": "575ed6e87ae143cd83dc4aa8",
+  "creationDate": "2016-06-13T04:00:00.000Z",
+  "lastUpdated": "2016-06-13T04:00:00.000Z",
+  "name": "My Solution",
+  "slug": "my_solution",
+  "allowSelfDeletion": false,
+  "allowSelfEmailChange": false,
+  "summary": {
+    "solutionUserCount": 0
+  }
+}
+```
+
+<br/>
+
+## Solution Patch
+
+Schema for the body of a Solution modification request
+
+### <a name="solution-patch-schema"></a> Schema
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "description": {
+      "type": "string",
+      "maxLength": 32767
+    },
+    "slug": {
+      "type": "string",
+      "pattern": "^[0-9a-z_-]{1,255}$"
+    },
+    "allowSelfDeletion": {
+      "type": "boolean"
+    },
+    "allowSelfEmailChange": {
+      "type": "boolean"
+    },
+    "passwordReset": {
+      "type": "object",
+      "properties": {
+        "allowPasswordReset": {
+          "type": "boolean"
+        },
+        "emailSubject": {
+          "type": "string",
+          "maxLength": 255
+        },
+        "emailBody": {
+          "type": "string",
+          "maxLength": 32767
+        },
+        "emailFrom": {
+          "type": "string",
+          "format": "email",
+          "maxLength": 1024
+        }
+      },
+      "additionalProperties": false
+    },
+    "additionalProperties": false
+  }
+}
+```
+### <a name="solution-patch-example"></a> Example
+
+```json
+{
+  "name": "My Updated Solution",
+  "allowSelfDeletion": true
+}
+```
+
+<br/>
+
+## Solution Post
+
+Schema for the body of a Solution creation request
+
+### <a name="solution-post-schema"></a> Schema
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "description": {
+      "type": "string",
+      "maxLength": 32767
+    },
+    "slug": {
+      "type": "string",
+      "pattern": "^[0-9a-z_-]{1,255}$"
+    },
+    "allowSelfDeletion": {
+      "type": "boolean"
+    },
+    "allowSelfEmailChange": {
+      "type": "boolean"
+    },
+    "passwordReset": {
+      "type": "object",
+      "properties": {
+        "allowPasswordReset": {
+          "type": "boolean"
+        },
+        "emailSubject": {
+          "type": "string",
+          "maxLength": 255
+        },
+        "emailBody": {
+          "type": "string",
+          "maxLength": 32767
+        },
+        "emailFrom": {
+          "type": "string",
+          "format": "email",
+          "maxLength": 1024
+        }
+      },
+      "additionalProperties": false
+    },
+    "required": [
+      "name",
+      "slug"
+    ],
+    "additionalProperties": false
+  }
+}
+```
+### <a name="solution-post-example"></a> Example
+
+```json
+{
+  "name": "My New Solution",
+  "slug": "my_new_solution"
+}
+```
+
+<br/>
+
+## Solution User
+
+Schema for a single Solution User
+
+### <a name="solution-user-schema"></a> Schema
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "solutionUserId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "solutionId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "orgId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "creationDate": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "lastUpdated": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "passwordLastUpdated": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "lastLogin": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "email": {
+      "type": "string",
+      "format": "email",
+      "maxLength": 1024
+    },
+    "firstName": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024
+    },
+    "lastName": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024
+    },
+    "companyName": {
+      "type": "string",
+      "maxLength": 1024
+    },
+    "phoneNumber": {
+      "type": "string",
+      "maxLength": 1024
+    },
+    "location": {
+      "type": "string",
+      "maxLength": 1024
+    },
+    "url": {
+      "type": "string",
+      "maxLength": 1024
+    },
+    "forcePasswordResetOnNextLogin": {
+      "type": "boolean"
+    },
+    "fullName": {
+      "type": "string"
+    },
+    "twoFactorAuthEnabled": {
+      "type": "boolean"
+    },
+    "avatarUrl": {
+      "type": "string",
+      "format": "url"
+    },
+    "accessRestrictions": {
+      "type": "object",
+      "properties": {
+        "dashboardIds": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          }
+        }
+      }
+    }
+  }
+}
+```
+### <a name="solution-user-example"></a> Example
+
+```json
+{
+  "id": "566116085df4b701000258e3",
+  "solutionUserId": "566116085df4b701000258e3",
+  "solutionId": "57955788124b37010084c053",
+  "orgId": "575ed6e87ae143cd83dc4aa8",
+  "creationDate": "2016-06-13T04:00:00.000Z",
+  "lastUpdated": "2016-06-13T04:00:00.000Z",
+  "passwordLastUpdated": "2016-06-13T04:00:00.000Z",
+  "lastLogin": "2016-06-13T04:00:00.000Z",
+  "email": "example@solutionuser.com",
+  "firstName": "Example",
+  "lastName": "Name",
+  "forcePasswordResetOnNextLogin": false,
+  "fullName": "Example Name",
+  "twoFactorAuthEnabled": false,
+  "avatarUrl": "https://example.avatar.url/is_here.png",
+  "accessRestrictions": {
+    "dashboardIds": [
+      "575ece2b7ae143cd83dc4a9b",
+      "575ece2b7ae143cd83dc4a9c"
+    ]
+  }
+}
+```
+
+<br/>
+
+## User Credentials
+
+Schema for the body of a Solution User authentication request
+
+### <a name="user-credentials-schema"></a> Schema
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "solutionId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "email": {
+      "type": "string",
+      "format": "email",
+      "maxLength": 1024
+    },
+    "password": {
+      "type": "string",
+      "minLength": 8,
+      "maxLength": 2048
+    },
+    "twoFactorCode": {
+      "type": "string",
+      "maxLength": 2048
+    }
+  },
+  "required": [
+    "solutionId",
+    "email",
+    "password"
+  ],
+  "additionalProperties": false
+}
+```
+### <a name="user-credentials-example"></a> Example
+
+```json
+{
+  "solutionId": "57955788124b37010084c053",
+  "email": "example@solutionuser.com",
+  "password": "this is the password"
+}
+```
+
+<br/>
+
+## Solution User Patch
+
+Schema for the body of a Solution User modification request
+
+### <a name="solution-user-patch-schema"></a> Schema
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "email": {
+      "type": "string",
+      "format": "email",
+      "maxLength": 1024
+    },
+    "firstName": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024
+    },
+    "lastName": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024
+    },
+    "companyName": {
+      "type": "string",
+      "maxLength": 1024
+    },
+    "phoneNumber": {
+      "type": "string",
+      "maxLength": 1024
+    },
+    "location": {
+      "type": "string",
+      "maxLength": 1024
+    },
+    "url": {
+      "type": "string",
+      "maxLength": 1024
+    },
+    "forcePasswordResetOnNextLogin": {
+      "type": "boolean"
+    },
+    "password": {
+      "type": "string",
+      "minLength": 8,
+      "maxLength": 2048
+    },
+    "twoFactorAuthKey": {
+      "type": "string",
+      "minLength": 52,
+      "maxLength": 52
+    },
+    "accessRestrictions": {
+      "type": "object",
+      "properties": {
+        "dashboardIds": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          }
+        },
+        "additionalProperties": false
+      }
+    }
+  },
+  "additionalProperties": false
+}
+```
+### <a name="solution-user-patch-example"></a> Example
+
+```json
+{
+  "password": "aNewUserPassword",
+  "forcePasswordResetOnNextLogin": true
+}
+```
+
+<br/>
+
+## Solution User Post
+
+Schema for the body of a Solution User creation request
+
+### <a name="solution-user-post-schema"></a> Schema
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "email": {
+      "type": "string",
+      "format": "email",
+      "maxLength": 1024
+    },
+    "firstName": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024
+    },
+    "lastName": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024
+    },
+    "companyName": {
+      "type": "string",
+      "maxLength": 1024
+    },
+    "phoneNumber": {
+      "type": "string",
+      "maxLength": 1024
+    },
+    "location": {
+      "type": "string",
+      "maxLength": 1024
+    },
+    "url": {
+      "type": "string",
+      "maxLength": 1024
+    },
+    "forcePasswordResetOnNextLogin": {
+      "type": "boolean"
+    },
+    "password": {
+      "type": "string",
+      "minLength": 8,
+      "maxLength": 2048
+    },
+    "twoFactorAuthKey": {
+      "type": "string",
+      "minLength": 52,
+      "maxLength": 52
+    },
+    "accessRestrictions": {
+      "type": "object",
+      "properties": {
+        "dashboardIds": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          }
+        },
+        "additionalProperties": false
+      }
+    }
+  },
+  "required": [
+    "email",
+    "firstName",
+    "lastName",
+    "password"
+  ],
+  "additionalProperties": false
+}
+```
+### <a name="solution-user-post-example"></a> Example
+
+```json
+{
+  "email": "example@solutionuser.com",
+  "firstName": "Example",
+  "lastName": "Name",
+  "password": "aUserPassword",
+  "accessRestrictions": {
+    "dashboardIds": [
+      "575ece2b7ae143cd83dc4a9b",
+      "575ece2b7ae143cd83dc4a9c"
+    ]
+  }
+}
+```
+
+<br/>
+
+## Solution Users
+
+Schema for a collection of Solution Users
+
+### <a name="solution-users-schema"></a> Schema
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "items": {
+      "type": "array",
+      "items": {
+        "title": "Solution User",
+        "description": "Schema for a single Solution User",
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "solutionUserId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "solutionId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "orgId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "creationDate": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "lastUpdated": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "passwordLastUpdated": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "lastLogin": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "email": {
+            "type": "string",
+            "format": "email",
+            "maxLength": 1024
+          },
+          "firstName": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 1024
+          },
+          "lastName": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 1024
+          },
+          "companyName": {
+            "type": "string",
+            "maxLength": 1024
+          },
+          "phoneNumber": {
+            "type": "string",
+            "maxLength": 1024
+          },
+          "location": {
+            "type": "string",
+            "maxLength": 1024
+          },
+          "url": {
+            "type": "string",
+            "maxLength": 1024
+          },
+          "forcePasswordResetOnNextLogin": {
+            "type": "boolean"
+          },
+          "fullName": {
+            "type": "string"
+          },
+          "twoFactorAuthEnabled": {
+            "type": "boolean"
+          },
+          "avatarUrl": {
+            "type": "string",
+            "format": "url"
+          },
+          "accessRestrictions": {
+            "type": "object",
+            "properties": {
+              "dashboardIds": {
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "pattern": "^[A-Fa-f\\d]{24}$"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "count": {
+      "type": "integer"
+    },
+    "totalCount": {
+      "type": "integer"
+    },
+    "perPage": {
+      "type": "integer"
+    },
+    "page": {
+      "type": "integer"
+    },
+    "filter": {
+      "type": "string"
+    },
+    "filterField": {
+      "type": "string"
+    },
+    "sortField": {
+      "type": "string"
+    },
+    "sortDirection": {
+      "type": "string",
+      "enum": [
+        "asc",
+        "desc"
+      ]
+    },
+    "orgId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "solutionId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    }
+  }
+}
+```
+### <a name="solution-users-example"></a> Example
+
+```json
+{
+  "items": [
+    {
+      "id": "566116085df4b701000258e3",
+      "solutionUserId": "566116085df4b701000258e3",
+      "solutionId": "57955788124b37010084c053",
+      "orgId": "575ed6e87ae143cd83dc4aa8",
+      "creationDate": "2016-06-13T04:00:00.000Z",
+      "lastUpdated": "2016-06-13T04:00:00.000Z",
+      "passwordLastUpdated": "2016-06-13T04:00:00.000Z",
+      "lastLogin": "2016-06-13T04:00:00.000Z",
+      "email": "example@solutionuser.com",
+      "firstName": "Example",
+      "lastName": "Name",
+      "forcePasswordResetOnNextLogin": false,
+      "fullName": "Example Name",
+      "twoFactorAuthEnabled": false,
+      "avatarUrl": "https://example.avatar.url/is_here.png",
+      "accessRestrictions": {
+        "dashboardIds": [
+          "575ece2b7ae143cd83dc4a9b",
+          "575ece2b7ae143cd83dc4a9c"
+        ]
+      }
+    }
+  ],
+  "count": 1,
+  "totalCount": 4,
+  "perPage": 1,
+  "page": 0,
+  "sortField": "name",
+  "sortDirection": "asc",
+  "solutionId": "57955788124b37010084c053",
+  "orgId": "575ed6e87ae143cd83dc4aa8"
+}
+```
+
+<br/>
+
+## Solutions
+
+Schema for a collection of Solutions
+
+### <a name="solutions-schema"></a> Schema
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "items": {
+      "type": "array",
+      "items": {
+        "title": "Solution",
+        "description": "Schema for a single Solution",
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "solutionId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "orgId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "creationDate": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "lastUpdated": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "name": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 255
+          },
+          "description": {
+            "type": "string",
+            "maxLength": 32767
+          },
+          "slug": {
+            "type": "string",
+            "pattern": "^[0-9a-z_-]{1,255}$"
+          },
+          "allowSelfDeletion": {
+            "type": "boolean"
+          },
+          "allowSelfEmailChange": {
+            "type": "boolean"
+          },
+          "passwordReset": {
+            "type": "object",
+            "properties": {
+              "allowPasswordReset": {
+                "type": "boolean"
+              },
+              "emailSubject": {
+                "type": "string",
+                "maxLength": 255
+              },
+              "emailBody": {
+                "type": "string",
+                "maxLength": 32767
+              },
+              "emailFrom": {
+                "type": "string",
+                "format": "email",
+                "maxLength": 1024
+              }
+            }
+          },
+          "summary": {
+            "type": "object",
+            "properties": {
+              "solutionUserCount": {
+                "type": "number"
+              }
+            }
+          }
+        }
+      }
+    },
+    "count": {
+      "type": "integer"
+    },
+    "totalCount": {
+      "type": "integer"
+    },
+    "perPage": {
+      "type": "integer"
+    },
+    "page": {
+      "type": "integer"
+    },
+    "filter": {
+      "type": "string"
+    },
+    "filterField": {
+      "type": "string"
+    },
+    "sortField": {
+      "type": "string"
+    },
+    "sortDirection": {
+      "type": "string",
+      "enum": [
+        "asc",
+        "desc"
+      ]
+    },
+    "orgId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    }
+  }
+}
+```
+### <a name="solutions-example"></a> Example
+
+```json
+{
+  "items": [
+    {
+      "id": "57955788124b37010084c053",
+      "solutionId": "57955788124b37010084c053",
+      "orgId": "575ed6e87ae143cd83dc4aa8",
+      "creationDate": "2016-06-13T04:00:00.000Z",
+      "lastUpdated": "2016-06-13T04:00:00.000Z",
+      "name": "My Solution",
+      "slug": "my_solution",
+      "allowSelfDeletion": false,
+      "allowSelfEmailChange": false,
+      "summary": {
+        "solutionUserCount": 0
+      }
+    }
+  ],
+  "count": 1,
+  "totalCount": 4,
+  "perPage": 1,
+  "page": 0,
+  "sortField": "name",
+  "sortDirection": "asc",
+  "orgId": "575ed6e87ae143cd83dc4aa8"
+}
+```
+
+<br/>
+
 ## Success
 
 Schema for reporting a successful operation