From 4d0054e942dd4b4e7d850dbc1ea0c1b69ce98293 Mon Sep 17 00:00:00 2001 From: Viacheslav Klimov Date: Thu, 20 Aug 2026 14:50:48 +0100 Subject: [PATCH] Update PE OpenAPI spec in master (from master) --- pe/docs/CfReprocessingJobConfiguration.md | 52 +++++ pe/docs/CfReprocessingJobResult.md | 57 +++++ pe/docs/DeviceProfile.md | 66 +++++- pe/docs/DeviceProfileData.md | 66 +++++- .../DeviceProfileTransportConfiguration.md | 66 +++++- pe/docs/DummyJobConfiguration.md | 57 +++++ pe/docs/DummyJobResult.md | 57 +++++ pe/docs/Job.md | 28 +++ pe/docs/JobConfiguration.md | 46 ++++ pe/docs/JobResult.md | 34 +++ pe/docs/LwM2MBootstrapServerCredential.md | 66 ++++++ ...wm2mDeviceProfileTransportConfiguration.md | 66 +++++- pe/docs/PageDataDeviceProfile.md | 66 +++++- pe/docs/PageDataJob.md | 28 +++ pe/docs/ReportJobConfiguration.md | 46 ++++ pe/docs/ReportJobResult.md | 34 +++ pe/docs/TaskResult.md | 61 ++++++ pe/docs/TelemetryMappingConfiguration.md | 2 +- pe/docs/TelemetryObserveStrategy.md | 8 +- pe/spec/openapi.json | 201 ++++++++++++++++-- .../org/thingsboard/client/ApiClient.java | 4 +- .../model/LwM2MBootstrapServerCredential.java | 16 +- .../thingsboard/client/model/TaskResult.java | 12 +- .../model/TelemetryObserveStrategy.java | 8 +- 24 files changed, 1105 insertions(+), 42 deletions(-) diff --git a/pe/docs/CfReprocessingJobConfiguration.md b/pe/docs/CfReprocessingJobConfiguration.md index 3d64a25c..e483d6fe 100644 --- a/pe/docs/CfReprocessingJobConfiguration.md +++ b/pe/docs/CfReprocessingJobConfiguration.md @@ -37,9 +37,61 @@ | error | String | | [optional] | | jobType | String | | | +#### CfReprocessingTaskResult *(extends TaskResult, jobType=`CF_REPROCESSING`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | CfReprocessingTaskFailure | | [optional] | + +#### DummyTaskResult *(extends TaskResult, jobType=`DUMMY`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | DummyTaskFailure | | [optional] | + +#### ReportTaskResult *(extends TaskResult, jobType=`REPORT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| report | Report | | [optional] | + #### EntityType (enum) `TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (46 values total) +#### CfReprocessingTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | String | | [optional] | +| entityInfo | EntityInfo | | [optional] | + +#### Report +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | ReportId | | [optional] | +| createdTime | Long | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] | +| tenantId | TenantId | | | +| customerId | CustomerId | | [optional] | +| templateId | ReportTemplateId | | | +| format | TbReportFormat | | | +| name | String | | | +| userId | UserId | | | +| publicKey | String | | [optional] | +| ownerId | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] | +| _public | Boolean | | [optional] | + +#### DummyTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | String | | [optional] | +| number | Integer | | [optional] | +| failAlways | Boolean | | [optional] | + +#### EntityInfo +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | EntityId | JSON object with the entity Id. | [optional] | +| name | String | Entity Name | [optional] | + +#### TbReportFormat (enum) +`PDF` | `CSV` + --- ### Conventions diff --git a/pe/docs/CfReprocessingJobResult.md b/pe/docs/CfReprocessingJobResult.md index 8aa3b262..a8edcc86 100644 --- a/pe/docs/CfReprocessingJobResult.md +++ b/pe/docs/CfReprocessingJobResult.md @@ -14,6 +14,8 @@ ## Referenced Types +> **EntityId types** (`AdminSettingsId`, `AiModelId`, `AlarmId`, `ApiKeyId`, `ApiUsageStateId`, `AssetId`, `AssetProfileId`, `BlobEntityId`, `CalculatedFieldId`, `ConverterId`, `CustomerId`, `DashboardId`, `DeviceId`, `DeviceProfileId`, `DomainId`, `EdgeId`, `EntityGroupId`, `EntityViewId`, `GroupPermissionId`, `IntegrationId`, `JobId`, `MobileAppBundleId`, `MobileAppId`, `NotificationId`, `NotificationRequestId`, `NotificationRuleId`, `NotificationTargetId`, `NotificationTemplateId`, `OAuth2ClientId`, `OtaPackageId`, `QueueId`, `QueueStatsId`, `ReportId`, `ReportTemplateId`, `RoleId`, `RpcId`, `RuleChainId`, `RuleNodeId`, `SchedulerEventId`, `SecretId`, `TbResourceId`, `TenantId`, `TenantProfileId`, `UserId`, `WidgetTypeId`, `WidgetsBundleId`, etc.): `{entityType: EntityType, id: UUID}` — all EntityId subtypes share this structure. + #### JobResult | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -38,6 +40,61 @@ | error | String | | [optional] | | jobType | String | | | +#### CfReprocessingTaskResult *(extends TaskResult, jobType=`CF_REPROCESSING`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | CfReprocessingTaskFailure | | [optional] | + +#### DummyTaskResult *(extends TaskResult, jobType=`DUMMY`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | DummyTaskFailure | | [optional] | + +#### ReportTaskResult *(extends TaskResult, jobType=`REPORT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| report | Report | | [optional] | + +#### CfReprocessingTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | String | | [optional] | +| entityInfo | EntityInfo | | [optional] | + +#### Report +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | ReportId | | [optional] | +| createdTime | Long | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] | +| tenantId | TenantId | | | +| customerId | CustomerId | | [optional] | +| templateId | ReportTemplateId | | | +| format | TbReportFormat | | | +| name | String | | | +| userId | UserId | | | +| publicKey | String | | [optional] | +| ownerId | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] | +| _public | Boolean | | [optional] | + +#### DummyTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | String | | [optional] | +| number | Integer | | [optional] | +| failAlways | Boolean | | [optional] | + +#### EntityInfo +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | EntityId | JSON object with the entity Id. | [optional] | +| name | String | Entity Name | [optional] | + +#### TbReportFormat (enum) +`PDF` | `CSV` + +#### EntityType (enum) +`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (46 values total) + --- ### Conventions diff --git a/pe/docs/DeviceProfile.md b/pe/docs/DeviceProfile.md index 6ab5d53b..f3614b71 100644 --- a/pe/docs/DeviceProfile.md +++ b/pe/docs/DeviceProfile.md @@ -157,6 +157,70 @@ A JSON value representing the device profile. |------|------|-------------|-------| | securityMode | String | | | +#### NoSecLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, securityMode=`NO_SEC`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| shortServerId | Integer | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrapServerIs | Boolean | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | String | Host for 'No Security' mode | [optional] [readonly] | +| port | Integer | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| clientHoldOffTime | Integer | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| serverPublicKey | String | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| serverCertificate | String | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrapServerAccountTimeout | Integer | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | Integer | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| defaultMinPeriod | Integer | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notifIfDisabled | Boolean | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | String | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### PSKLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, securityMode=`PSK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| shortServerId | Integer | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrapServerIs | Boolean | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | String | Host for 'No Security' mode | [optional] [readonly] | +| port | Integer | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| clientHoldOffTime | Integer | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| serverPublicKey | String | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| serverCertificate | String | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrapServerAccountTimeout | Integer | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | Integer | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| defaultMinPeriod | Integer | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notifIfDisabled | Boolean | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | String | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### RPKLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, securityMode=`RPK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| shortServerId | Integer | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrapServerIs | Boolean | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | String | Host for 'No Security' mode | [optional] [readonly] | +| port | Integer | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| clientHoldOffTime | Integer | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| serverPublicKey | String | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| serverCertificate | String | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrapServerAccountTimeout | Integer | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | Integer | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| defaultMinPeriod | Integer | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notifIfDisabled | Boolean | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | String | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### X509LwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, securityMode=`X509`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| shortServerId | Integer | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrapServerIs | Boolean | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | String | Host for 'No Security' mode | [optional] [readonly] | +| port | Integer | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| clientHoldOffTime | Integer | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| serverPublicKey | String | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| serverCertificate | String | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrapServerAccountTimeout | Integer | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | Integer | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| defaultMinPeriod | Integer | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notifIfDisabled | Boolean | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | String | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + #### OtherConfiguration | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -242,7 +306,7 @@ A JSON value representing the device profile. | epmax | Long | | [optional] | #### TelemetryObserveStrategy (enum) -`SINGLE_0_ONE_RESOURCE_EQUALS_ONE_SINGLE_OBSERVE_REQUEST` | `COMPOSITE_ALL_1_ALL_RESOURCES_IN_ONE_COMPOSITE_OBSERVE_REQUEST` | `COMPOSITE_BY_OBJECT_2_GROUPED_COMPOSITE_OBSERVE_REQUESTS_BY_OBJECT` +`SINGLE` | `COMPOSITE_ALL` | `COMPOSITE_BY_OBJECT` #### PowerMode (enum) `PSM` | `DRX` | `E_DRX` diff --git a/pe/docs/DeviceProfileData.md b/pe/docs/DeviceProfileData.md index 1cd7c923..e07f0377 100644 --- a/pe/docs/DeviceProfileData.md +++ b/pe/docs/DeviceProfileData.md @@ -118,6 +118,70 @@ |------|------|-------------|-------| | securityMode | String | | | +#### NoSecLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, securityMode=`NO_SEC`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| shortServerId | Integer | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrapServerIs | Boolean | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | String | Host for 'No Security' mode | [optional] [readonly] | +| port | Integer | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| clientHoldOffTime | Integer | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| serverPublicKey | String | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| serverCertificate | String | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrapServerAccountTimeout | Integer | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | Integer | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| defaultMinPeriod | Integer | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notifIfDisabled | Boolean | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | String | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### PSKLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, securityMode=`PSK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| shortServerId | Integer | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrapServerIs | Boolean | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | String | Host for 'No Security' mode | [optional] [readonly] | +| port | Integer | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| clientHoldOffTime | Integer | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| serverPublicKey | String | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| serverCertificate | String | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrapServerAccountTimeout | Integer | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | Integer | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| defaultMinPeriod | Integer | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notifIfDisabled | Boolean | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | String | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### RPKLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, securityMode=`RPK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| shortServerId | Integer | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrapServerIs | Boolean | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | String | Host for 'No Security' mode | [optional] [readonly] | +| port | Integer | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| clientHoldOffTime | Integer | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| serverPublicKey | String | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| serverCertificate | String | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrapServerAccountTimeout | Integer | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | Integer | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| defaultMinPeriod | Integer | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notifIfDisabled | Boolean | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | String | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### X509LwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, securityMode=`X509`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| shortServerId | Integer | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrapServerIs | Boolean | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | String | Host for 'No Security' mode | [optional] [readonly] | +| port | Integer | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| clientHoldOffTime | Integer | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| serverPublicKey | String | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| serverCertificate | String | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrapServerAccountTimeout | Integer | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | Integer | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| defaultMinPeriod | Integer | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notifIfDisabled | Boolean | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | String | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + #### OtherConfiguration | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -203,7 +267,7 @@ | epmax | Long | | [optional] | #### TelemetryObserveStrategy (enum) -`SINGLE_0_ONE_RESOURCE_EQUALS_ONE_SINGLE_OBSERVE_REQUEST` | `COMPOSITE_ALL_1_ALL_RESOURCES_IN_ONE_COMPOSITE_OBSERVE_REQUEST` | `COMPOSITE_BY_OBJECT_2_GROUPED_COMPOSITE_OBSERVE_REQUESTS_BY_OBJECT` +`SINGLE` | `COMPOSITE_ALL` | `COMPOSITE_BY_OBJECT` #### PowerMode (enum) `PSM` | `DRX` | `E_DRX` diff --git a/pe/docs/DeviceProfileTransportConfiguration.md b/pe/docs/DeviceProfileTransportConfiguration.md index 67dc48a4..6e35f4b3 100644 --- a/pe/docs/DeviceProfileTransportConfiguration.md +++ b/pe/docs/DeviceProfileTransportConfiguration.md @@ -89,6 +89,70 @@ Configuration for device profile transport |------|------|-------------|-------| | securityMode | String | | | +#### NoSecLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, securityMode=`NO_SEC`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| shortServerId | Integer | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrapServerIs | Boolean | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | String | Host for 'No Security' mode | [optional] [readonly] | +| port | Integer | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| clientHoldOffTime | Integer | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| serverPublicKey | String | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| serverCertificate | String | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrapServerAccountTimeout | Integer | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | Integer | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| defaultMinPeriod | Integer | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notifIfDisabled | Boolean | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | String | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### PSKLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, securityMode=`PSK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| shortServerId | Integer | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrapServerIs | Boolean | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | String | Host for 'No Security' mode | [optional] [readonly] | +| port | Integer | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| clientHoldOffTime | Integer | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| serverPublicKey | String | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| serverCertificate | String | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrapServerAccountTimeout | Integer | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | Integer | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| defaultMinPeriod | Integer | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notifIfDisabled | Boolean | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | String | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### RPKLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, securityMode=`RPK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| shortServerId | Integer | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrapServerIs | Boolean | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | String | Host for 'No Security' mode | [optional] [readonly] | +| port | Integer | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| clientHoldOffTime | Integer | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| serverPublicKey | String | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| serverCertificate | String | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrapServerAccountTimeout | Integer | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | Integer | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| defaultMinPeriod | Integer | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notifIfDisabled | Boolean | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | String | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### X509LwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, securityMode=`X509`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| shortServerId | Integer | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrapServerIs | Boolean | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | String | Host for 'No Security' mode | [optional] [readonly] | +| port | Integer | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| clientHoldOffTime | Integer | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| serverPublicKey | String | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| serverCertificate | String | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrapServerAccountTimeout | Integer | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | Integer | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| defaultMinPeriod | Integer | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notifIfDisabled | Boolean | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | String | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + #### OtherConfiguration | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -174,7 +238,7 @@ Configuration for device profile transport | epmax | Long | | [optional] | #### TelemetryObserveStrategy (enum) -`SINGLE_0_ONE_RESOURCE_EQUALS_ONE_SINGLE_OBSERVE_REQUEST` | `COMPOSITE_ALL_1_ALL_RESOURCES_IN_ONE_COMPOSITE_OBSERVE_REQUEST` | `COMPOSITE_BY_OBJECT_2_GROUPED_COMPOSITE_OBSERVE_REQUESTS_BY_OBJECT` +`SINGLE` | `COMPOSITE_ALL` | `COMPOSITE_BY_OBJECT` #### SnmpCommunicationSpec (enum) `TELEMETRY_QUERYING` | `CLIENT_ATTRIBUTES_QUERYING` | `SHARED_ATTRIBUTES_SETTING` | `TO_DEVICE_RPC_REQUEST` | `TO_SERVER_RPC_REQUEST` diff --git a/pe/docs/DummyJobConfiguration.md b/pe/docs/DummyJobConfiguration.md index b0ed8861..6f6a7e92 100644 --- a/pe/docs/DummyJobConfiguration.md +++ b/pe/docs/DummyJobConfiguration.md @@ -25,6 +25,8 @@ Dummy job configuration ## Referenced Types +> **EntityId types** (`AdminSettingsId`, `AiModelId`, `AlarmId`, `ApiKeyId`, `ApiUsageStateId`, `AssetId`, `AssetProfileId`, `BlobEntityId`, `CalculatedFieldId`, `ConverterId`, `CustomerId`, `DashboardId`, `DeviceId`, `DeviceProfileId`, `DomainId`, `EdgeId`, `EntityGroupId`, `EntityViewId`, `GroupPermissionId`, `IntegrationId`, `JobId`, `MobileAppBundleId`, `MobileAppId`, `NotificationId`, `NotificationRequestId`, `NotificationRuleId`, `NotificationTargetId`, `NotificationTemplateId`, `OAuth2ClientId`, `OtaPackageId`, `QueueId`, `QueueStatsId`, `ReportId`, `ReportTemplateId`, `RoleId`, `RpcId`, `RuleChainId`, `RuleNodeId`, `SchedulerEventId`, `SecretId`, `TbResourceId`, `TenantId`, `TenantProfileId`, `UserId`, `WidgetTypeId`, `WidgetsBundleId`, etc.): `{entityType: EntityType, id: UUID}` — all EntityId subtypes share this structure. + #### JobConfiguration | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -42,6 +44,61 @@ Dummy job configuration | error | String | | [optional] | | jobType | String | | | +#### CfReprocessingTaskResult *(extends TaskResult, jobType=`CF_REPROCESSING`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | CfReprocessingTaskFailure | | [optional] | + +#### DummyTaskResult *(extends TaskResult, jobType=`DUMMY`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | DummyTaskFailure | | [optional] | + +#### ReportTaskResult *(extends TaskResult, jobType=`REPORT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| report | Report | | [optional] | + +#### CfReprocessingTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | String | | [optional] | +| entityInfo | EntityInfo | | [optional] | + +#### Report +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | ReportId | | [optional] | +| createdTime | Long | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] | +| tenantId | TenantId | | | +| customerId | CustomerId | | [optional] | +| templateId | ReportTemplateId | | | +| format | TbReportFormat | | | +| name | String | | | +| userId | UserId | | | +| publicKey | String | | [optional] | +| ownerId | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] | +| _public | Boolean | | [optional] | + +#### DummyTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | String | | [optional] | +| number | Integer | | [optional] | +| failAlways | Boolean | | [optional] | + +#### EntityInfo +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | EntityId | JSON object with the entity Id. | [optional] | +| name | String | Entity Name | [optional] | + +#### TbReportFormat (enum) +`PDF` | `CSV` + +#### EntityType (enum) +`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (46 values total) + --- ### Conventions diff --git a/pe/docs/DummyJobResult.md b/pe/docs/DummyJobResult.md index 61368c91..23b52de9 100644 --- a/pe/docs/DummyJobResult.md +++ b/pe/docs/DummyJobResult.md @@ -14,6 +14,8 @@ ## Referenced Types +> **EntityId types** (`AdminSettingsId`, `AiModelId`, `AlarmId`, `ApiKeyId`, `ApiUsageStateId`, `AssetId`, `AssetProfileId`, `BlobEntityId`, `CalculatedFieldId`, `ConverterId`, `CustomerId`, `DashboardId`, `DeviceId`, `DeviceProfileId`, `DomainId`, `EdgeId`, `EntityGroupId`, `EntityViewId`, `GroupPermissionId`, `IntegrationId`, `JobId`, `MobileAppBundleId`, `MobileAppId`, `NotificationId`, `NotificationRequestId`, `NotificationRuleId`, `NotificationTargetId`, `NotificationTemplateId`, `OAuth2ClientId`, `OtaPackageId`, `QueueId`, `QueueStatsId`, `ReportId`, `ReportTemplateId`, `RoleId`, `RpcId`, `RuleChainId`, `RuleNodeId`, `SchedulerEventId`, `SecretId`, `TbResourceId`, `TenantId`, `TenantProfileId`, `UserId`, `WidgetTypeId`, `WidgetsBundleId`, etc.): `{entityType: EntityType, id: UUID}` — all EntityId subtypes share this structure. + #### JobResult | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -38,6 +40,61 @@ | error | String | | [optional] | | jobType | String | | | +#### CfReprocessingTaskResult *(extends TaskResult, jobType=`CF_REPROCESSING`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | CfReprocessingTaskFailure | | [optional] | + +#### DummyTaskResult *(extends TaskResult, jobType=`DUMMY`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | DummyTaskFailure | | [optional] | + +#### ReportTaskResult *(extends TaskResult, jobType=`REPORT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| report | Report | | [optional] | + +#### CfReprocessingTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | String | | [optional] | +| entityInfo | EntityInfo | | [optional] | + +#### Report +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | ReportId | | [optional] | +| createdTime | Long | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] | +| tenantId | TenantId | | | +| customerId | CustomerId | | [optional] | +| templateId | ReportTemplateId | | | +| format | TbReportFormat | | | +| name | String | | | +| userId | UserId | | | +| publicKey | String | | [optional] | +| ownerId | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] | +| _public | Boolean | | [optional] | + +#### DummyTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | String | | [optional] | +| number | Integer | | [optional] | +| failAlways | Boolean | | [optional] | + +#### EntityInfo +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | EntityId | JSON object with the entity Id. | [optional] | +| name | String | Entity Name | [optional] | + +#### TbReportFormat (enum) +`PDF` | `CSV` + +#### EntityType (enum) +`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (46 values total) + --- ### Conventions diff --git a/pe/docs/Job.md b/pe/docs/Job.md index cb526571..a6ccbf9f 100644 --- a/pe/docs/Job.md +++ b/pe/docs/Job.md @@ -114,6 +114,21 @@ | error | String | | [optional] | | jobType | String | | | +#### CfReprocessingTaskResult *(extends TaskResult, jobType=`CF_REPROCESSING`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | CfReprocessingTaskFailure | | [optional] | + +#### DummyTaskResult *(extends TaskResult, jobType=`DUMMY`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | DummyTaskFailure | | [optional] | + +#### ReportTaskResult *(extends TaskResult, jobType=`REPORT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| report | Report | | [optional] | + #### NotificationRequest | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -168,6 +183,19 @@ | ownerId | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] | | _public | Boolean | | [optional] | +#### CfReprocessingTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | String | | [optional] | +| entityInfo | EntityInfo | | [optional] | + +#### DummyTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | String | | [optional] | +| number | Integer | | [optional] | +| failAlways | Boolean | | [optional] | + #### NotificationTemplate | Name | Type | Description | Notes | |------|------|-------------|-------| diff --git a/pe/docs/JobConfiguration.md b/pe/docs/JobConfiguration.md index bcf8f456..8a5d2eee 100644 --- a/pe/docs/JobConfiguration.md +++ b/pe/docs/JobConfiguration.md @@ -66,6 +66,21 @@ | error | String | | [optional] | | jobType | String | | | +#### CfReprocessingTaskResult *(extends TaskResult, jobType=`CF_REPROCESSING`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | CfReprocessingTaskFailure | | [optional] | + +#### DummyTaskResult *(extends TaskResult, jobType=`DUMMY`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | DummyTaskFailure | | [optional] | + +#### ReportTaskResult *(extends TaskResult, jobType=`REPORT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| report | Report | | [optional] | + #### NotificationRequest | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -150,6 +165,34 @@ | allEnabled | Boolean | Debug All. Used as a trigger for updating debugAllUntil. | [optional] | | allEnabledUntil | Long | Timestamp of the end time for the processing debug events. | [optional] | +#### CfReprocessingTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | String | | [optional] | +| entityInfo | EntityInfo | | [optional] | + +#### Report +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | ReportId | | [optional] | +| createdTime | Long | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] | +| tenantId | TenantId | | | +| customerId | CustomerId | | [optional] | +| templateId | ReportTemplateId | | | +| format | TbReportFormat | | | +| name | String | | | +| userId | UserId | | | +| publicKey | String | | [optional] | +| ownerId | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] | +| _public | Boolean | | [optional] | + +#### DummyTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | String | | [optional] | +| number | Integer | | [optional] | +| failAlways | Boolean | | [optional] | + #### NotificationType (enum) `GENERAL` | `ALARM` | `DEVICE_ACTIVITY` | `ENTITY_ACTION` | `ALARM_COMMENT` | `RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT` | `ALARM_ASSIGNMENT` | `NEW_PLATFORM_VERSION` | `ENTITIES_LIMIT` | `ENTITIES_LIMIT_INCREASE_REQUEST` | … (22 values total) @@ -163,6 +206,9 @@ | timezone | String | | [optional] | | makePublic | Boolean | | [optional] | +#### TbReportFormat (enum) +`PDF` | `CSV` + #### DeliveryMethodNotificationTemplate | Name | Type | Description | Notes | |------|------|-------------|-------| diff --git a/pe/docs/JobResult.md b/pe/docs/JobResult.md index a54a65da..ff319d16 100644 --- a/pe/docs/JobResult.md +++ b/pe/docs/JobResult.md @@ -49,6 +49,21 @@ Job execution result | error | String | | [optional] | | jobType | String | | | +#### CfReprocessingTaskResult *(extends TaskResult, jobType=`CF_REPROCESSING`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | CfReprocessingTaskFailure | | [optional] | + +#### DummyTaskResult *(extends TaskResult, jobType=`DUMMY`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | DummyTaskFailure | | [optional] | + +#### ReportTaskResult *(extends TaskResult, jobType=`REPORT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| report | Report | | [optional] | + #### Report | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -67,9 +82,28 @@ Job execution result #### TbReportFormat (enum) `PDF` | `CSV` +#### CfReprocessingTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | String | | [optional] | +| entityInfo | EntityInfo | | [optional] | + +#### DummyTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | String | | [optional] | +| number | Integer | | [optional] | +| failAlways | Boolean | | [optional] | + #### EntityType (enum) `TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (46 values total) +#### EntityInfo +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | EntityId | JSON object with the entity Id. | [optional] | +| name | String | Entity Name | [optional] | + --- ### Conventions diff --git a/pe/docs/LwM2MBootstrapServerCredential.md b/pe/docs/LwM2MBootstrapServerCredential.md index 6f3c66e5..ce4ea705 100644 --- a/pe/docs/LwM2MBootstrapServerCredential.md +++ b/pe/docs/LwM2MBootstrapServerCredential.md @@ -11,6 +11,72 @@ +## Subtypes + +#### NoSecLwM2MBootstrapServerCredential *(securityMode=`NO_SEC`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| shortServerId | Integer | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrapServerIs | Boolean | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | String | Host for 'No Security' mode | [optional] [readonly] | +| port | Integer | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| clientHoldOffTime | Integer | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| serverPublicKey | String | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| serverCertificate | String | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrapServerAccountTimeout | Integer | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | Integer | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| defaultMinPeriod | Integer | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notifIfDisabled | Boolean | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | String | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### PSKLwM2MBootstrapServerCredential *(securityMode=`PSK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| shortServerId | Integer | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrapServerIs | Boolean | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | String | Host for 'No Security' mode | [optional] [readonly] | +| port | Integer | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| clientHoldOffTime | Integer | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| serverPublicKey | String | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| serverCertificate | String | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrapServerAccountTimeout | Integer | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | Integer | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| defaultMinPeriod | Integer | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notifIfDisabled | Boolean | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | String | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### RPKLwM2MBootstrapServerCredential *(securityMode=`RPK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| shortServerId | Integer | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrapServerIs | Boolean | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | String | Host for 'No Security' mode | [optional] [readonly] | +| port | Integer | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| clientHoldOffTime | Integer | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| serverPublicKey | String | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| serverCertificate | String | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrapServerAccountTimeout | Integer | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | Integer | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| defaultMinPeriod | Integer | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notifIfDisabled | Boolean | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | String | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### X509LwM2MBootstrapServerCredential *(securityMode=`X509`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| shortServerId | Integer | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrapServerIs | Boolean | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | String | Host for 'No Security' mode | [optional] [readonly] | +| port | Integer | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| clientHoldOffTime | Integer | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| serverPublicKey | String | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| serverCertificate | String | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrapServerAccountTimeout | Integer | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | Integer | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| defaultMinPeriod | Integer | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notifIfDisabled | Boolean | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | String | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + --- ### Conventions diff --git a/pe/docs/Lwm2mDeviceProfileTransportConfiguration.md b/pe/docs/Lwm2mDeviceProfileTransportConfiguration.md index a8b029d7..78091d6f 100644 --- a/pe/docs/Lwm2mDeviceProfileTransportConfiguration.md +++ b/pe/docs/Lwm2mDeviceProfileTransportConfiguration.md @@ -39,6 +39,70 @@ |------|------|-------------|-------| | securityMode | String | | | +#### NoSecLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, securityMode=`NO_SEC`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| shortServerId | Integer | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrapServerIs | Boolean | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | String | Host for 'No Security' mode | [optional] [readonly] | +| port | Integer | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| clientHoldOffTime | Integer | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| serverPublicKey | String | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| serverCertificate | String | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrapServerAccountTimeout | Integer | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | Integer | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| defaultMinPeriod | Integer | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notifIfDisabled | Boolean | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | String | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### PSKLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, securityMode=`PSK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| shortServerId | Integer | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrapServerIs | Boolean | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | String | Host for 'No Security' mode | [optional] [readonly] | +| port | Integer | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| clientHoldOffTime | Integer | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| serverPublicKey | String | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| serverCertificate | String | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrapServerAccountTimeout | Integer | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | Integer | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| defaultMinPeriod | Integer | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notifIfDisabled | Boolean | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | String | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### RPKLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, securityMode=`RPK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| shortServerId | Integer | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrapServerIs | Boolean | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | String | Host for 'No Security' mode | [optional] [readonly] | +| port | Integer | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| clientHoldOffTime | Integer | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| serverPublicKey | String | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| serverCertificate | String | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrapServerAccountTimeout | Integer | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | Integer | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| defaultMinPeriod | Integer | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notifIfDisabled | Boolean | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | String | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### X509LwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, securityMode=`X509`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| shortServerId | Integer | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrapServerIs | Boolean | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | String | Host for 'No Security' mode | [optional] [readonly] | +| port | Integer | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| clientHoldOffTime | Integer | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| serverPublicKey | String | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| serverCertificate | String | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrapServerAccountTimeout | Integer | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | Integer | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| defaultMinPeriod | Integer | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notifIfDisabled | Boolean | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | String | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + #### OtherConfiguration | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -71,7 +135,7 @@ | epmax | Long | | [optional] | #### TelemetryObserveStrategy (enum) -`SINGLE_0_ONE_RESOURCE_EQUALS_ONE_SINGLE_OBSERVE_REQUEST` | `COMPOSITE_ALL_1_ALL_RESOURCES_IN_ONE_COMPOSITE_OBSERVE_REQUEST` | `COMPOSITE_BY_OBJECT_2_GROUPED_COMPOSITE_OBSERVE_REQUESTS_BY_OBJECT` +`SINGLE` | `COMPOSITE_ALL` | `COMPOSITE_BY_OBJECT` #### PowerMode (enum) `PSM` | `DRX` | `E_DRX` diff --git a/pe/docs/PageDataDeviceProfile.md b/pe/docs/PageDataDeviceProfile.md index 04e73764..bba6fb58 100644 --- a/pe/docs/PageDataDeviceProfile.md +++ b/pe/docs/PageDataDeviceProfile.md @@ -163,6 +163,70 @@ |------|------|-------------|-------| | securityMode | String | | | +#### NoSecLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, securityMode=`NO_SEC`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| shortServerId | Integer | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrapServerIs | Boolean | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | String | Host for 'No Security' mode | [optional] [readonly] | +| port | Integer | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| clientHoldOffTime | Integer | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| serverPublicKey | String | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| serverCertificate | String | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrapServerAccountTimeout | Integer | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | Integer | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| defaultMinPeriod | Integer | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notifIfDisabled | Boolean | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | String | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### PSKLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, securityMode=`PSK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| shortServerId | Integer | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrapServerIs | Boolean | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | String | Host for 'No Security' mode | [optional] [readonly] | +| port | Integer | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| clientHoldOffTime | Integer | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| serverPublicKey | String | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| serverCertificate | String | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrapServerAccountTimeout | Integer | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | Integer | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| defaultMinPeriod | Integer | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notifIfDisabled | Boolean | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | String | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### RPKLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, securityMode=`RPK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| shortServerId | Integer | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrapServerIs | Boolean | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | String | Host for 'No Security' mode | [optional] [readonly] | +| port | Integer | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| clientHoldOffTime | Integer | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| serverPublicKey | String | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| serverCertificate | String | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrapServerAccountTimeout | Integer | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | Integer | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| defaultMinPeriod | Integer | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notifIfDisabled | Boolean | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | String | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### X509LwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, securityMode=`X509`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| shortServerId | Integer | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrapServerIs | Boolean | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | String | Host for 'No Security' mode | [optional] [readonly] | +| port | Integer | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| clientHoldOffTime | Integer | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| serverPublicKey | String | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| serverCertificate | String | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrapServerAccountTimeout | Integer | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | Integer | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| defaultMinPeriod | Integer | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notifIfDisabled | Boolean | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | String | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + #### OtherConfiguration | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -248,7 +312,7 @@ | epmax | Long | | [optional] | #### TelemetryObserveStrategy (enum) -`SINGLE_0_ONE_RESOURCE_EQUALS_ONE_SINGLE_OBSERVE_REQUEST` | `COMPOSITE_ALL_1_ALL_RESOURCES_IN_ONE_COMPOSITE_OBSERVE_REQUEST` | `COMPOSITE_BY_OBJECT_2_GROUPED_COMPOSITE_OBSERVE_REQUESTS_BY_OBJECT` +`SINGLE` | `COMPOSITE_ALL` | `COMPOSITE_BY_OBJECT` #### PowerMode (enum) `PSM` | `DRX` | `E_DRX` diff --git a/pe/docs/PageDataJob.md b/pe/docs/PageDataJob.md index 2f4c61a8..52ff9109 100644 --- a/pe/docs/PageDataJob.md +++ b/pe/docs/PageDataJob.md @@ -122,6 +122,21 @@ | error | String | | [optional] | | jobType | String | | | +#### CfReprocessingTaskResult *(extends TaskResult, jobType=`CF_REPROCESSING`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | CfReprocessingTaskFailure | | [optional] | + +#### DummyTaskResult *(extends TaskResult, jobType=`DUMMY`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | DummyTaskFailure | | [optional] | + +#### ReportTaskResult *(extends TaskResult, jobType=`REPORT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| report | Report | | [optional] | + #### NotificationRequest | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -176,6 +191,19 @@ | ownerId | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] | | _public | Boolean | | [optional] | +#### CfReprocessingTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | String | | [optional] | +| entityInfo | EntityInfo | | [optional] | + +#### DummyTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | String | | [optional] | +| number | Integer | | [optional] | +| failAlways | Boolean | | [optional] | + #### NotificationTemplate | Name | Type | Description | Notes | |------|------|-------------|-------| diff --git a/pe/docs/ReportJobConfiguration.md b/pe/docs/ReportJobConfiguration.md index 4a7af441..cfe47016 100644 --- a/pe/docs/ReportJobConfiguration.md +++ b/pe/docs/ReportJobConfiguration.md @@ -84,6 +84,21 @@ | error | String | | [optional] | | jobType | String | | | +#### CfReprocessingTaskResult *(extends TaskResult, jobType=`CF_REPROCESSING`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | CfReprocessingTaskFailure | | [optional] | + +#### DummyTaskResult *(extends TaskResult, jobType=`DUMMY`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | DummyTaskFailure | | [optional] | + +#### ReportTaskResult *(extends TaskResult, jobType=`REPORT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| report | Report | | [optional] | + #### NotificationTemplate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -142,6 +157,34 @@ | timezone | String | | [optional] | | makePublic | Boolean | | [optional] | +#### CfReprocessingTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | String | | [optional] | +| entityInfo | EntityInfo | | [optional] | + +#### Report +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | ReportId | | [optional] | +| createdTime | Long | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] | +| tenantId | TenantId | | | +| customerId | CustomerId | | [optional] | +| templateId | ReportTemplateId | | | +| format | TbReportFormat | | | +| name | String | | | +| userId | UserId | | | +| publicKey | String | | [optional] | +| ownerId | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] | +| _public | Boolean | | [optional] | + +#### DummyTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | String | | [optional] | +| number | Integer | | [optional] | +| failAlways | Boolean | | [optional] | + #### DeliveryMethodNotificationTemplate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -179,6 +222,9 @@ | subject | String | Subject line for the web notification | | | additionalConfig | com.fasterxml.jackson.databind.JsonNode | Additional JSON configuration for web buttons/actions | [optional] | +#### TbReportFormat (enum) +`PDF` | `CSV` + #### Button | Name | Type | Description | Notes | |------|------|-------------|-------| diff --git a/pe/docs/ReportJobResult.md b/pe/docs/ReportJobResult.md index 08d27a65..421533be 100644 --- a/pe/docs/ReportJobResult.md +++ b/pe/docs/ReportJobResult.md @@ -56,12 +56,46 @@ | error | String | | [optional] | | jobType | String | | | +#### CfReprocessingTaskResult *(extends TaskResult, jobType=`CF_REPROCESSING`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | CfReprocessingTaskFailure | | [optional] | + +#### DummyTaskResult *(extends TaskResult, jobType=`DUMMY`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | DummyTaskFailure | | [optional] | + +#### ReportTaskResult *(extends TaskResult, jobType=`REPORT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| report | Report | | [optional] | + #### TbReportFormat (enum) `PDF` | `CSV` #### EntityType (enum) `TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (46 values total) +#### CfReprocessingTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | String | | [optional] | +| entityInfo | EntityInfo | | [optional] | + +#### DummyTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | String | | [optional] | +| number | Integer | | [optional] | +| failAlways | Boolean | | [optional] | + +#### EntityInfo +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | EntityId | JSON object with the entity Id. | [optional] | +| name | String | Entity Name | [optional] | + --- ### Conventions diff --git a/pe/docs/TaskResult.md b/pe/docs/TaskResult.md index 9f87bdbf..0940d6f6 100644 --- a/pe/docs/TaskResult.md +++ b/pe/docs/TaskResult.md @@ -16,6 +16,67 @@ +## Subtypes + +#### CfReprocessingTaskResult *(jobType=`CF_REPROCESSING`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | CfReprocessingTaskFailure | | [optional] | + +#### DummyTaskResult *(jobType=`DUMMY`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | DummyTaskFailure | | [optional] | + +#### ReportTaskResult *(jobType=`REPORT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| report | Report | | [optional] | + +## Referenced Types + +> **EntityId types** (`AdminSettingsId`, `AiModelId`, `AlarmId`, `ApiKeyId`, `ApiUsageStateId`, `AssetId`, `AssetProfileId`, `BlobEntityId`, `CalculatedFieldId`, `ConverterId`, `CustomerId`, `DashboardId`, `DeviceId`, `DeviceProfileId`, `DomainId`, `EdgeId`, `EntityGroupId`, `EntityViewId`, `GroupPermissionId`, `IntegrationId`, `JobId`, `MobileAppBundleId`, `MobileAppId`, `NotificationId`, `NotificationRequestId`, `NotificationRuleId`, `NotificationTargetId`, `NotificationTemplateId`, `OAuth2ClientId`, `OtaPackageId`, `QueueId`, `QueueStatsId`, `ReportId`, `ReportTemplateId`, `RoleId`, `RpcId`, `RuleChainId`, `RuleNodeId`, `SchedulerEventId`, `SecretId`, `TbResourceId`, `TenantId`, `TenantProfileId`, `UserId`, `WidgetTypeId`, `WidgetsBundleId`, etc.): `{entityType: EntityType, id: UUID}` — all EntityId subtypes share this structure. + +#### CfReprocessingTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | String | | [optional] | +| entityInfo | EntityInfo | | [optional] | + +#### DummyTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | String | | [optional] | +| number | Integer | | [optional] | +| failAlways | Boolean | | [optional] | + +#### Report +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | ReportId | | [optional] | +| createdTime | Long | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] | +| tenantId | TenantId | | | +| customerId | CustomerId | | [optional] | +| templateId | ReportTemplateId | | | +| format | TbReportFormat | | | +| name | String | | | +| userId | UserId | | | +| publicKey | String | | [optional] | +| ownerId | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] | +| _public | Boolean | | [optional] | + +#### EntityInfo +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | EntityId | JSON object with the entity Id. | [optional] | +| name | String | Entity Name | [optional] | + +#### TbReportFormat (enum) +`PDF` | `CSV` + +#### EntityType (enum) +`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (46 values total) + --- ### Conventions diff --git a/pe/docs/TelemetryMappingConfiguration.md b/pe/docs/TelemetryMappingConfiguration.md index 1eed16d4..195d2525 100644 --- a/pe/docs/TelemetryMappingConfiguration.md +++ b/pe/docs/TelemetryMappingConfiguration.md @@ -36,7 +36,7 @@ | epmax | Long | | [optional] | #### TelemetryObserveStrategy (enum) -`SINGLE_0_ONE_RESOURCE_EQUALS_ONE_SINGLE_OBSERVE_REQUEST` | `COMPOSITE_ALL_1_ALL_RESOURCES_IN_ONE_COMPOSITE_OBSERVE_REQUEST` | `COMPOSITE_BY_OBJECT_2_GROUPED_COMPOSITE_OBSERVE_REQUESTS_BY_OBJECT` +`SINGLE` | `COMPOSITE_ALL` | `COMPOSITE_BY_OBJECT` #### LwM2mVersion | Name | Type | Description | Notes | diff --git a/pe/docs/TelemetryObserveStrategy.md b/pe/docs/TelemetryObserveStrategy.md index aaef96a8..7bc1a6f7 100644 --- a/pe/docs/TelemetryObserveStrategy.md +++ b/pe/docs/TelemetryObserveStrategy.md @@ -3,14 +3,16 @@ `org.thingsboard.client.model.TelemetryObserveStrategy` +Observation strategy for telemetry. SINGLE (0): one resource equals one single observe request. COMPOSITE_ALL (1): all resources in one composite observe request. COMPOSITE_BY_OBJECT (2): grouped composite observe requests by object. + ## Enum Values -* `SINGLE_0_ONE_RESOURCE_EQUALS_ONE_SINGLE_OBSERVE_REQUEST` (value: `"SINGLE (0): One resource equals one single observe request"`) +* `SINGLE` (value: `"SINGLE"`) -* `COMPOSITE_ALL_1_ALL_RESOURCES_IN_ONE_COMPOSITE_OBSERVE_REQUEST` (value: `"COMPOSITE_ALL (1): All resources in one composite observe request"`) +* `COMPOSITE_ALL` (value: `"COMPOSITE_ALL"`) -* `COMPOSITE_BY_OBJECT_2_GROUPED_COMPOSITE_OBSERVE_REQUESTS_BY_OBJECT` (value: `"COMPOSITE_BY_OBJECT (2): Grouped composite observe requests by object"`) +* `COMPOSITE_BY_OBJECT` (value: `"COMPOSITE_BY_OBJECT"`) diff --git a/pe/spec/openapi.json b/pe/spec/openapi.json index d271fd44..9970f3d7 100644 --- a/pe/spec/openapi.json +++ b/pe/spec/openapi.json @@ -16,7 +16,7 @@ }, "servers": [ { - "url": "http://localhost:38971", + "url": "http://localhost:43909", "description": "Generated server url" } ], @@ -122721,7 +122721,25 @@ } } } - ] + ], + "example": { + "key": null, + "success": null, + "discarded": null, + "finishTs": null, + "error": null, + "jobType": "CF_REPROCESSING", + "failure": { + "error": null, + "entityInfo": { + "id": { + "entityType": "DEVICE", + "id": "784f394c-42b6-435a-983c-b7beff2784f9" + }, + "name": null + } + } + } }, "CfReprocessingValidationResult": { "type": "object", @@ -126681,7 +126699,20 @@ } } } - ] + ], + "example": { + "key": null, + "success": null, + "discarded": null, + "finishTs": null, + "error": null, + "jobType": "DUMMY", + "failure": { + "error": null, + "number": null, + "failAlways": null + } + } }, "DurationAlarmCondition": { "allOf": [ @@ -132073,7 +132104,28 @@ }, "LwM2MBootstrapServerCredential": { "discriminator": { - "propertyName": "securityMode" + "propertyName": "securityMode", + "mapping": { + "NO_SEC": "#/components/schemas/NoSecLwM2MBootstrapServerCredential", + "PSK": "#/components/schemas/PSKLwM2MBootstrapServerCredential", + "RPK": "#/components/schemas/RPKLwM2MBootstrapServerCredential", + "X509": "#/components/schemas/X509LwM2MBootstrapServerCredential" + } + }, + "example": { + "securityMode": "NO_SEC", + "shortServerId": 123, + "bootstrapServerIs": true, + "host": "0.0.0.0", + "port": "'5685' or '5687'", + "clientHoldOffTime": 1, + "serverPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEAZ0pSaGKHk/GrDaUDnQZpeEdGwX7m3Ws+U/kiVat\n+44sgk3c8g0LotfMpLlZJPhPwJ6ipXV+O1r7IZUjBs3LNA==", + "serverCertificate": "MMIICODCCAd6gAwIBAgIUI88U1zowOdrxDK/dOV+36gJxI2MwCgYIKoZIzj0EAwIwejELMAkGA1UEBhMCVUs\nxEjAQBgNVBAgTCUt5aXYgY2l0eTENMAsGA1UEBxMES3lpdjEUMBIGA1UEChMLVGhpbmdzYm9hcmQxFzAVBgNVBAsMDkRFVkVMT1BFUl9URVNUMRkwFwYDVQQDDBBpbnRlcm1lZGlhdGVfY2EwMB4XDTIyMDEwOTEzMDMwMFoXDTI3MDEwODEzMDMwMFowFDESMBAGA1UEAxM\nJbG9jYWxob3N0MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUO3vBo/JTv0eooY7XHiKAIVDoWKFqtrU7C6q8AIKqpLcqhCdW+haFeBOH3PjY6EwaWkY04Bir4oanU0s7tz2uKOBpzCBpDAOBgNVHQ8BAf8EBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwEwDAYDVR0TAQH/\nBAIwADAdBgNVHQ4EFgQUEjc3Q4a0TxzP/3x3EV4fHxYUg0YwHwYDVR0jBBgwFoAUuSquGycMU6Q0SYNcbtSkSD3TfH0wLwYDVR0RBCgwJoIVbG9jYWxob3N0LmxvY2FsZG9tYWlugglsb2NhbGhvc3SCAiAtMAoGCCqGSM49BAMCA0gAMEUCIQD7dbZObyUaoDiNbX+9fUNp\nAWrD7N7XuJUwZ9FcN75R3gIgb2RNjDkHoyUyF1YajwkBk+7XmIXNClmizNJigj908mw=", + "bootstrapServerAccountTimeout": 0, + "lifetime": 300, + "defaultMinPeriod": 1, + "notifIfDisabled": true, + "binding": "U" }, "properties": { "securityMode": { @@ -133417,7 +133469,22 @@ } } } - ] + ], + "example": { + "securityMode": "NO_SEC", + "shortServerId": 123, + "bootstrapServerIs": true, + "host": "0.0.0.0", + "port": "'5685' or '5687'", + "clientHoldOffTime": 1, + "serverPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEAZ0pSaGKHk/GrDaUDnQZpeEdGwX7m3Ws+U/kiVat\n+44sgk3c8g0LotfMpLlZJPhPwJ6ipXV+O1r7IZUjBs3LNA==", + "serverCertificate": "MMIICODCCAd6gAwIBAgIUI88U1zowOdrxDK/dOV+36gJxI2MwCgYIKoZIzj0EAwIwejELMAkGA1UEBhMCVUs\nxEjAQBgNVBAgTCUt5aXYgY2l0eTENMAsGA1UEBxMES3lpdjEUMBIGA1UEChMLVGhpbmdzYm9hcmQxFzAVBgNVBAsMDkRFVkVMT1BFUl9URVNUMRkwFwYDVQQDDBBpbnRlcm1lZGlhdGVfY2EwMB4XDTIyMDEwOTEzMDMwMFoXDTI3MDEwODEzMDMwMFowFDESMBAGA1UEAxM\nJbG9jYWxob3N0MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUO3vBo/JTv0eooY7XHiKAIVDoWKFqtrU7C6q8AIKqpLcqhCdW+haFeBOH3PjY6EwaWkY04Bir4oanU0s7tz2uKOBpzCBpDAOBgNVHQ8BAf8EBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwEwDAYDVR0TAQH/\nBAIwADAdBgNVHQ4EFgQUEjc3Q4a0TxzP/3x3EV4fHxYUg0YwHwYDVR0jBBgwFoAUuSquGycMU6Q0SYNcbtSkSD3TfH0wLwYDVR0RBCgwJoIVbG9jYWxob3N0LmxvY2FsZG9tYWlugglsb2NhbGhvc3SCAiAtMAoGCCqGSM49BAMCA0gAMEUCIQD7dbZObyUaoDiNbX+9fUNp\nAWrD7N7XuJUwZ9FcN75R3gIgb2RNjDkHoyUyF1YajwkBk+7XmIXNClmizNJigj908mw=", + "bootstrapServerAccountTimeout": 0, + "lifetime": 300, + "defaultMinPeriod": 1, + "notifIfDisabled": true, + "binding": "U" + } }, "NodeConnectionInfo": { "type": "object", @@ -135462,7 +135529,22 @@ } } } - ] + ], + "example": { + "securityMode": "PSK", + "shortServerId": 123, + "bootstrapServerIs": true, + "host": "0.0.0.0", + "port": "'5685' or '5687'", + "clientHoldOffTime": 1, + "serverPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEAZ0pSaGKHk/GrDaUDnQZpeEdGwX7m3Ws+U/kiVat\n+44sgk3c8g0LotfMpLlZJPhPwJ6ipXV+O1r7IZUjBs3LNA==", + "serverCertificate": "MMIICODCCAd6gAwIBAgIUI88U1zowOdrxDK/dOV+36gJxI2MwCgYIKoZIzj0EAwIwejELMAkGA1UEBhMCVUs\nxEjAQBgNVBAgTCUt5aXYgY2l0eTENMAsGA1UEBxMES3lpdjEUMBIGA1UEChMLVGhpbmdzYm9hcmQxFzAVBgNVBAsMDkRFVkVMT1BFUl9URVNUMRkwFwYDVQQDDBBpbnRlcm1lZGlhdGVfY2EwMB4XDTIyMDEwOTEzMDMwMFoXDTI3MDEwODEzMDMwMFowFDESMBAGA1UEAxM\nJbG9jYWxob3N0MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUO3vBo/JTv0eooY7XHiKAIVDoWKFqtrU7C6q8AIKqpLcqhCdW+haFeBOH3PjY6EwaWkY04Bir4oanU0s7tz2uKOBpzCBpDAOBgNVHQ8BAf8EBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwEwDAYDVR0TAQH/\nBAIwADAdBgNVHQ4EFgQUEjc3Q4a0TxzP/3x3EV4fHxYUg0YwHwYDVR0jBBgwFoAUuSquGycMU6Q0SYNcbtSkSD3TfH0wLwYDVR0RBCgwJoIVbG9jYWxob3N0LmxvY2FsZG9tYWlugglsb2NhbGhvc3SCAiAtMAoGCCqGSM49BAMCA0gAMEUCIQD7dbZObyUaoDiNbX+9fUNp\nAWrD7N7XuJUwZ9FcN75R3gIgb2RNjDkHoyUyF1YajwkBk+7XmIXNClmizNJigj908mw=", + "bootstrapServerAccountTimeout": 0, + "lifetime": 300, + "defaultMinPeriod": 1, + "notifIfDisabled": true, + "binding": "U" + } }, "PageBreakComponent": { "allOf": [ @@ -138339,7 +138421,22 @@ } } } - ] + ], + "example": { + "securityMode": "RPK", + "shortServerId": 123, + "bootstrapServerIs": true, + "host": "0.0.0.0", + "port": "'5685' or '5687'", + "clientHoldOffTime": 1, + "serverPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEAZ0pSaGKHk/GrDaUDnQZpeEdGwX7m3Ws+U/kiVat\n+44sgk3c8g0LotfMpLlZJPhPwJ6ipXV+O1r7IZUjBs3LNA==", + "serverCertificate": "MMIICODCCAd6gAwIBAgIUI88U1zowOdrxDK/dOV+36gJxI2MwCgYIKoZIzj0EAwIwejELMAkGA1UEBhMCVUs\nxEjAQBgNVBAgTCUt5aXYgY2l0eTENMAsGA1UEBxMES3lpdjEUMBIGA1UEChMLVGhpbmdzYm9hcmQxFzAVBgNVBAsMDkRFVkVMT1BFUl9URVNUMRkwFwYDVQQDDBBpbnRlcm1lZGlhdGVfY2EwMB4XDTIyMDEwOTEzMDMwMFoXDTI3MDEwODEzMDMwMFowFDESMBAGA1UEAxM\nJbG9jYWxob3N0MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUO3vBo/JTv0eooY7XHiKAIVDoWKFqtrU7C6q8AIKqpLcqhCdW+haFeBOH3PjY6EwaWkY04Bir4oanU0s7tz2uKOBpzCBpDAOBgNVHQ8BAf8EBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwEwDAYDVR0TAQH/\nBAIwADAdBgNVHQ4EFgQUEjc3Q4a0TxzP/3x3EV4fHxYUg0YwHwYDVR0jBBgwFoAUuSquGycMU6Q0SYNcbtSkSD3TfH0wLwYDVR0RBCgwJoIVbG9jYWxob3N0LmxvY2FsZG9tYWlugglsb2NhbGhvc3SCAiAtMAoGCCqGSM49BAMCA0gAMEUCIQD7dbZObyUaoDiNbX+9fUNp\nAWrD7N7XuJUwZ9FcN75R3gIgb2RNjDkHoyUyF1YajwkBk+7XmIXNClmizNJigj908mw=", + "bootstrapServerAccountTimeout": 0, + "lifetime": 300, + "defaultMinPeriod": 1, + "notifIfDisabled": true, + "binding": "U" + } }, "RateLimitsNotificationRuleTriggerConfig": { "allOf": [ @@ -139449,7 +139546,46 @@ } } } - ] + ], + "example": { + "key": null, + "success": null, + "discarded": null, + "finishTs": null, + "error": null, + "jobType": "REPORT", + "report": { + "id": { + "entityType": "REPORT", + "id": "784f394c-42b6-435a-983c-b7beff2784f9" + }, + "createdTime": 1746028547220, + "tenantId": { + "entityType": "TENANT", + "id": "784f394c-42b6-435a-983c-b7beff2784f9" + }, + "customerId": { + "entityType": "CUSTOMER", + "id": "784f394c-42b6-435a-983c-b7beff2784f9" + }, + "templateId": { + "entityType": "REPORT_TEMPLATE", + "id": "784f394c-42b6-435a-983c-b7beff2784f9" + }, + "format": {}, + "name": null, + "userId": { + "entityType": "USER", + "id": "784f394c-42b6-435a-983c-b7beff2784f9" + }, + "publicKey": null, + "ownerId": { + "entityType": "DEVICE", + "id": "784f394c-42b6-435a-983c-b7beff2784f9" + }, + "public": null + } + } }, "ReportTemplate": { "type": "object", @@ -143326,7 +143462,30 @@ "TaskResult": { "type": "object", "discriminator": { - "propertyName": "jobType" + "propertyName": "jobType", + "mapping": { + "CF_REPROCESSING": "#/components/schemas/CfReprocessingTaskResult", + "REPORT": "#/components/schemas/ReportTaskResult", + "DUMMY": "#/components/schemas/DummyTaskResult" + } + }, + "example": { + "key": null, + "success": null, + "discarded": null, + "finishTs": null, + "error": null, + "jobType": "CF_REPROCESSING", + "failure": { + "error": null, + "entityInfo": { + "id": { + "entityType": "DEVICE", + "id": "784f394c-42b6-435a-983c-b7beff2784f9" + }, + "name": null + } + } }, "properties": { "key": { @@ -143836,10 +143995,11 @@ }, "TelemetryObserveStrategy": { "type": "string", + "description": "Observation strategy for telemetry. SINGLE (0): one resource equals one single observe request. COMPOSITE_ALL (1): all resources in one composite observe request. COMPOSITE_BY_OBJECT (2): grouped composite observe requests by object.", "enum": [ - "SINGLE (0): One resource equals one single observe request", - "COMPOSITE_ALL (1): All resources in one composite observe request", - "COMPOSITE_BY_OBJECT (2): Grouped composite observe requests by object" + "SINGLE", + "COMPOSITE_ALL", + "COMPOSITE_BY_OBJECT" ] }, "TelemetryQueryingSnmpCommunicationConfig": { @@ -147574,7 +147734,22 @@ } } } - ] + ], + "example": { + "securityMode": "X509", + "shortServerId": 123, + "bootstrapServerIs": true, + "host": "0.0.0.0", + "port": "'5685' or '5687'", + "clientHoldOffTime": 1, + "serverPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEAZ0pSaGKHk/GrDaUDnQZpeEdGwX7m3Ws+U/kiVat\n+44sgk3c8g0LotfMpLlZJPhPwJ6ipXV+O1r7IZUjBs3LNA==", + "serverCertificate": "MMIICODCCAd6gAwIBAgIUI88U1zowOdrxDK/dOV+36gJxI2MwCgYIKoZIzj0EAwIwejELMAkGA1UEBhMCVUs\nxEjAQBgNVBAgTCUt5aXYgY2l0eTENMAsGA1UEBxMES3lpdjEUMBIGA1UEChMLVGhpbmdzYm9hcmQxFzAVBgNVBAsMDkRFVkVMT1BFUl9URVNUMRkwFwYDVQQDDBBpbnRlcm1lZGlhdGVfY2EwMB4XDTIyMDEwOTEzMDMwMFoXDTI3MDEwODEzMDMwMFowFDESMBAGA1UEAxM\nJbG9jYWxob3N0MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUO3vBo/JTv0eooY7XHiKAIVDoWKFqtrU7C6q8AIKqpLcqhCdW+haFeBOH3PjY6EwaWkY04Bir4oanU0s7tz2uKOBpzCBpDAOBgNVHQ8BAf8EBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwEwDAYDVR0TAQH/\nBAIwADAdBgNVHQ4EFgQUEjc3Q4a0TxzP/3x3EV4fHxYUg0YwHwYDVR0jBBgwFoAUuSquGycMU6Q0SYNcbtSkSD3TfH0wLwYDVR0RBCgwJoIVbG9jYWxob3N0LmxvY2FsZG9tYWlugglsb2NhbGhvc3SCAiAtMAoGCCqGSM49BAMCA0gAMEUCIQD7dbZObyUaoDiNbX+9fUNp\nAWrD7N7XuJUwZ9FcN75R3gIgb2RNjDkHoyUyF1YajwkBk+7XmIXNClmizNJigj908mw=", + "bootstrapServerAccountTimeout": 0, + "lifetime": 300, + "defaultMinPeriod": 1, + "notifIfDisabled": true, + "binding": "U" + } }, "YearInterval": { "allOf": [ diff --git a/pe/src/main/java/org/thingsboard/client/ApiClient.java b/pe/src/main/java/org/thingsboard/client/ApiClient.java index d450e022..b2355209 100644 --- a/pe/src/main/java/org/thingsboard/client/ApiClient.java +++ b/pe/src/main/java/org/thingsboard/client/ApiClient.java @@ -173,7 +173,7 @@ public static List parameterToPairs( public ApiClient() { this.builder = createDefaultHttpClientBuilder(); this.mapper = createDefaultObjectMapper(); - updateBaseUri("http://localhost:38971"); + updateBaseUri("http://localhost:43909"); interceptor = null; readTimeout = null; connectTimeout = null; @@ -191,7 +191,7 @@ public ApiClient() { public ApiClient(HttpClient.Builder builder, ObjectMapper mapper, String baseUri) { this.builder = builder; this.mapper = mapper; - updateBaseUri(baseUri != null ? baseUri : "http://localhost:38971"); + updateBaseUri(baseUri != null ? baseUri : "http://localhost:43909"); interceptor = null; readTimeout = null; connectTimeout = null; diff --git a/pe/src/main/java/org/thingsboard/client/model/LwM2MBootstrapServerCredential.java b/pe/src/main/java/org/thingsboard/client/model/LwM2MBootstrapServerCredential.java index a3e9241b..0cb8c4ad 100644 --- a/pe/src/main/java/org/thingsboard/client/model/LwM2MBootstrapServerCredential.java +++ b/pe/src/main/java/org/thingsboard/client/model/LwM2MBootstrapServerCredential.java @@ -50,10 +50,10 @@ ) @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "securityMode", visible = true) @JsonSubTypes({ - @JsonSubTypes.Type(value = NoSecLwM2MBootstrapServerCredential.class, name = "NoSecLwM2MBootstrapServerCredential"), - @JsonSubTypes.Type(value = PSKLwM2MBootstrapServerCredential.class, name = "PSKLwM2MBootstrapServerCredential"), - @JsonSubTypes.Type(value = RPKLwM2MBootstrapServerCredential.class, name = "RPKLwM2MBootstrapServerCredential"), - @JsonSubTypes.Type(value = X509LwM2MBootstrapServerCredential.class, name = "X509LwM2MBootstrapServerCredential"), + @JsonSubTypes.Type(value = NoSecLwM2MBootstrapServerCredential.class, name = "NO_SEC"), + @JsonSubTypes.Type(value = PSKLwM2MBootstrapServerCredential.class, name = "PSK"), + @JsonSubTypes.Type(value = RPKLwM2MBootstrapServerCredential.class, name = "RPK"), + @JsonSubTypes.Type(value = X509LwM2MBootstrapServerCredential.class, name = "X509"), }) public class LwM2MBootstrapServerCredential { @@ -170,10 +170,10 @@ public String toUrlQueryString(String prefix) { static { // Initialize and register the discriminator mappings. Map> mappings = new HashMap>(); - mappings.put("NoSecLwM2MBootstrapServerCredential", NoSecLwM2MBootstrapServerCredential.class); - mappings.put("PSKLwM2MBootstrapServerCredential", PSKLwM2MBootstrapServerCredential.class); - mappings.put("RPKLwM2MBootstrapServerCredential", RPKLwM2MBootstrapServerCredential.class); - mappings.put("X509LwM2MBootstrapServerCredential", X509LwM2MBootstrapServerCredential.class); + mappings.put("NO_SEC", NoSecLwM2MBootstrapServerCredential.class); + mappings.put("PSK", PSKLwM2MBootstrapServerCredential.class); + mappings.put("RPK", RPKLwM2MBootstrapServerCredential.class); + mappings.put("X509", X509LwM2MBootstrapServerCredential.class); mappings.put("LwM2MBootstrapServerCredential", LwM2MBootstrapServerCredential.class); JSON.registerDiscriminator(LwM2MBootstrapServerCredential.class, "securityMode", mappings); } diff --git a/pe/src/main/java/org/thingsboard/client/model/TaskResult.java b/pe/src/main/java/org/thingsboard/client/model/TaskResult.java index 89b7bbc2..c2b0dc27 100644 --- a/pe/src/main/java/org/thingsboard/client/model/TaskResult.java +++ b/pe/src/main/java/org/thingsboard/client/model/TaskResult.java @@ -56,9 +56,9 @@ ) @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "jobType", visible = true) @JsonSubTypes({ - @JsonSubTypes.Type(value = CfReprocessingTaskResult.class, name = "CfReprocessingTaskResult"), - @JsonSubTypes.Type(value = DummyTaskResult.class, name = "DummyTaskResult"), - @JsonSubTypes.Type(value = ReportTaskResult.class, name = "ReportTaskResult"), + @JsonSubTypes.Type(value = CfReprocessingTaskResult.class, name = "CF_REPROCESSING"), + @JsonSubTypes.Type(value = DummyTaskResult.class, name = "DUMMY"), + @JsonSubTypes.Type(value = ReportTaskResult.class, name = "REPORT"), }) public class TaskResult { @@ -350,9 +350,9 @@ public String toUrlQueryString(String prefix) { static { // Initialize and register the discriminator mappings. Map> mappings = new HashMap>(); - mappings.put("CfReprocessingTaskResult", CfReprocessingTaskResult.class); - mappings.put("DummyTaskResult", DummyTaskResult.class); - mappings.put("ReportTaskResult", ReportTaskResult.class); + mappings.put("CF_REPROCESSING", CfReprocessingTaskResult.class); + mappings.put("DUMMY", DummyTaskResult.class); + mappings.put("REPORT", ReportTaskResult.class); mappings.put("TaskResult", TaskResult.class); JSON.registerDiscriminator(TaskResult.class, "jobType", mappings); } diff --git a/pe/src/main/java/org/thingsboard/client/model/TelemetryObserveStrategy.java b/pe/src/main/java/org/thingsboard/client/model/TelemetryObserveStrategy.java index 70724946..de9777d2 100644 --- a/pe/src/main/java/org/thingsboard/client/model/TelemetryObserveStrategy.java +++ b/pe/src/main/java/org/thingsboard/client/model/TelemetryObserveStrategy.java @@ -28,15 +28,15 @@ import com.fasterxml.jackson.annotation.JsonValue; /** - * Gets or Sets TelemetryObserveStrategy + * Observation strategy for telemetry. SINGLE (0): one resource equals one single observe request. COMPOSITE_ALL (1): all resources in one composite observe request. COMPOSITE_BY_OBJECT (2): grouped composite observe requests by object. */ public enum TelemetryObserveStrategy { - SINGLE_0_ONE_RESOURCE_EQUALS_ONE_SINGLE_OBSERVE_REQUEST("SINGLE (0): One resource equals one single observe request"), + SINGLE("SINGLE"), - COMPOSITE_ALL_1_ALL_RESOURCES_IN_ONE_COMPOSITE_OBSERVE_REQUEST("COMPOSITE_ALL (1): All resources in one composite observe request"), + COMPOSITE_ALL("COMPOSITE_ALL"), - COMPOSITE_BY_OBJECT_2_GROUPED_COMPOSITE_OBSERVE_REQUESTS_BY_OBJECT("COMPOSITE_BY_OBJECT (2): Grouped composite observe requests by object"); + COMPOSITE_BY_OBJECT("COMPOSITE_BY_OBJECT"); private String value;