Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

tenant-profile-controller

Get Tenant Profiles (getTenantProfiles)

Returns a page of tenant profiles registered in the platform. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details.

Available for users with 'SYS_ADMIN' authority.

get/api/tenantProfiles

Query parameters

pageSizeinteger required

Maximum amount of entities in a one page

pageinteger required

Sequence number of page starting from 0

textSearchstring

The case insensitive 'substring' filter based on the tenant profile name.

sortProperty'createdTime' | 'name' | 'description' | 'isDefault'

Property of entity to sort by

sortOrder'ASC' | 'DESC'

Sort order. ASC (ASCENDING) or DESC (DESCENDING)

idsstring[] required

Comma-separated list of tenant profile ids

Response

OK

OR

Example response

[
  {
    "id": {
      "id": "784f394c-42b6-435a-983c-b7beff2784f9",
      "entityType": "TENANT_PROFILE"
    },
    "createdTime": 1609459200000,
    "name": "High Priority Tenants",
    "description": "Any text",
    "profileData": {
      "configuration": {
        "transportTenantMsgRateLimit": "1000:1,20000:60",
        "transportTenantTelemetryMsgRateLimit": "1000:1,20000:60",
        "transportTenantTelemetryDataPointsRateLimit": "1000:1,20000:60",
        "transportDeviceMsgRateLimit": "20:1,600:60",
        "transportDeviceTelemetryMsgRateLimit": "20:1,600:60",
        "transportDeviceTelemetryDataPointsRateLimit": "20:1,600:60",
        "transportGatewayMsgRateLimit": "20:1,600:60",
        "transportGatewayTelemetryMsgRateLimit": "20:1,600:60",
        "transportGatewayTelemetryDataPointsRateLimit": "20:1,600:60",
        "transportGatewayDeviceMsgRateLimit": "20:1,600:60",
        "transportGatewayDeviceTelemetryMsgRateLimit": "20:1,600:60",
        "transportGatewayDeviceTelemetryDataPointsRateLimit": "20:1,600:60",
        "tenantEntityExportRateLimit": "20:1,600:60",
        "tenantEntityImportRateLimit": "20:1,600:60",
        "tenantNotificationRequestsRateLimit": "20:1,600:60",
        "tenantNotificationRequestsPerRuleRateLimit": "20:1,600:60",
        "maxTransportMessages": 10000000,
        "maxTransportDataPoints": 10000000,
        "maxREExecutions": 4000000,
        "maxJSExecutions": 5000000,
        "maxTbelExecutions": 5000000,
        "maxRuleNodeExecutionsPerMessage": 50,
        "maxDebugModeDurationMinutes": 15,
        "smsEnabled": true,
        "maxCreatedAlarms": 1000,
        "maxCalculatedFieldsPerEntity": 5,
        "maxArgumentsPerCF": 10,
        "minAllowedScheduledUpdateIntervalInSecForCF": 10,
        "maxRelationLevelPerCfArgument": 2,
        "maxRelatedEntitiesToReturnPerCfArgument": 100,
        "maxDataPointsPerRollingArg": 1000,
        "maxStateSizeInKBytes": 32,
        "maxSingleValueArgumentSizeInKBytes": 2,
        "minAllowedDeduplicationIntervalInSecForCF": 10,
        "minAllowedAggregationIntervalInSecForCF": 60,
        "intermediateAggregationIntervalInSecForCF": 300,
        "cfReevaluationCheckInterval": 60,
        "alarmsReevaluationInterval": 60
      },
      "queueConfiguration": [
        {
          "additionalInfo": {}
        }
      ]
    }
  }
]