losant_rest 1.8.7 → 1.8.9

Sign up to get free protection for your applications and to get access to all the features.
Files changed (167) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +38618 -21196
  3. data/docs/application.md +76 -0
  4. data/docs/auth.md +0 -36
  5. data/docs/dashboards.md +1 -1
  6. data/docs/dataTableRows.md +2 -2
  7. data/docs/device.md +1 -0
  8. data/docs/events.md +81 -0
  9. data/docs/file.md +43 -0
  10. data/docs/me.md +50 -13
  11. data/lib/losant_rest.rb +0 -4
  12. data/lib/losant_rest/application.rb +90 -0
  13. data/lib/losant_rest/application_api_token.rb +2 -0
  14. data/lib/losant_rest/application_api_tokens.rb +2 -0
  15. data/lib/losant_rest/application_certificate.rb +2 -0
  16. data/lib/losant_rest/application_certificate_authorities.rb +2 -0
  17. data/lib/losant_rest/application_certificate_authority.rb +2 -0
  18. data/lib/losant_rest/application_certificates.rb +2 -0
  19. data/lib/losant_rest/application_key.rb +2 -0
  20. data/lib/losant_rest/application_keys.rb +2 -0
  21. data/lib/losant_rest/applications.rb +2 -0
  22. data/lib/losant_rest/audit_log.rb +2 -0
  23. data/lib/losant_rest/audit_logs.rb +2 -0
  24. data/lib/losant_rest/auth.rb +2 -42
  25. data/lib/losant_rest/client.rb +2 -18
  26. data/lib/losant_rest/dashboard.rb +2 -0
  27. data/lib/losant_rest/dashboards.rb +3 -1
  28. data/lib/losant_rest/data.rb +2 -0
  29. data/lib/losant_rest/data_table.rb +2 -0
  30. data/lib/losant_rest/data_table_row.rb +2 -0
  31. data/lib/losant_rest/data_table_rows.rb +4 -2
  32. data/lib/losant_rest/data_tables.rb +2 -0
  33. data/lib/losant_rest/device.rb +4 -0
  34. data/lib/losant_rest/device_recipe.rb +2 -0
  35. data/lib/losant_rest/device_recipes.rb +2 -0
  36. data/lib/losant_rest/devices.rb +2 -0
  37. data/lib/losant_rest/edge_deployments.rb +2 -0
  38. data/lib/losant_rest/event.rb +2 -0
  39. data/lib/losant_rest/events.rb +103 -0
  40. data/lib/losant_rest/experience.rb +2 -0
  41. data/lib/losant_rest/experience_domain.rb +2 -0
  42. data/lib/losant_rest/experience_domains.rb +2 -0
  43. data/lib/losant_rest/experience_endpoint.rb +2 -0
  44. data/lib/losant_rest/experience_endpoints.rb +2 -0
  45. data/lib/losant_rest/experience_group.rb +2 -0
  46. data/lib/losant_rest/experience_groups.rb +2 -0
  47. data/lib/losant_rest/experience_slug.rb +2 -0
  48. data/lib/losant_rest/experience_slugs.rb +2 -0
  49. data/lib/losant_rest/experience_user.rb +2 -0
  50. data/lib/losant_rest/experience_users.rb +2 -0
  51. data/lib/losant_rest/experience_version.rb +2 -0
  52. data/lib/losant_rest/experience_versions.rb +2 -0
  53. data/lib/losant_rest/experience_view.rb +2 -0
  54. data/lib/losant_rest/experience_views.rb +2 -0
  55. data/lib/losant_rest/file.rb +2 -0
  56. data/lib/losant_rest/files.rb +2 -0
  57. data/lib/losant_rest/flow.rb +2 -0
  58. data/lib/losant_rest/flow_version.rb +2 -0
  59. data/lib/losant_rest/flow_versions.rb +2 -0
  60. data/lib/losant_rest/flows.rb +2 -0
  61. data/lib/losant_rest/integration.rb +2 -0
  62. data/lib/losant_rest/integrations.rb +2 -0
  63. data/lib/losant_rest/me.rb +57 -13
  64. data/lib/losant_rest/notebook.rb +2 -0
  65. data/lib/losant_rest/notebooks.rb +2 -0
  66. data/lib/losant_rest/org.rb +2 -0
  67. data/lib/losant_rest/org_invites.rb +2 -0
  68. data/lib/losant_rest/orgs.rb +2 -0
  69. data/lib/losant_rest/version.rb +1 -1
  70. data/lib/losant_rest/webhook.rb +2 -0
  71. data/lib/losant_rest/webhooks.rb +2 -0
  72. data/schemas/advancedEventQuery.json +817 -0
  73. data/schemas/{dataTableQuery.json → advancedQuery.json} +5 -4
  74. data/schemas/apiTokens.json +4 -1
  75. data/schemas/application.json +30 -1
  76. data/schemas/applicationApiTokenPost.json +5 -0
  77. data/schemas/applicationCertificate.json +29 -1
  78. data/schemas/applicationCertificateAuthorities.json +36 -3
  79. data/schemas/applicationCertificateAuthority.json +32 -2
  80. data/schemas/applicationCertificateAuthorityPatch.json +3 -1
  81. data/schemas/applicationCertificateAuthorityPost.json +3 -1
  82. data/schemas/applicationCertificatePatch.json +3 -1
  83. data/schemas/applicationCertificatePost.json +3 -1
  84. data/schemas/applicationCertificates.json +33 -2
  85. data/schemas/applicationKeys.json +4 -1
  86. data/schemas/applicationPatch.json +28 -0
  87. data/schemas/applicationPost.json +28 -0
  88. data/schemas/applications.json +34 -2
  89. data/schemas/auditLog.json +0 -3
  90. data/schemas/auditLogFilter.json +0 -3
  91. data/schemas/auditLogs.json +4 -4
  92. data/schemas/authedDevice.json +7 -0
  93. data/schemas/dashboard.json +3970 -72
  94. data/schemas/dashboardPatch.json +3969 -72
  95. data/schemas/dashboardPost.json +3969 -72
  96. data/schemas/dashboardSendReport.json +4 -0
  97. data/schemas/dashboardUpdateEvents.json +46 -0
  98. data/schemas/dashboards.json +3974 -73
  99. data/schemas/dataTableRows.json +4 -1
  100. data/schemas/dataTableRowsExport.json +11 -7
  101. data/schemas/dataTables.json +4 -1
  102. data/schemas/deviceRecipes.json +4 -1
  103. data/schemas/devices.json +4 -1
  104. data/schemas/event.json +19 -2
  105. data/schemas/eventPost.json +0 -1
  106. data/schemas/eventTagsSummary.json +28 -0
  107. data/schemas/events.json +841 -3
  108. data/schemas/eventsDeleted.json +9 -0
  109. data/schemas/eventsExport.json +830 -0
  110. data/schemas/experienceDomain.json +6 -2
  111. data/schemas/experienceDomainPatch.json +14 -10
  112. data/schemas/experienceDomainPost.json +8 -4
  113. data/schemas/experienceDomains.json +6 -2
  114. data/schemas/experienceEndpoints.json +4 -1
  115. data/schemas/experienceGroup.json +2 -2
  116. data/schemas/experienceGroupPatch.json +2 -2
  117. data/schemas/experienceGroupPost.json +2 -2
  118. data/schemas/experienceGroups.json +6 -3
  119. data/schemas/experienceSlugPatch.json +2 -2
  120. data/schemas/experienceSlugPost.json +2 -2
  121. data/schemas/experienceUsers.json +4 -1
  122. data/schemas/experienceViews.json +4 -1
  123. data/schemas/files.json +4 -1
  124. data/schemas/flow.json +4 -0
  125. data/schemas/flowPatch.json +6 -2
  126. data/schemas/flowPost.json +4 -0
  127. data/schemas/flowVersion.json +8 -0
  128. data/schemas/flowVersionPost.json +4 -0
  129. data/schemas/flowVersions.json +12 -1
  130. data/schemas/flows.json +8 -1
  131. data/schemas/flowsImportPost.json +10 -2
  132. data/schemas/flowsImportResult.json +12 -0
  133. data/schemas/githubLogin.json +6 -15
  134. data/schemas/integrations.json +4 -1
  135. data/schemas/notebooks.json +4 -1
  136. data/schemas/org.json +2 -4
  137. data/schemas/orgPatch.json +2 -1
  138. data/schemas/orgPost.json +2 -1
  139. data/schemas/orgs.json +6 -5
  140. data/schemas/passwordResetFinish.json +0 -4
  141. data/schemas/passwordResetInput.json +0 -4
  142. data/schemas/resourceTransfer.json +0 -8
  143. data/schemas/userCredentials.json +6 -15
  144. data/schemas/userPost.json +6 -15
  145. data/schemas/webhooks.json +4 -1
  146. data/test/basic_test.rb +15 -0
  147. metadata +8 -23
  148. data/docs/solution.md +0 -133
  149. data/docs/solutionUser.md +0 -139
  150. data/docs/solutionUsers.md +0 -96
  151. data/docs/solutions.md +0 -91
  152. data/lib/losant_rest/solution.rb +0 -174
  153. data/lib/losant_rest/solution_user.rb +0 -180
  154. data/lib/losant_rest/solution_users.rb +0 -138
  155. data/lib/losant_rest/solutions.rb +0 -134
  156. data/schemas/authedSolutionUser.json +0 -18
  157. data/schemas/fileUploadPostResp.json +0 -109
  158. data/schemas/solution.json +0 -76
  159. data/schemas/solutionMe.json +0 -150
  160. data/schemas/solutionPatch.json +0 -48
  161. data/schemas/solutionPost.json +0 -52
  162. data/schemas/solutionUser.json +0 -103
  163. data/schemas/solutionUserCredentials.json +0 -34
  164. data/schemas/solutionUserPatch.json +0 -74
  165. data/schemas/solutionUserPost.json +0 -80
  166. data/schemas/solutionUsers.json +0 -149
  167. data/schemas/solutions.json +0 -118
data/docs/solution.md DELETED
@@ -1,133 +0,0 @@
1
- # Solution Actions
2
-
3
- Details on the various actions that can be performed on the
4
- Solution resource, including the expected
5
- parameters and the potential responses.
6
-
7
- ##### Contents
8
-
9
- * [Delete](#delete)
10
- * [Get](#get)
11
- * [Patch](#patch)
12
-
13
- <br/>
14
-
15
- ## Delete
16
-
17
- Deletes a solution
18
-
19
- ```ruby
20
- result = client.solution.delete(
21
- orgId: my_org_id,
22
- solutionId: my_solution_id)
23
-
24
- puts result
25
- ```
26
-
27
- #### Authentication
28
- The client must be configured with a valid api access token to call this
29
- action. The token must include at least one of the following scopes:
30
- all.Organization, all.User, solution.*, or solution.delete.
31
-
32
- #### Available Parameters
33
-
34
- | Name | Type | Required | Description | Default | Example |
35
- | ---- | ---- | -------- | ----------- | ------- | ------- |
36
- | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
37
- | solutionId | string | Y | ID associated with the solution | | 57955788124b37010084c053 |
38
- | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
39
-
40
- #### Successful Responses
41
-
42
- | Code | Type | Description |
43
- | ---- | ---- | ----------- |
44
- | 200 | [Success](_schemas.md#success) | If solution was successfully deleted |
45
-
46
- #### Error Responses
47
-
48
- | Code | Type | Description |
49
- | ---- | ---- | ----------- |
50
- | 400 | [Error](_schemas.md#error) | Error if malformed request |
51
- | 404 | [Error](_schemas.md#error) | Error if solution was not found |
52
-
53
- <br/>
54
-
55
- ## Get
56
-
57
- Retrieves information on a solution
58
-
59
- ```ruby
60
- result = client.solution.get(
61
- orgId: my_org_id,
62
- solutionId: my_solution_id)
63
-
64
- puts result
65
- ```
66
-
67
- #### Authentication
68
- The client must be configured with a valid api access token to call this
69
- action. The token must include at least one of the following scopes:
70
- all.Organization, all.Organization.read, all.User, all.User.read, solution.*, or solution.get.
71
-
72
- #### Available Parameters
73
-
74
- | Name | Type | Required | Description | Default | Example |
75
- | ---- | ---- | -------- | ----------- | ------- | ------- |
76
- | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
77
- | solutionId | string | Y | ID associated with the solution | | 57955788124b37010084c053 |
78
- | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
79
-
80
- #### Successful Responses
81
-
82
- | Code | Type | Description |
83
- | ---- | ---- | ----------- |
84
- | 200 | [Solution](_schemas.md#solution) | Solution information |
85
-
86
- #### Error Responses
87
-
88
- | Code | Type | Description |
89
- | ---- | ---- | ----------- |
90
- | 400 | [Error](_schemas.md#error) | Error if malformed request |
91
- | 404 | [Error](_schemas.md#error) | Error if solution was not found |
92
-
93
- <br/>
94
-
95
- ## Patch
96
-
97
- Updates information about a solution
98
-
99
- ```ruby
100
- result = client.solution.patch(
101
- orgId: my_org_id,
102
- solutionId: my_solution_id,
103
- solution: my_solution)
104
-
105
- puts result
106
- ```
107
-
108
- #### Authentication
109
- The client must be configured with a valid api access token to call this
110
- action. The token must include at least one of the following scopes:
111
- all.Organization, all.User, solution.*, or solution.patch.
112
-
113
- #### Available Parameters
114
-
115
- | Name | Type | Required | Description | Default | Example |
116
- | ---- | ---- | -------- | ----------- | ------- | ------- |
117
- | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
118
- | solutionId | string | Y | ID associated with the solution | | 57955788124b37010084c053 |
119
- | solution | [Solution Patch](_schemas.md#solution-patch) | Y | Object containing new properties of the solution | | [Solution Patch Example](_schemas.md#solution-patch-example) |
120
- | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
121
-
122
- #### Successful Responses
123
-
124
- | Code | Type | Description |
125
- | ---- | ---- | ----------- |
126
- | 200 | [Solution](_schemas.md#solution) | Updated solution information |
127
-
128
- #### Error Responses
129
-
130
- | Code | Type | Description |
131
- | ---- | ---- | ----------- |
132
- | 400 | [Error](_schemas.md#error) | Error if malformed request |
133
- | 404 | [Error](_schemas.md#error) | Error if solution was not found |
data/docs/solutionUser.md DELETED
@@ -1,139 +0,0 @@
1
- # Solution User Actions
2
-
3
- Details on the various actions that can be performed on the
4
- Solution User resource, including the expected
5
- parameters and the potential responses.
6
-
7
- ##### Contents
8
-
9
- * [Delete](#delete)
10
- * [Get](#get)
11
- * [Patch](#patch)
12
-
13
- <br/>
14
-
15
- ## Delete
16
-
17
- Deletes a solution user
18
-
19
- ```ruby
20
- result = client.solution_user.delete(
21
- orgId: my_org_id,
22
- solutionId: my_solution_id,
23
- solutionUserId: my_solution_user_id)
24
-
25
- puts result
26
- ```
27
-
28
- #### Authentication
29
- The client must be configured with a valid api access token to call this
30
- action. The token must include at least one of the following scopes:
31
- all.Organization, all.User, solutionUser.*, or solutionUser.delete.
32
-
33
- #### Available Parameters
34
-
35
- | Name | Type | Required | Description | Default | Example |
36
- | ---- | ---- | -------- | ----------- | ------- | ------- |
37
- | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
38
- | solutionId | string | Y | ID associated with the solution | | 57955788124b37010084c053 |
39
- | solutionUserId | string | Y | ID associated with the solution user | | 566116085df4b701000258e3 |
40
- | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
41
-
42
- #### Successful Responses
43
-
44
- | Code | Type | Description |
45
- | ---- | ---- | ----------- |
46
- | 200 | [Success](_schemas.md#success) | If solution user was successfully deleted |
47
-
48
- #### Error Responses
49
-
50
- | Code | Type | Description |
51
- | ---- | ---- | ----------- |
52
- | 400 | [Error](_schemas.md#error) | Error if malformed request |
53
- | 404 | [Error](_schemas.md#error) | Error if solution user was not found |
54
-
55
- <br/>
56
-
57
- ## Get
58
-
59
- Retrieves information on a solution user
60
-
61
- ```ruby
62
- result = client.solution_user.get(
63
- orgId: my_org_id,
64
- solutionId: my_solution_id,
65
- solutionUserId: my_solution_user_id)
66
-
67
- puts result
68
- ```
69
-
70
- #### Authentication
71
- The client must be configured with a valid api access token to call this
72
- action. The token must include at least one of the following scopes:
73
- all.Organization, all.Organization.read, all.User, all.User.read, solutionUser.*, or solutionUser.get.
74
-
75
- #### Available Parameters
76
-
77
- | Name | Type | Required | Description | Default | Example |
78
- | ---- | ---- | -------- | ----------- | ------- | ------- |
79
- | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
80
- | solutionId | string | Y | ID associated with the solution | | 57955788124b37010084c053 |
81
- | solutionUserId | string | Y | ID associated with the solution user | | 566116085df4b701000258e3 |
82
- | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
83
-
84
- #### Successful Responses
85
-
86
- | Code | Type | Description |
87
- | ---- | ---- | ----------- |
88
- | 200 | [Solution User](_schemas.md#solution-user) | Solution user information |
89
-
90
- #### Error Responses
91
-
92
- | Code | Type | Description |
93
- | ---- | ---- | ----------- |
94
- | 400 | [Error](_schemas.md#error) | Error if malformed request |
95
- | 404 | [Error](_schemas.md#error) | Error if solution user was not found |
96
-
97
- <br/>
98
-
99
- ## Patch
100
-
101
- Updates information about a solution user
102
-
103
- ```ruby
104
- result = client.solution_user.patch(
105
- orgId: my_org_id,
106
- solutionId: my_solution_id,
107
- solutionUserId: my_solution_user_id,
108
- solutionUser: my_solution_user)
109
-
110
- puts result
111
- ```
112
-
113
- #### Authentication
114
- The client must be configured with a valid api access token to call this
115
- action. The token must include at least one of the following scopes:
116
- all.Organization, all.User, solutionUser.*, or solutionUser.patch.
117
-
118
- #### Available Parameters
119
-
120
- | Name | Type | Required | Description | Default | Example |
121
- | ---- | ---- | -------- | ----------- | ------- | ------- |
122
- | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
123
- | solutionId | string | Y | ID associated with the solution | | 57955788124b37010084c053 |
124
- | solutionUserId | string | Y | ID associated with the solution user | | 566116085df4b701000258e3 |
125
- | solutionUser | [Solution User Patch](_schemas.md#solution-user-patch) | Y | Object containing new properties of the solution user | | [Solution User Patch Example](_schemas.md#solution-user-patch-example) |
126
- | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
127
-
128
- #### Successful Responses
129
-
130
- | Code | Type | Description |
131
- | ---- | ---- | ----------- |
132
- | 200 | [Solution User](_schemas.md#solution-user) | Updated solution user information |
133
-
134
- #### Error Responses
135
-
136
- | Code | Type | Description |
137
- | ---- | ---- | ----------- |
138
- | 400 | [Error](_schemas.md#error) | Error if malformed request |
139
- | 404 | [Error](_schemas.md#error) | Error if solution user was not found |
data/docs/solutionUsers.md DELETED
@@ -1,96 +0,0 @@
1
- # Solution Users Actions
2
-
3
- Details on the various actions that can be performed on the
4
- Solution Users resource, including the expected
5
- parameters and the potential responses.
6
-
7
- ##### Contents
8
-
9
- * [Get](#get)
10
- * [Post](#post)
11
-
12
- <br/>
13
-
14
- ## Get
15
-
16
- Returns the users for the solution
17
-
18
- ```ruby
19
- result = client.solution_users.get(
20
- orgId: my_org_id,
21
- solutionId: my_solution_id)
22
-
23
- puts result
24
- ```
25
-
26
- #### Authentication
27
- The client must be configured with a valid api access token to call this
28
- action. The token must include at least one of the following scopes:
29
- all.Organization, all.Organization.read, all.User, all.User.read, solutionUsers.*, or solutionUsers.get.
30
-
31
- #### Available Parameters
32
-
33
- | Name | Type | Required | Description | Default | Example |
34
- | ---- | ---- | -------- | ----------- | ------- | ------- |
35
- | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
36
- | solutionId | string | Y | ID associated with the solution | | 57955788124b37010084c053 |
37
- | sortField | string | N | Field to sort the results by. Accepted values are: email, firstName, lastName, id, creationDate, lastLogin, lastUpdated | email | email |
38
- | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
39
- | page | string | N | Which page of results to return | 0 | 0 |
40
- | perPage | string | N | How many items to return per page | 1000 | 10 |
41
- | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: email, firstName, lastName | | email |
42
- | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | email*address |
43
- | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
44
-
45
- #### Successful Responses
46
-
47
- | Code | Type | Description |
48
- | ---- | ---- | ----------- |
49
- | 200 | [Solution Users](_schemas.md#solution-users) | Collection of solution users |
50
-
51
- #### Error Responses
52
-
53
- | Code | Type | Description |
54
- | ---- | ---- | ----------- |
55
- | 400 | [Error](_schemas.md#error) | Error if malformed request |
56
-
57
- <br/>
58
-
59
- ## Post
60
-
61
- Create a new solution user
62
-
63
- ```ruby
64
- result = client.solution_users.post(
65
- orgId: my_org_id,
66
- solutionId: my_solution_id,
67
- solutionUser: my_solution_user)
68
-
69
- puts result
70
- ```
71
-
72
- #### Authentication
73
- The client must be configured with a valid api access token to call this
74
- action. The token must include at least one of the following scopes:
75
- all.Organization, all.User, solutionUsers.*, or solutionUsers.post.
76
-
77
- #### Available Parameters
78
-
79
- | Name | Type | Required | Description | Default | Example |
80
- | ---- | ---- | -------- | ----------- | ------- | ------- |
81
- | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
82
- | solutionId | string | Y | ID associated with the solution | | 57955788124b37010084c053 |
83
- | solutionUser | [Solution User Post](_schemas.md#solution-user-post) | Y | New solution user information | | [Solution User Post Example](_schemas.md#solution-user-post-example) |
84
- | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
85
-
86
- #### Successful Responses
87
-
88
- | Code | Type | Description |
89
- | ---- | ---- | ----------- |
90
- | 201 | [Solution User](_schemas.md#solution-user) | Successfully created solution user |
91
-
92
- #### Error Responses
93
-
94
- | Code | Type | Description |
95
- | ---- | ---- | ----------- |
96
- | 400 | [Error](_schemas.md#error) | Error if malformed request |
data/docs/solutions.md DELETED
@@ -1,91 +0,0 @@
1
- # Solutions Actions
2
-
3
- Details on the various actions that can be performed on the
4
- Solutions resource, including the expected
5
- parameters and the potential responses.
6
-
7
- ##### Contents
8
-
9
- * [Get](#get)
10
- * [Post](#post)
11
-
12
- <br/>
13
-
14
- ## Get
15
-
16
- Returns the solutions for the organization
17
-
18
- ```ruby
19
- result = client.solutions.get(orgId: my_org_id)
20
-
21
- puts result
22
- ```
23
-
24
- #### Authentication
25
- The client must be configured with a valid api access token to call this
26
- action. The token must include at least one of the following scopes:
27
- all.Organization, all.Organization.read, all.User, all.User.read, solutions.*, or solutions.get.
28
-
29
- #### Available Parameters
30
-
31
- | Name | Type | Required | Description | Default | Example |
32
- | ---- | ---- | -------- | ----------- | ------- | ------- |
33
- | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
34
- | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated | name | name |
35
- | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
36
- | page | string | N | Which page of results to return | 0 | 0 |
37
- | perPage | string | N | How many items to return per page | 1000 | 10 |
38
- | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
39
- | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*solution |
40
- | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
41
-
42
- #### Successful Responses
43
-
44
- | Code | Type | Description |
45
- | ---- | ---- | ----------- |
46
- | 200 | [Solutions](_schemas.md#solutions) | Collection of solutions |
47
-
48
- #### Error Responses
49
-
50
- | Code | Type | Description |
51
- | ---- | ---- | ----------- |
52
- | 400 | [Error](_schemas.md#error) | Error if malformed request |
53
-
54
- <br/>
55
-
56
- ## Post
57
-
58
- Create a new solution
59
-
60
- ```ruby
61
- result = client.solutions.post(
62
- orgId: my_org_id,
63
- solution: my_solution)
64
-
65
- puts result
66
- ```
67
-
68
- #### Authentication
69
- The client must be configured with a valid api access token to call this
70
- action. The token must include at least one of the following scopes:
71
- all.Organization, all.User, solutions.*, or solutions.post.
72
-
73
- #### Available Parameters
74
-
75
- | Name | Type | Required | Description | Default | Example |
76
- | ---- | ---- | -------- | ----------- | ------- | ------- |
77
- | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
78
- | solution | [Solution Post](_schemas.md#solution-post) | Y | New solution information | | [Solution Post Example](_schemas.md#solution-post-example) |
79
- | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
80
-
81
- #### Successful Responses
82
-
83
- | Code | Type | Description |
84
- | ---- | ---- | ----------- |
85
- | 201 | [Solution](_schemas.md#solution) | Successfully created solution |
86
-
87
- #### Error Responses
88
-
89
- | Code | Type | Description |
90
- | ---- | ---- | ----------- |
91
- | 400 | [Error](_schemas.md#error) | Error if malformed request |