losant_rest 2.0.0 → 2.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/docs/_schemas.md +140925 -67028
- data/docs/application.md +27 -27
- data/docs/applicationApiToken.md +1 -1
- data/docs/applicationApiTokens.md +1 -1
- data/docs/applicationCertificate.md +3 -3
- data/docs/applicationCertificateAuthorities.md +2 -2
- data/docs/applicationCertificateAuthority.md +3 -3
- data/docs/applicationCertificates.md +5 -4
- data/docs/applicationDashboard.md +5 -5
- data/docs/applicationDashboards.md +2 -2
- data/docs/applicationJobLog.md +1 -1
- data/docs/applicationJobLogs.md +1 -1
- data/docs/applicationKey.md +3 -3
- data/docs/applicationKeys.md +2 -2
- data/docs/applicationTemplate.md +1 -1
- data/docs/applicationTemplates.md +3 -3
- data/docs/applications.md +5 -5
- data/docs/auditLog.md +1 -1
- data/docs/auditLogs.md +1 -1
- data/docs/auth.md +1 -1
- data/docs/credential.md +4 -4
- data/docs/credentials.md +2 -2
- data/docs/dashboard.md +4 -4
- data/docs/dashboards.md +3 -2
- data/docs/data.md +3 -3
- data/docs/dataTable.md +5 -5
- data/docs/dataTableRow.md +4 -4
- data/docs/dataTableRows.md +9 -9
- data/docs/dataTables.md +2 -2
- data/docs/device.md +15 -15
- data/docs/deviceAttribute.md +3 -3
- data/docs/deviceAttributes.md +2 -2
- data/docs/deviceRecipe.md +4 -4
- data/docs/deviceRecipes.md +2 -2
- data/docs/devices.md +14 -14
- data/docs/edgeDeployment.md +1 -1
- data/docs/edgeDeployments.md +7 -7
- data/docs/embeddedDeployment.md +1 -1
- data/docs/embeddedDeployments.md +8 -8
- data/docs/event.md +3 -3
- data/docs/events.md +6 -6
- data/docs/experience.md +3 -3
- data/docs/experienceDomain.md +3 -3
- data/docs/experienceDomains.md +2 -2
- data/docs/experienceEndpoint.md +4 -4
- data/docs/experienceEndpoints.md +3 -3
- data/docs/experienceGroup.md +3 -3
- data/docs/experienceGroups.md +2 -2
- data/docs/experienceSlug.md +3 -3
- data/docs/experienceSlugs.md +2 -2
- data/docs/experienceUser.md +3 -3
- data/docs/experienceUsers.md +2 -2
- data/docs/experienceVersion.md +3 -3
- data/docs/experienceVersions.md +2 -2
- data/docs/experienceView.md +4 -4
- data/docs/experienceViews.md +2 -2
- data/docs/file.md +9 -9
- data/docs/files.md +3 -3
- data/docs/flow.md +11 -11
- data/docs/flowVersion.md +6 -6
- data/docs/flowVersions.md +4 -4
- data/docs/flows.md +5 -5
- data/docs/instance.md +8 -8
- data/docs/instanceApiToken.md +1 -1
- data/docs/instanceApiTokens.md +2 -2
- data/docs/instanceAuditLog.md +1 -1
- data/docs/instanceAuditLogs.md +1 -1
- data/docs/instanceCustomNode.md +5 -5
- data/docs/instanceCustomNodes.md +2 -2
- data/docs/instanceMember.md +2 -2
- data/docs/instanceMembers.md +1 -1
- data/docs/instanceNotificationRule.md +5 -5
- data/docs/instanceNotificationRules.md +2 -2
- data/docs/instanceOrg.md +8 -8
- data/docs/instanceOrgInvite.md +3 -3
- data/docs/instanceOrgInvites.md +2 -2
- data/docs/instanceOrgMember.md +1 -1
- data/docs/instanceOrgMembers.md +3 -2
- data/docs/instanceOrgs.md +3 -3
- data/docs/instanceSandbox.md +7 -7
- data/docs/instanceSandboxes.md +1 -1
- data/docs/instances.md +1 -1
- data/docs/integration.md +3 -3
- data/docs/integrations.md +2 -2
- data/docs/me.md +21 -21
- data/docs/notebook.md +10 -10
- data/docs/notebooks.md +2 -2
- data/docs/org.md +14 -14
- data/docs/orgs.md +2 -2
- data/docs/privateFile.md +9 -9
- data/docs/privateFiles.md +3 -3
- data/docs/resourceJob.md +8 -8
- data/docs/resourceJobs.md +2 -2
- data/docs/userApiToken.md +3 -3
- data/docs/userApiTokens.md +4 -4
- data/docs/userOauthToken.md +125 -0
- data/docs/userOauthTokens.md +87 -0
- data/docs/webhook.md +3 -3
- data/docs/webhooks.md +2 -2
- data/lib/platform_rest/application.rb +21 -21
- data/lib/platform_rest/application_api_token.rb +1 -1
- data/lib/platform_rest/application_api_tokens.rb +1 -1
- data/lib/platform_rest/application_certificate.rb +3 -3
- data/lib/platform_rest/application_certificate_authorities.rb +2 -2
- data/lib/platform_rest/application_certificate_authority.rb +3 -3
- data/lib/platform_rest/application_certificates.rb +7 -4
- data/lib/platform_rest/application_dashboard.rb +5 -5
- data/lib/platform_rest/application_dashboards.rb +2 -2
- data/lib/platform_rest/application_job_log.rb +1 -1
- data/lib/platform_rest/application_job_logs.rb +1 -1
- data/lib/platform_rest/application_key.rb +3 -3
- data/lib/platform_rest/application_keys.rb +2 -2
- data/lib/platform_rest/application_template.rb +1 -1
- data/lib/platform_rest/application_templates.rb +3 -3
- data/lib/platform_rest/applications.rb +3 -3
- data/lib/platform_rest/audit_log.rb +1 -1
- data/lib/platform_rest/audit_logs.rb +1 -1
- data/lib/platform_rest/client.rb +10 -2
- data/lib/platform_rest/credential.rb +4 -4
- data/lib/platform_rest/credentials.rb +2 -2
- data/lib/platform_rest/dashboard.rb +4 -4
- data/lib/platform_rest/dashboards.rb +3 -2
- data/lib/platform_rest/data.rb +3 -3
- data/lib/platform_rest/data_table.rb +5 -5
- data/lib/platform_rest/data_table_row.rb +4 -4
- data/lib/platform_rest/data_table_rows.rb +9 -9
- data/lib/platform_rest/data_tables.rb +2 -2
- data/lib/platform_rest/device.rb +15 -15
- data/lib/platform_rest/device_attribute.rb +3 -3
- data/lib/platform_rest/device_attributes.rb +2 -2
- data/lib/platform_rest/device_recipe.rb +4 -4
- data/lib/platform_rest/device_recipes.rb +2 -2
- data/lib/platform_rest/devices.rb +14 -14
- data/lib/platform_rest/edge_deployment.rb +1 -1
- data/lib/platform_rest/edge_deployments.rb +7 -7
- data/lib/platform_rest/embedded_deployment.rb +1 -1
- data/lib/platform_rest/embedded_deployments.rb +8 -8
- data/lib/platform_rest/event.rb +3 -3
- data/lib/platform_rest/events.rb +6 -6
- data/lib/platform_rest/experience.rb +3 -3
- data/lib/platform_rest/experience_domain.rb +3 -3
- data/lib/platform_rest/experience_domains.rb +2 -2
- data/lib/platform_rest/experience_endpoint.rb +4 -4
- data/lib/platform_rest/experience_endpoints.rb +3 -3
- data/lib/platform_rest/experience_group.rb +3 -3
- data/lib/platform_rest/experience_groups.rb +2 -2
- data/lib/platform_rest/experience_slug.rb +3 -3
- data/lib/platform_rest/experience_slugs.rb +2 -2
- data/lib/platform_rest/experience_user.rb +3 -3
- data/lib/platform_rest/experience_users.rb +2 -2
- data/lib/platform_rest/experience_version.rb +3 -3
- data/lib/platform_rest/experience_versions.rb +2 -2
- data/lib/platform_rest/experience_view.rb +4 -4
- data/lib/platform_rest/experience_views.rb +2 -2
- data/lib/platform_rest/file.rb +6 -6
- data/lib/platform_rest/files.rb +2 -2
- data/lib/platform_rest/flow.rb +11 -11
- data/lib/platform_rest/flow_version.rb +6 -6
- data/lib/platform_rest/flow_versions.rb +3 -3
- data/lib/platform_rest/flows.rb +5 -5
- data/lib/platform_rest/instance.rb +8 -8
- data/lib/platform_rest/instance_api_token.rb +1 -1
- data/lib/platform_rest/instance_api_tokens.rb +2 -2
- data/lib/platform_rest/instance_audit_log.rb +1 -1
- data/lib/platform_rest/instance_audit_logs.rb +1 -1
- data/lib/platform_rest/instance_custom_node.rb +5 -5
- data/lib/platform_rest/instance_custom_nodes.rb +2 -2
- data/lib/platform_rest/instance_member.rb +2 -2
- data/lib/platform_rest/instance_members.rb +1 -1
- data/lib/platform_rest/instance_notification_rule.rb +5 -5
- data/lib/platform_rest/instance_notification_rules.rb +2 -2
- data/lib/platform_rest/instance_org.rb +8 -8
- data/lib/platform_rest/instance_org_invite.rb +3 -3
- data/lib/platform_rest/instance_org_invites.rb +3 -3
- data/lib/platform_rest/instance_org_member.rb +1 -1
- data/lib/platform_rest/instance_org_members.rb +3 -2
- data/lib/platform_rest/instance_orgs.rb +3 -3
- data/lib/platform_rest/instance_sandbox.rb +7 -7
- data/lib/platform_rest/instance_sandboxes.rb +1 -1
- data/lib/platform_rest/instances.rb +1 -1
- data/lib/platform_rest/integration.rb +3 -3
- data/lib/platform_rest/integrations.rb +2 -2
- data/lib/platform_rest/me.rb +21 -21
- data/lib/platform_rest/notebook.rb +9 -9
- data/lib/platform_rest/notebooks.rb +2 -2
- data/lib/platform_rest/org.rb +14 -14
- data/lib/platform_rest/orgs.rb +2 -2
- data/lib/platform_rest/private_file.rb +6 -6
- data/lib/platform_rest/private_files.rb +2 -2
- data/lib/platform_rest/resource_job.rb +8 -8
- data/lib/platform_rest/resource_jobs.rb +2 -2
- data/lib/platform_rest/user_api_token.rb +3 -3
- data/lib/platform_rest/user_api_tokens.rb +4 -4
- data/lib/platform_rest/user_oauth_token.rb +170 -0
- data/lib/platform_rest/user_oauth_tokens.rb +132 -0
- data/lib/platform_rest/version.rb +1 -1
- data/lib/platform_rest/webhook.rb +3 -3
- data/lib/platform_rest/webhooks.rb +2 -2
- data/lib/platform_rest.rb +2 -0
- data/schemas/advancedApplicationCertQuery.json +1885 -0
- data/schemas/advancedApplicationKeyQuery.json +763 -763
- data/schemas/apiToken.json +110 -1
- data/schemas/apiTokenPatch.json +100 -0
- data/schemas/apiTokenPost.json +118 -0
- data/schemas/apiTokens.json +120 -2
- data/schemas/application.json +15 -2
- data/schemas/applicationCertificate.json +90 -58
- data/schemas/applicationCertificateAuthorities.json +24 -0
- data/schemas/applicationCertificateAuthority.json +24 -0
- data/schemas/applicationCertificatePatch.json +32 -4
- data/schemas/applicationCertificatePost.json +28 -30
- data/schemas/applicationCertificates.json +90 -58
- data/schemas/applicationCreationByTemplateResult.json +15 -2
- data/schemas/applicationDashboardPost.json +183 -128
- data/schemas/applicationImportExecutions.json +3 -5
- data/schemas/applicationImportResult.json +674 -0
- data/schemas/applicationJobLog.json +129 -123
- data/schemas/applicationJobLogs.json +129 -123
- data/schemas/applicationKey.json +41 -41
- data/schemas/applicationKeyPatch.json +4 -4
- data/schemas/applicationKeyPost.json +36 -29
- data/schemas/applicationKeys.json +41 -41
- data/schemas/applicationSearchResult.json +10 -10
- data/schemas/applicationTemplates.json +9 -2
- data/schemas/applications.json +15 -2
- data/schemas/auditLog.json +2 -6
- data/schemas/auditLogs.json +2 -6
- data/schemas/authedDevice.json +3 -0
- data/schemas/credential.json +7 -0
- data/schemas/credentialLinkedResources.json +19724 -344
- data/schemas/credentialPatch.json +3 -0
- data/schemas/credentialPost.json +3 -0
- data/schemas/credentials.json +7 -0
- data/schemas/dashboard.json +203 -128
- data/schemas/dashboardBlockSuggestCodePost.json +19 -0
- data/schemas/dashboardPatch.json +183 -128
- data/schemas/dashboardPost.json +183 -128
- data/schemas/dashboardUpdateEventsResult.json +266 -0
- data/schemas/dashboards.json +203 -128
- data/schemas/dataTable.json +11 -0
- data/schemas/dataTableRowPatch.json +16 -0
- data/schemas/dataTableRowPost.json +39 -0
- data/schemas/dataTableRowPostResult.json +54 -0
- data/schemas/dataTables.json +11 -0
- data/schemas/device.json +259 -107
- data/schemas/deviceConnectionStatus.json +4 -0
- data/schemas/deviceLog.json +3 -0
- data/schemas/deviceRecipe.json +259 -108
- data/schemas/deviceRecipes.json +259 -108
- data/schemas/devices.json +287 -116
- data/schemas/edgeDeploymentRelease.json +4252 -39
- data/schemas/edgeDeployments.json +28 -0
- data/schemas/embeddedDeploymentRelease.json +2073 -0
- data/schemas/embeddedDeployments.json +25 -0
- data/schemas/error.json +14 -0
- data/schemas/event.json +4 -1
- data/schemas/eventPlusNewCount.json +4 -1
- data/schemas/events.json +4 -1
- data/schemas/experienceDomains.json +19 -0
- data/schemas/experienceEndpoint.json +19 -0
- data/schemas/experienceEndpoints.json +24 -0
- data/schemas/experienceLinkedResources.json +19728 -313
- data/schemas/experienceSlugs.json +19 -0
- data/schemas/experienceUsers.json +16 -2
- data/schemas/experienceVersions.json +25 -0
- data/schemas/experienceView.json +5 -0
- data/schemas/experienceViews.json +10 -0
- data/schemas/fileUploadPostResponse.json +92 -103
- data/schemas/files.json +5 -1
- data/schemas/flow.json +211 -46
- data/schemas/flowPatch.json +199 -46
- data/schemas/flowPost.json +199 -46
- data/schemas/flowStorageMetadata.json +2 -2
- data/schemas/flowVersion.json +450 -101
- data/schemas/flowVersionPost.json +199 -46
- data/schemas/flowVersions.json +9903 -113
- data/schemas/flows.json +9637 -46
- data/schemas/flowsImportPost.json +398 -92
- data/schemas/flowsImportResult.json +661 -147
- data/schemas/githubLogin.json +18 -0
- data/schemas/historicalSummaries.json +3 -2
- data/schemas/historicalSummary.json +3 -2
- data/schemas/instanceAuditLog.json +2 -6
- data/schemas/instanceAuditLogs.json +90 -1
- data/schemas/instanceCustomNode.json +41 -2
- data/schemas/instanceCustomNodePatch.json +59 -6
- data/schemas/instanceCustomNodePost.json +59 -6
- data/schemas/instanceCustomNodes.json +41 -2
- data/schemas/instanceOrg.json +4 -1
- data/schemas/instanceOrgInvite.json +102 -0
- data/schemas/instanceOrgInviteSent.json +12 -0
- data/schemas/instanceOrgInvites.json +145 -0
- data/schemas/instanceOrgMember.json +52 -0
- data/schemas/instanceOrgMemberPatch.json +2 -2
- data/schemas/instanceOrgMemberPost.json +4 -4
- data/schemas/instanceOrgMembers.json +105 -1
- data/schemas/instanceOrgPost.json +5 -5
- data/schemas/instanceOrgs.json +5 -2
- data/schemas/instanceSandbox.json +5 -1
- data/schemas/instanceSandboxes.json +9 -1
- data/schemas/integration.json +38 -39
- data/schemas/integrationPatch.json +8 -8
- data/schemas/integrationPost.json +8 -8
- data/schemas/integrations.json +38 -39
- data/schemas/jobEnqueuedResult.json +1 -1
- data/schemas/me.json +685 -88
- data/schemas/notebook.json +33 -21
- data/schemas/notebookExecutionLogs.json +20 -0
- data/schemas/notebookMinuteCounts.json +1 -1
- data/schemas/notebookPatch.json +29 -21
- data/schemas/notebookPost.json +29 -21
- data/schemas/notebooks.json +33 -21
- data/schemas/notificationRule.json +4 -0
- data/schemas/notificationRules.json +8 -0
- data/schemas/oauthClient.json +107 -0
- data/schemas/oauthClientPost.json +89 -0
- data/schemas/oauthDcrError.json +23 -0
- data/schemas/oauthError.json +31 -0
- data/schemas/org.json +16 -3
- data/schemas/orgInvite.json +2 -2
- data/schemas/orgInviteCollection.json +2 -2
- data/schemas/orgInvitePost.json +2 -2
- data/schemas/orgInvites.json +77 -82
- data/schemas/orgInvitesUser.json +44 -47
- data/schemas/orgMemberPatch.json +2 -2
- data/schemas/orgRoleInfo.json +2 -2
- data/schemas/orgs.json +16 -3
- data/schemas/paletteResponse.json +372 -364
- data/schemas/periodSummaries.json +1 -1
- data/schemas/recentItemList.json +226 -27
- data/schemas/resourceJob.json +33 -9
- data/schemas/resourceJobExecutionLogs.json +34 -20
- data/schemas/resourceJobExecutionOptions.json +1 -1
- data/schemas/resourceJobPatch.json +9 -9
- data/schemas/resourceJobPost.json +9 -9
- data/schemas/resourceJobs.json +33 -9
- data/schemas/samlResponse.json +18 -0
- data/schemas/tagValuesResponse.json +1 -2
- data/schemas/templateKeywords.json +1 -0
- data/schemas/timeSeriesData.json +36 -4
- data/schemas/userCredentials.json +18 -0
- data/schemas/userOauthToken.json +210 -0
- data/schemas/userOauthTokenPatch.json +123 -0
- data/schemas/userOauthTokenPost.json +197 -0
- data/schemas/userOauthTokens.json +251 -0
- data/schemas/userPost.json +18 -0
- data/schemas/validateContextError.json +71 -24
- data/schemas/validateContextSuccess.json +71 -24
- metadata +22 -1
data/docs/application.md
CHANGED
|
@@ -45,14 +45,14 @@ puts result
|
|
|
45
45
|
#### Authentication
|
|
46
46
|
The client must be configured with a valid api access token to call this
|
|
47
47
|
action. The token must include at least one of the following scopes:
|
|
48
|
-
all.Application, all.Organization, all.User, application.*, or application.applyTemplate.
|
|
48
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, application.*, or application.applyTemplate.
|
|
49
49
|
|
|
50
50
|
#### Available Parameters
|
|
51
51
|
|
|
52
52
|
| Name | Type | Required | Description | Default | Example |
|
|
53
53
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
|
54
54
|
| applicationId | string | Y | ID of the associated application | | 575ec8687ae143cd83dc4a97 |
|
|
55
|
-
| options | [Application Apply Template Patch
|
|
55
|
+
| options | [Application Apply Template Patch](_schemas.md#application-apply-template-patch) | Y | Object containing template import options | | [Application Apply Template Patch Example](_schemas.md#application-apply-template-patch-example) |
|
|
56
56
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
|
57
57
|
|
|
58
58
|
#### Successful Responses
|
|
@@ -86,7 +86,7 @@ puts result
|
|
|
86
86
|
#### Authentication
|
|
87
87
|
The client must be configured with a valid api access token to call this
|
|
88
88
|
action. The token must include at least one of the following scopes:
|
|
89
|
-
all.Application, all.Organization, all.User, application.*, or application.archiveData.
|
|
89
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, application.*, or application.archiveData.
|
|
90
90
|
|
|
91
91
|
#### Available Parameters
|
|
92
92
|
|
|
@@ -124,7 +124,7 @@ puts result
|
|
|
124
124
|
#### Authentication
|
|
125
125
|
The client must be configured with a valid api access token to call this
|
|
126
126
|
action. The token must include at least one of the following scopes:
|
|
127
|
-
all.Application, all.Organization, all.User, application.*, or application.backfillArchiveData.
|
|
127
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, application.*, or application.backfillArchiveData.
|
|
128
128
|
|
|
129
129
|
#### Available Parameters
|
|
130
130
|
|
|
@@ -161,14 +161,14 @@ puts result
|
|
|
161
161
|
#### Authentication
|
|
162
162
|
The client must be configured with a valid api access token to call this
|
|
163
163
|
action. The token must include at least one of the following scopes:
|
|
164
|
-
all.Application, all.Organization, all.User, application.*, or application.clone.
|
|
164
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, application.*, or application.clone.
|
|
165
165
|
|
|
166
166
|
#### Available Parameters
|
|
167
167
|
|
|
168
168
|
| Name | Type | Required | Description | Default | Example |
|
|
169
169
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
|
170
170
|
| applicationId | string | Y | ID of the associated application | | 575ec8687ae143cd83dc4a97 |
|
|
171
|
-
| options | [Application Clone Post
|
|
171
|
+
| options | [Application Clone Post](_schemas.md#application-clone-post) | N | Object containing optional clone fields | | [Application Clone Post Example](_schemas.md#application-clone-post-example) |
|
|
172
172
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
|
173
173
|
|
|
174
174
|
#### Successful Responses
|
|
@@ -185,7 +185,7 @@ all.Application, all.Organization, all.User, application.*, or application.clone
|
|
|
185
185
|
| ---- | ---- | ----------- |
|
|
186
186
|
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
|
187
187
|
| 404 | [Error](_schemas.md#error) | Error if application is not found |
|
|
188
|
-
| 422 | [Validation
|
|
188
|
+
| 422 | [Validation Errors](_schemas.md#validation-errors) | Error if too many validation errors occurred on other resources |
|
|
189
189
|
|
|
190
190
|
<br/>
|
|
191
191
|
|
|
@@ -202,7 +202,7 @@ puts result
|
|
|
202
202
|
#### Authentication
|
|
203
203
|
The client must be configured with a valid api access token to call this
|
|
204
204
|
action. The token must include at least one of the following scopes:
|
|
205
|
-
all.Application, all.Organization, all.User, application.*, or application.delete.
|
|
205
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, application.*, or application.delete.
|
|
206
206
|
|
|
207
207
|
#### Available Parameters
|
|
208
208
|
|
|
@@ -239,7 +239,7 @@ puts result
|
|
|
239
239
|
#### Authentication
|
|
240
240
|
The client must be configured with a valid api access token to call this
|
|
241
241
|
action. The token must include at least one of the following scopes:
|
|
242
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.deviceCounts.
|
|
242
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, application.*, or application.deviceCounts.
|
|
243
243
|
|
|
244
244
|
#### Available Parameters
|
|
245
245
|
|
|
@@ -280,14 +280,14 @@ puts result
|
|
|
280
280
|
#### Authentication
|
|
281
281
|
The client must be configured with a valid api access token to call this
|
|
282
282
|
action. The token must include at least one of the following scopes:
|
|
283
|
-
all.Application, all.Organization, all.User, application.*, or application.export.
|
|
283
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, application.*, or application.export.
|
|
284
284
|
|
|
285
285
|
#### Available Parameters
|
|
286
286
|
|
|
287
287
|
| Name | Type | Required | Description | Default | Example |
|
|
288
288
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
|
289
289
|
| applicationId | string | Y | ID of the associated application | | 575ec8687ae143cd83dc4a97 |
|
|
290
|
-
| options | [Application Export Post
|
|
290
|
+
| options | [Application Export Post](_schemas.md#application-export-post) | Y | Object containing export application options | | [Application Export Post Example](_schemas.md#application-export-post-example) |
|
|
291
291
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
|
292
292
|
|
|
293
293
|
#### Successful Responses
|
|
@@ -319,7 +319,7 @@ puts result
|
|
|
319
319
|
#### Authentication
|
|
320
320
|
The client must be configured with a valid api access token to call this
|
|
321
321
|
action. The token must include at least one of the following scopes:
|
|
322
|
-
all.Application, all.Organization, all.User, application.*, or application.fullDataTablesArchive.
|
|
322
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, application.*, or application.fullDataTablesArchive.
|
|
323
323
|
|
|
324
324
|
#### Available Parameters
|
|
325
325
|
|
|
@@ -332,7 +332,7 @@ all.Application, all.Organization, all.User, application.*, or application.fullD
|
|
|
332
332
|
|
|
333
333
|
| Code | Type | Description |
|
|
334
334
|
| ---- | ---- | ----------- |
|
|
335
|
-
| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | Enqueued a job to archive all selected data tables
|
|
335
|
+
| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | Enqueued a job to archive all selected data tables to this application archive location |
|
|
336
336
|
|
|
337
337
|
#### Error Responses
|
|
338
338
|
|
|
@@ -356,7 +356,7 @@ puts result
|
|
|
356
356
|
#### Authentication
|
|
357
357
|
The client must be configured with a valid api access token to call this
|
|
358
358
|
action. The token must include at least one of the following scopes:
|
|
359
|
-
all.Application, all.Organization, all.User, application.*, or application.fullEventsArchive.
|
|
359
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, application.*, or application.fullEventsArchive.
|
|
360
360
|
|
|
361
361
|
#### Available Parameters
|
|
362
362
|
|
|
@@ -393,7 +393,7 @@ puts result
|
|
|
393
393
|
#### Authentication
|
|
394
394
|
The client must be configured with a valid api access token to call this
|
|
395
395
|
action. The token must include at least one of the following scopes:
|
|
396
|
-
all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, application.*, or application.get.
|
|
396
|
+
all.Application, all.Application.bounded, all.Application.cli, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.cli, all.User.read, application.*, or application.get.
|
|
397
397
|
|
|
398
398
|
#### Available Parameters
|
|
399
399
|
|
|
@@ -434,7 +434,7 @@ puts result
|
|
|
434
434
|
#### Authentication
|
|
435
435
|
The client must be configured with a valid api access token to call this
|
|
436
436
|
action. The token must include at least one of the following scopes:
|
|
437
|
-
all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, application.*, or application.patch.
|
|
437
|
+
all.Application, all.Application.bounded, all.Application.cli, all.Organization, all.Organization.bounded, all.User, all.User.bounded, all.User.cli, application.*, or application.patch.
|
|
438
438
|
|
|
439
439
|
#### Available Parameters
|
|
440
440
|
|
|
@@ -472,7 +472,7 @@ puts result
|
|
|
472
472
|
#### Authentication
|
|
473
473
|
The client must be configured with a valid api access token to call this
|
|
474
474
|
action. The token must include at least one of the following scopes:
|
|
475
|
-
all.Application, all.Organization, all.User, application.*, or application.import.
|
|
475
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, application.*, or application.import.
|
|
476
476
|
|
|
477
477
|
#### Available Parameters
|
|
478
478
|
|
|
@@ -488,7 +488,7 @@ all.Application, all.Organization, all.User, application.*, or application.impor
|
|
|
488
488
|
|
|
489
489
|
| Code | Type | Description |
|
|
490
490
|
| ---- | ---- | ----------- |
|
|
491
|
-
| 200 | [Application](_schemas.md#application) | Updated application information |
|
|
491
|
+
| 200 | [Application Import Result](_schemas.md#application-import-result) | Updated application information or a dry-run result |
|
|
492
492
|
| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If a job was enqueued for the resources to be imported into the application |
|
|
493
493
|
|
|
494
494
|
#### Error Responses
|
|
@@ -513,7 +513,7 @@ puts result
|
|
|
513
513
|
#### Authentication
|
|
514
514
|
The client must be configured with a valid api access token to call this
|
|
515
515
|
action. The token must include at least one of the following scopes:
|
|
516
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.importLogs.
|
|
516
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, application.*, or application.importLogs.
|
|
517
517
|
|
|
518
518
|
#### Available Parameters
|
|
519
519
|
|
|
@@ -554,7 +554,7 @@ puts result
|
|
|
554
554
|
#### Authentication
|
|
555
555
|
The client must be configured with a valid api access token to call this
|
|
556
556
|
action. The token must include at least one of the following scopes:
|
|
557
|
-
all.Application, all.Organization, all.User, application.*, or application.mqttPublishMessage.
|
|
557
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, application.*, or application.mqttPublishMessage.
|
|
558
558
|
|
|
559
559
|
#### Available Parameters
|
|
560
560
|
|
|
@@ -592,7 +592,7 @@ puts result
|
|
|
592
592
|
#### Authentication
|
|
593
593
|
The client must be configured with a valid api access token to call this
|
|
594
594
|
action. The token must include at least one of the following scopes:
|
|
595
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.notebookMinuteCounts.
|
|
595
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, application.*, or application.notebookMinuteCounts.
|
|
596
596
|
|
|
597
597
|
#### Available Parameters
|
|
598
598
|
|
|
@@ -633,7 +633,7 @@ puts result
|
|
|
633
633
|
#### Authentication
|
|
634
634
|
The client must be configured with a valid api access token to call this
|
|
635
635
|
action. The token must include at least one of the following scopes:
|
|
636
|
-
all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, application.*, or application.patch.
|
|
636
|
+
all.Application, all.Application.bounded, all.Application.cli, all.Organization, all.Organization.bounded, all.User, all.User.bounded, all.User.cli, application.*, or application.patch.
|
|
637
637
|
|
|
638
638
|
#### Available Parameters
|
|
639
639
|
|
|
@@ -673,7 +673,7 @@ puts result
|
|
|
673
673
|
#### Authentication
|
|
674
674
|
The client must be configured with a valid api access token to call this
|
|
675
675
|
action. The token must include at least one of the following scopes:
|
|
676
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.payloadCounts.
|
|
676
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, application.*, or application.payloadCounts.
|
|
677
677
|
|
|
678
678
|
#### Available Parameters
|
|
679
679
|
|
|
@@ -713,7 +713,7 @@ puts result
|
|
|
713
713
|
#### Authentication
|
|
714
714
|
The client must be configured with a valid api access token to call this
|
|
715
715
|
action. The token must include at least one of the following scopes:
|
|
716
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.payloadCountsBreakdown.
|
|
716
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, application.*, or application.payloadCountsBreakdown.
|
|
717
717
|
|
|
718
718
|
#### Available Parameters
|
|
719
719
|
|
|
@@ -755,7 +755,7 @@ puts result
|
|
|
755
755
|
#### Authentication
|
|
756
756
|
The client must be configured with a valid api access token to call this
|
|
757
757
|
action. The token must include at least one of the following scopes:
|
|
758
|
-
all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, application.*, or application.get.
|
|
758
|
+
all.Application, all.Application.bounded, all.Application.cli, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.cli, all.User.read, application.*, or application.get.
|
|
759
759
|
|
|
760
760
|
#### Available Parameters
|
|
761
761
|
|
|
@@ -794,7 +794,7 @@ puts result
|
|
|
794
794
|
#### Authentication
|
|
795
795
|
The client must be configured with a valid api access token to call this
|
|
796
796
|
action. The token must include at least one of the following scopes:
|
|
797
|
-
all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, application.*, or application.patch.
|
|
797
|
+
all.Application, all.Application.bounded, all.Application.cli, all.Organization, all.Organization.bounded, all.User, all.User.bounded, all.User.cli, application.*, or application.patch.
|
|
798
798
|
|
|
799
799
|
#### Available Parameters
|
|
800
800
|
|
|
@@ -834,7 +834,7 @@ puts result
|
|
|
834
834
|
#### Authentication
|
|
835
835
|
The client must be configured with a valid api access token to call this
|
|
836
836
|
action. The token must include at least one of the following scopes:
|
|
837
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.search.
|
|
837
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, application.*, or application.search.
|
|
838
838
|
|
|
839
839
|
#### Available Parameters
|
|
840
840
|
|
data/docs/applicationApiToken.md
CHANGED
|
@@ -67,7 +67,7 @@ puts result
|
|
|
67
67
|
#### Authentication
|
|
68
68
|
The client must be configured with a valid api access token to call this
|
|
69
69
|
action. The token must include at least one of the following scopes:
|
|
70
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, applicationApiToken.*, or applicationApiToken.get.
|
|
70
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, applicationApiToken.*, or applicationApiToken.get.
|
|
71
71
|
|
|
72
72
|
#### Available Parameters
|
|
73
73
|
|
|
@@ -24,7 +24,7 @@ puts result
|
|
|
24
24
|
#### Authentication
|
|
25
25
|
The client must be configured with a valid api access token to call this
|
|
26
26
|
action. The token must include at least one of the following scopes:
|
|
27
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, applicationApiTokens.*, or applicationApiTokens.get.
|
|
27
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, applicationApiTokens.*, or applicationApiTokens.get.
|
|
28
28
|
|
|
29
29
|
#### Available Parameters
|
|
30
30
|
|
|
@@ -27,7 +27,7 @@ puts result
|
|
|
27
27
|
#### Authentication
|
|
28
28
|
The client must be configured with a valid api access token to call this
|
|
29
29
|
action. The token must include at least one of the following scopes:
|
|
30
|
-
all.Application, all.Organization, all.User, applicationCertificate.*, or applicationCertificate.delete.
|
|
30
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, applicationCertificate.*, or applicationCertificate.delete.
|
|
31
31
|
|
|
32
32
|
#### Available Parameters
|
|
33
33
|
|
|
@@ -67,7 +67,7 @@ puts result
|
|
|
67
67
|
#### Authentication
|
|
68
68
|
The client must be configured with a valid api access token to call this
|
|
69
69
|
action. The token must include at least one of the following scopes:
|
|
70
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, applicationCertificate.*, or applicationCertificate.get.
|
|
70
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, applicationCertificate.*, or applicationCertificate.get.
|
|
71
71
|
|
|
72
72
|
#### Available Parameters
|
|
73
73
|
|
|
@@ -108,7 +108,7 @@ puts result
|
|
|
108
108
|
#### Authentication
|
|
109
109
|
The client must be configured with a valid api access token to call this
|
|
110
110
|
action. The token must include at least one of the following scopes:
|
|
111
|
-
all.Application, all.Organization, all.User, applicationCertificate.*, or applicationCertificate.patch.
|
|
111
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, applicationCertificate.*, or applicationCertificate.patch.
|
|
112
112
|
|
|
113
113
|
#### Available Parameters
|
|
114
114
|
|
|
@@ -24,7 +24,7 @@ puts result
|
|
|
24
24
|
#### Authentication
|
|
25
25
|
The client must be configured with a valid api access token to call this
|
|
26
26
|
action. The token must include at least one of the following scopes:
|
|
27
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, applicationCertificateAuthorities.*, or applicationCertificateAuthorities.get.
|
|
27
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, applicationCertificateAuthorities.*, or applicationCertificateAuthorities.get.
|
|
28
28
|
|
|
29
29
|
#### Available Parameters
|
|
30
30
|
|
|
@@ -69,7 +69,7 @@ puts result
|
|
|
69
69
|
#### Authentication
|
|
70
70
|
The client must be configured with a valid api access token to call this
|
|
71
71
|
action. The token must include at least one of the following scopes:
|
|
72
|
-
all.Application, all.Organization, all.User, applicationCertificateAuthorities.*, or applicationCertificateAuthorities.post.
|
|
72
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, applicationCertificateAuthorities.*, or applicationCertificateAuthorities.post.
|
|
73
73
|
|
|
74
74
|
#### Available Parameters
|
|
75
75
|
|
|
@@ -27,7 +27,7 @@ puts result
|
|
|
27
27
|
#### Authentication
|
|
28
28
|
The client must be configured with a valid api access token to call this
|
|
29
29
|
action. The token must include at least one of the following scopes:
|
|
30
|
-
all.Application, all.Organization, all.User, applicationCertificateAuthority.*, or applicationCertificateAuthority.delete.
|
|
30
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, applicationCertificateAuthority.*, or applicationCertificateAuthority.delete.
|
|
31
31
|
|
|
32
32
|
#### Available Parameters
|
|
33
33
|
|
|
@@ -67,7 +67,7 @@ puts result
|
|
|
67
67
|
#### Authentication
|
|
68
68
|
The client must be configured with a valid api access token to call this
|
|
69
69
|
action. The token must include at least one of the following scopes:
|
|
70
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, applicationCertificateAuthority.*, or applicationCertificateAuthority.get.
|
|
70
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, applicationCertificateAuthority.*, or applicationCertificateAuthority.get.
|
|
71
71
|
|
|
72
72
|
#### Available Parameters
|
|
73
73
|
|
|
@@ -108,7 +108,7 @@ puts result
|
|
|
108
108
|
#### Authentication
|
|
109
109
|
The client must be configured with a valid api access token to call this
|
|
110
110
|
action. The token must include at least one of the following scopes:
|
|
111
|
-
all.Application, all.Organization, all.User, applicationCertificateAuthority.*, or applicationCertificateAuthority.patch.
|
|
111
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, applicationCertificateAuthority.*, or applicationCertificateAuthority.patch.
|
|
112
112
|
|
|
113
113
|
#### Available Parameters
|
|
114
114
|
|
|
@@ -24,19 +24,20 @@ puts result
|
|
|
24
24
|
#### Authentication
|
|
25
25
|
The client must be configured with a valid api access token to call this
|
|
26
26
|
action. The token must include at least one of the following scopes:
|
|
27
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, applicationCertificates.*, or applicationCertificates.get.
|
|
27
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, applicationCertificates.*, or applicationCertificates.get.
|
|
28
28
|
|
|
29
29
|
#### Available Parameters
|
|
30
30
|
|
|
31
31
|
| Name | Type | Required | Description | Default | Example |
|
|
32
32
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
|
33
33
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
|
34
|
-
| sortField | string | N | Field to sort the results by. Accepted values are: certificateInfo.commonName, status, id, creationDate, lastUpdated | certificateInfo.commonName | status |
|
|
34
|
+
| sortField | string | N | Field to sort the results by. Accepted values are: name, certificateInfo.commonName, status, id, creationDate, lastUpdated | certificateInfo.commonName | status |
|
|
35
35
|
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
|
|
36
36
|
| page | string | N | Which page of results to return | 0 | 0 |
|
|
37
37
|
| perPage | string | N | How many items to return per page | 100 | 10 |
|
|
38
|
-
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: certificateInfo.commonName, status | | status |
|
|
38
|
+
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name, certificateInfo.commonName, status | | status |
|
|
39
39
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | the*status |
|
|
40
|
+
| query | [Advanced Application Certificate Query](_schemas.md#advanced-application-certificate-query) | N | Application certificate filter JSON object which overrides the filterField and filter parameters. | | [Advanced Application Certificate Query Example](_schemas.md#advanced-application-certificate-query-example) |
|
|
40
41
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
|
41
42
|
|
|
42
43
|
#### Successful Responses
|
|
@@ -69,7 +70,7 @@ puts result
|
|
|
69
70
|
#### Authentication
|
|
70
71
|
The client must be configured with a valid api access token to call this
|
|
71
72
|
action. The token must include at least one of the following scopes:
|
|
72
|
-
all.Application, all.Organization, all.User, applicationCertificates.*, or applicationCertificates.post.
|
|
73
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, applicationCertificates.*, or applicationCertificates.post.
|
|
73
74
|
|
|
74
75
|
#### Available Parameters
|
|
75
76
|
|
|
@@ -28,7 +28,7 @@ puts result
|
|
|
28
28
|
#### Authentication
|
|
29
29
|
The client must be configured with a valid api access token to call this
|
|
30
30
|
action. The token must include at least one of the following scopes:
|
|
31
|
-
all.Application, all.Organization, all.User, applicationDashboard.*, or applicationDashboard.delete.
|
|
31
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, applicationDashboard.*, or applicationDashboard.delete.
|
|
32
32
|
|
|
33
33
|
#### Available Parameters
|
|
34
34
|
|
|
@@ -68,7 +68,7 @@ puts result
|
|
|
68
68
|
#### Authentication
|
|
69
69
|
The client must be configured with a valid api access token to call this
|
|
70
70
|
action. The token must include at least one of the following scopes:
|
|
71
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, applicationDashboard.*, or applicationDashboard.get.
|
|
71
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, applicationDashboard.*, or applicationDashboard.get.
|
|
72
72
|
|
|
73
73
|
#### Available Parameters
|
|
74
74
|
|
|
@@ -109,7 +109,7 @@ puts result
|
|
|
109
109
|
#### Authentication
|
|
110
110
|
The client must be configured with a valid api access token to call this
|
|
111
111
|
action. The token must include at least one of the following scopes:
|
|
112
|
-
all.Application, all.Organization, all.User, applicationDashboard.*, or applicationDashboard.patch.
|
|
112
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, applicationDashboard.*, or applicationDashboard.patch.
|
|
113
113
|
|
|
114
114
|
#### Available Parameters
|
|
115
115
|
|
|
@@ -124,7 +124,7 @@ all.Application, all.Organization, all.User, applicationDashboard.*, or applicat
|
|
|
124
124
|
|
|
125
125
|
| Code | Type | Description |
|
|
126
126
|
| ---- | ---- | ----------- |
|
|
127
|
-
| 200 | [Dashboard](_schemas.md#dashboard) |
|
|
127
|
+
| 200 | [Dashboard](_schemas.md#dashboard) | Updated dashboard information |
|
|
128
128
|
|
|
129
129
|
#### Error Responses
|
|
130
130
|
|
|
@@ -151,7 +151,7 @@ puts result
|
|
|
151
151
|
#### Authentication
|
|
152
152
|
The client must be configured with a valid api access token to call this
|
|
153
153
|
action. The token must include at least one of the following scopes:
|
|
154
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, applicationDashboard.*, or applicationDashboard.sendReport.
|
|
154
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, applicationDashboard.*, or applicationDashboard.sendReport.
|
|
155
155
|
|
|
156
156
|
#### Available Parameters
|
|
157
157
|
|
|
@@ -24,7 +24,7 @@ puts result
|
|
|
24
24
|
#### Authentication
|
|
25
25
|
The client must be configured with a valid api access token to call this
|
|
26
26
|
action. The token must include at least one of the following scopes:
|
|
27
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, applicationDashboards.*, or applicationDashboards.get.
|
|
27
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, applicationDashboards.*, or applicationDashboards.get.
|
|
28
28
|
|
|
29
29
|
#### Available Parameters
|
|
30
30
|
|
|
@@ -69,7 +69,7 @@ puts result
|
|
|
69
69
|
#### Authentication
|
|
70
70
|
The client must be configured with a valid api access token to call this
|
|
71
71
|
action. The token must include at least one of the following scopes:
|
|
72
|
-
all.Application, all.Organization, all.User, applicationDashboards.*, or applicationDashboards.post.
|
|
72
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, applicationDashboards.*, or applicationDashboards.post.
|
|
73
73
|
|
|
74
74
|
#### Available Parameters
|
|
75
75
|
|
data/docs/applicationJobLog.md
CHANGED
|
@@ -25,7 +25,7 @@ puts result
|
|
|
25
25
|
#### Authentication
|
|
26
26
|
The client must be configured with a valid api access token to call this
|
|
27
27
|
action. The token must include at least one of the following scopes:
|
|
28
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, applicationJobLog.*, or applicationJobLog.get.
|
|
28
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, applicationJobLog.*, or applicationJobLog.get.
|
|
29
29
|
|
|
30
30
|
#### Available Parameters
|
|
31
31
|
|
data/docs/applicationJobLogs.md
CHANGED
|
@@ -23,7 +23,7 @@ puts result
|
|
|
23
23
|
#### Authentication
|
|
24
24
|
The client must be configured with a valid api access token to call this
|
|
25
25
|
action. The token must include at least one of the following scopes:
|
|
26
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, applicationJobLogs.*, or applicationJobLogs.get.
|
|
26
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, applicationJobLogs.*, or applicationJobLogs.get.
|
|
27
27
|
|
|
28
28
|
#### Available Parameters
|
|
29
29
|
|
data/docs/applicationKey.md
CHANGED
|
@@ -27,7 +27,7 @@ puts result
|
|
|
27
27
|
#### Authentication
|
|
28
28
|
The client must be configured with a valid api access token to call this
|
|
29
29
|
action. The token must include at least one of the following scopes:
|
|
30
|
-
all.Application, all.Organization, all.User, applicationKey.*, or applicationKey.delete.
|
|
30
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, applicationKey.*, or applicationKey.delete.
|
|
31
31
|
|
|
32
32
|
#### Available Parameters
|
|
33
33
|
|
|
@@ -67,7 +67,7 @@ puts result
|
|
|
67
67
|
#### Authentication
|
|
68
68
|
The client must be configured with a valid api access token to call this
|
|
69
69
|
action. The token must include at least one of the following scopes:
|
|
70
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, applicationKey.*, or applicationKey.get.
|
|
70
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, applicationKey.*, or applicationKey.get.
|
|
71
71
|
|
|
72
72
|
#### Available Parameters
|
|
73
73
|
|
|
@@ -108,7 +108,7 @@ puts result
|
|
|
108
108
|
#### Authentication
|
|
109
109
|
The client must be configured with a valid api access token to call this
|
|
110
110
|
action. The token must include at least one of the following scopes:
|
|
111
|
-
all.Application, all.Organization, all.User, applicationKey.*, or applicationKey.patch.
|
|
111
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, applicationKey.*, or applicationKey.patch.
|
|
112
112
|
|
|
113
113
|
#### Available Parameters
|
|
114
114
|
|
data/docs/applicationKeys.md
CHANGED
|
@@ -24,7 +24,7 @@ puts result
|
|
|
24
24
|
#### Authentication
|
|
25
25
|
The client must be configured with a valid api access token to call this
|
|
26
26
|
action. The token must include at least one of the following scopes:
|
|
27
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, applicationKeys.*, or applicationKeys.get.
|
|
27
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, applicationKeys.*, or applicationKeys.get.
|
|
28
28
|
|
|
29
29
|
#### Available Parameters
|
|
30
30
|
|
|
@@ -70,7 +70,7 @@ puts result
|
|
|
70
70
|
#### Authentication
|
|
71
71
|
The client must be configured with a valid api access token to call this
|
|
72
72
|
action. The token must include at least one of the following scopes:
|
|
73
|
-
all.Application, all.Organization, all.User, applicationKeys.*, or applicationKeys.post.
|
|
73
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, applicationKeys.*, or applicationKeys.post.
|
|
74
74
|
|
|
75
75
|
#### Available Parameters
|
|
76
76
|
|
data/docs/applicationTemplate.md
CHANGED
|
@@ -23,7 +23,7 @@ puts result
|
|
|
23
23
|
#### Authentication
|
|
24
24
|
The client must be configured with a valid api access token to call this
|
|
25
25
|
action. The token must include at least one of the following scopes:
|
|
26
|
-
all.User, all.User.read, applicationTemplate.*,
|
|
26
|
+
all.User, all.User.bounded, all.User.read, applicationTemplate.*, applicationTemplate.get, only.User, only.User.bounded, or only.User.read.
|
|
27
27
|
|
|
28
28
|
#### Available Parameters
|
|
29
29
|
|
|
@@ -25,7 +25,7 @@ puts result
|
|
|
25
25
|
#### Authentication
|
|
26
26
|
The client must be configured with a valid api access token to call this
|
|
27
27
|
action. The token must include at least one of the following scopes:
|
|
28
|
-
all.User, all.User.read, applicationTemplates.*,
|
|
28
|
+
all.User, all.User.bounded, all.User.read, applicationTemplates.*, applicationTemplates.get, only.User, only.User.bounded, or only.User.read.
|
|
29
29
|
|
|
30
30
|
#### Available Parameters
|
|
31
31
|
|
|
@@ -68,7 +68,7 @@ puts result
|
|
|
68
68
|
#### Authentication
|
|
69
69
|
The client must be configured with a valid api access token to call this
|
|
70
70
|
action. The token must include at least one of the following scopes:
|
|
71
|
-
all.User, all.User.read, applicationTemplates.*,
|
|
71
|
+
all.User, all.User.bounded, all.User.read, applicationTemplates.*, applicationTemplates.getCategories, only.User, only.User.bounded, or only.User.read.
|
|
72
72
|
|
|
73
73
|
#### Available Parameters
|
|
74
74
|
|
|
@@ -104,7 +104,7 @@ puts result
|
|
|
104
104
|
#### Authentication
|
|
105
105
|
The client must be configured with a valid api access token to call this
|
|
106
106
|
action. The token must include at least one of the following scopes:
|
|
107
|
-
all.User, all.User.read, applicationTemplates.*,
|
|
107
|
+
all.User, all.User.bounded, all.User.read, applicationTemplates.*, applicationTemplates.getUniqueKeywords, only.User, only.User.bounded, or only.User.read.
|
|
108
108
|
|
|
109
109
|
#### Available Parameters
|
|
110
110
|
|
data/docs/applications.md
CHANGED
|
@@ -26,7 +26,7 @@ puts result
|
|
|
26
26
|
#### Authentication
|
|
27
27
|
The client must be configured with a valid api access token to call this
|
|
28
28
|
action. The token must include at least one of the following scopes:
|
|
29
|
-
all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, applications.*,
|
|
29
|
+
all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.cli, all.User.read, applications.*, applications.get, only.Organization, only.Organization.bounded, or only.Organization.read.
|
|
30
30
|
|
|
31
31
|
#### Available Parameters
|
|
32
32
|
|
|
@@ -70,7 +70,7 @@ puts result
|
|
|
70
70
|
#### Authentication
|
|
71
71
|
The client must be configured with a valid api access token to call this
|
|
72
72
|
action. The token must include at least one of the following scopes:
|
|
73
|
-
all.Organization, all.User, applications.*,
|
|
73
|
+
all.Organization, all.Organization.bounded, all.User, all.User.bounded, applications.*, applications.import, only.Organization, or only.Organization.bounded.
|
|
74
74
|
|
|
75
75
|
#### Available Parameters
|
|
76
76
|
|
|
@@ -99,7 +99,7 @@ all.Organization, all.User, applications.*, or applications.import.
|
|
|
99
99
|
| ---- | ---- | ----------- |
|
|
100
100
|
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
|
101
101
|
| 404 | [Error](_schemas.md#error) | Error if application is not found |
|
|
102
|
-
| 422 | [Validation
|
|
102
|
+
| 422 | [Validation Errors](_schemas.md#validation-errors) | Error if too many validation errors occurred on other resources |
|
|
103
103
|
|
|
104
104
|
<br/>
|
|
105
105
|
|
|
@@ -116,7 +116,7 @@ puts result
|
|
|
116
116
|
#### Authentication
|
|
117
117
|
The client must be configured with a valid api access token to call this
|
|
118
118
|
action. The token must include at least one of the following scopes:
|
|
119
|
-
all.Organization, all.Organization.read, all.User, all.User.read, applications.*,
|
|
119
|
+
all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, applications.*, applications.periodSummaries, only.Organization, only.Organization.bounded, or only.Organization.read.
|
|
120
120
|
|
|
121
121
|
#### Available Parameters
|
|
122
122
|
|
|
@@ -164,7 +164,7 @@ puts result
|
|
|
164
164
|
#### Authentication
|
|
165
165
|
The client must be configured with a valid api access token to call this
|
|
166
166
|
action. The token must include at least one of the following scopes:
|
|
167
|
-
all.Organization, all.User, applications.*,
|
|
167
|
+
all.Organization, all.Organization.bounded, all.User, all.User.bounded, applications.*, applications.post, only.Organization, or only.Organization.bounded.
|
|
168
168
|
|
|
169
169
|
#### Available Parameters
|
|
170
170
|
|
data/docs/auditLog.md
CHANGED
|
@@ -25,7 +25,7 @@ puts result
|
|
|
25
25
|
#### Authentication
|
|
26
26
|
The client must be configured with a valid api access token to call this
|
|
27
27
|
action. The token must include at least one of the following scopes:
|
|
28
|
-
all.Organization, all.Organization.read, all.User, all.User.read, auditLog.*,
|
|
28
|
+
all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, auditLog.*, auditLog.get, only.Organization, only.Organization.bounded, or only.Organization.read.
|
|
29
29
|
|
|
30
30
|
#### Available Parameters
|
|
31
31
|
|
data/docs/auditLogs.md
CHANGED
|
@@ -23,7 +23,7 @@ puts result
|
|
|
23
23
|
#### Authentication
|
|
24
24
|
The client must be configured with a valid api access token to call this
|
|
25
25
|
action. The token must include at least one of the following scopes:
|
|
26
|
-
all.Organization, all.Organization.read, all.User, all.User.read, auditLogs.*,
|
|
26
|
+
all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, auditLogs.*, auditLogs.get, only.Organization, only.Organization.bounded, or only.Organization.read.
|
|
27
27
|
|
|
28
28
|
#### Available Parameters
|
|
29
29
|
|
data/docs/auth.md
CHANGED
|
@@ -101,7 +101,7 @@ No api access token is required to call this action.
|
|
|
101
101
|
|
|
102
102
|
| Name | Type | Required | Description | Default | Example |
|
|
103
103
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
|
104
|
-
| oauth | [
|
|
104
|
+
| oauth | [GitHub Login](_schemas.md#github-login) | Y | User authentication credentials (access token) | | [GitHub Login Example](_schemas.md#github-login-example) |
|
|
105
105
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
|
106
106
|
|
|
107
107
|
#### Successful Responses
|