app.list

The app.list service is used to retrieve a list of application tokens.

The application session must have organization administrator privileges.

TR50 Request

{
  "put": {
    "command": "app.list",
    "params": {
      "offset": 0,
      "limit": 10
    }
  }
}

Request Parameters

Name

Type

Required

Description

offset

String

 

The starting list offset, used for pagination. Defaults to 0 if not specified.

limit

String

 

Limits the number of results returned. Defaults to the maximum configured size.

TR50 Response

If the command is sent successfully a success message and the array of applications is returned. Otherwise, an error and error message are returned.

{
  "put": {
    "success": true,
    "params": {
      "result": [
        {
          "id": "",
          "name": "myname",
          "desc": "My application description",
          "token": "qwertyasdf1234567890zxcvb",
          "autoRegThingDefId": "",
          "autoRegTags": ["", ""],
          "autoRegSecTags": ["", ""],
          "roles": ["", ""],
          "isSuperAdmin": false,
          "isSuperOps": false,
          "isOrgAdmin": false,
          "license": "",
          "createdBy": "admin@example.com",
          "createdOn": "2014-02-04T14:36:26.783-05:00",
          "updatedBy": "admin@example.com",
          "updatedOn": "2014-03-27T11:06:32.758-04:00"
        },
        ..
      ]
    }
  }
}

Response Parameters

Name

Type

Description

result

Array

The array of application token objects.

Result Array Object

Name

Type

Description

id

String

The object id for the application.

name

String

The name.

desc

String

The description.

token

String

The token string.

autoRegThingDefId

String

 

autoRegTags

Array

 

autoRegSecTags

Array

 

roles

Array

The roles granted to the application during execution.

isSuperAdmin

Boolean

If the application can run with SuperAdmin permissions.

isSuperOps

Boolean

If the application can run with SuperOps permissions.

isOrgAdmin

Boolean

If the application can run with Org-Admin permissions.

license

String

 

createdBy

String

The email address of the user who created the thing.

createdOn

String

The date and time that the thing was created.

updatedBy

String

The email address of the user who last updated the thing.

updatedOn

String

The date and time that the thing was updated.