Application Package APIs

List of Application Package APIs.

The ApplicationPackageRegistry service

Method ApplicationPackageRegistry.List
Description List returns the available packages for the end device.
Request type EndDeviceIdentifiers
Response type ApplicationPackages
HTTP bindings

GET /api/v3/as/applications/{application_ids.application_id}/devices/{device_id}/packages
Method ApplicationPackageRegistry.GetAssociation
Description GetAssociation returns the association registered on the FPort of the end device.
Request type GetApplicationPackageAssociationRequest
Response type ApplicationPackageAssociation
HTTP bindings

GET /api/v3/as/applications/{ids.end_device_ids.application_ids.application_id}/devices/{ids.end_device_ids.device_id}/packages/associations/{ids.f_port}
Method ApplicationPackageRegistry.ListAssociations
Description ListAssociations returns all of the associations of the end device.
Request type ListApplicationPackageAssociationRequest
Response type ApplicationPackageAssociations
HTTP bindings

GET /api/v3/as/applications/{ids.application_ids.application_id}/devices/{ids.device_id}/packages/associations
Method ApplicationPackageRegistry.SetAssociation
Description SetAssociation updates or creates the association on the FPort of the end device.
Request type SetApplicationPackageAssociationRequest
Response type ApplicationPackageAssociation
HTTP bindings

PUT /api/v3/as/applications/{association.ids.end_device_ids.application_ids.application_id}/devices/{association.ids.end_device_ids.device_id}/packages/associations/{association.ids.f_port}
Method ApplicationPackageRegistry.DeleteAssociation
Description DeleteAssociation removes the association on the FPort of the end device.
Request type ApplicationPackageAssociationIdentifiers
Response type google.protobuf.Empty
HTTP bindings

DELETE /api/v3/as/applications/{end_device_ids.application_ids.application_id}/devices/{end_device_ids.device_id}/packages/associations/{f_port}
Method ApplicationPackageRegistry.GetDefaultAssociation
Description GetDefaultAssociation returns the default association registered on the FPort of the application.
Request type GetApplicationPackageDefaultAssociationRequest
Response type ApplicationPackageDefaultAssociation
HTTP bindings

GET /api/v3/as/applications/{ids.application_ids.application_id}/packages/associations/{ids.f_port}
Method ApplicationPackageRegistry.ListDefaultAssociations
Description ListDefaultAssociations returns all of the default associations of the application.
Request type ListApplicationPackageDefaultAssociationRequest
Response type ApplicationPackageDefaultAssociations
HTTP bindings

GET /api/v3/as/applications/{ids.application_id}/packages/associations
Method ApplicationPackageRegistry.SetDefaultAssociation
Description SetDefaultAssociation updates or creates the default association on the FPort of the application.
Request type SetApplicationPackageDefaultAssociationRequest
Response type ApplicationPackageDefaultAssociation
HTTP bindings

PUT /api/v3/as/applications/{default.ids.application_ids.application_id}/packages/associations/{default.ids.f_port}
Method ApplicationPackageRegistry.DeleteDefaultAssociation
Description DeleteDefaultAssociation removes the default association on the FPort of the application.
Request type ApplicationPackageDefaultAssociationIdentifiers
Response type google.protobuf.Empty
HTTP bindings

DELETE /api/v3/as/applications/{application_ids.application_id}/packages/associations/{f_port}

The AzureIoTHubService service

Method AzureIoTHubService.Submit
Request type AzureIoTHubEvents
Response type google.protobuf.Empty
HTTP bindings

POST /api/v3/as/applications/{application_ids.application_id}/packages/azureiothub/events

Messages

Message AzureIoTHubEvent

Show object example 
{
  "end_device_ids": {},
  "body": {},
  "properties": {},
}

Fields:

Field end_device_ids
Type EndDeviceIdentifiers
Description

required
Field body
Type google.protobuf. Struct
Description

required
Field properties
Type google.protobuf. Struct
Description

required

Message AzureIoTHubEvents

Show object example 
{
  "application_ids": {},
  "events": [],
}

Fields:

Field application_ids
Type ApplicationIdentifiers
Description

required
Field events
Type repeated AzureIoTHubEvent
Description

min_items: 1

Message EndDeviceIdentifiers

Show object example 
{
  "device_id": "",
  "application_ids": {},
  "dev_eui": "",
  "join_eui": "",
  "dev_addr": "",
}

Fields:

Field device_id
Type string
Description

max_len: 36

pattern: ^[a-z0-9](?:[-]?[a-z0-9]){2,}$
Field application_ids
Type ApplicationIdentifiers
Description

required
Field dev_eui
Type bytes
Description

The LoRaWAN DevEUI.

ignore_empty

len: 8
Field join_eui
Type bytes
Description

The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices).

ignore_empty

len: 8
Field dev_addr
Type bytes
Description

The LoRaWAN DevAddr.

ignore_empty

len: 4

Message GetApplicationPackageAssociationRequest

Show object example 
{
  "ids": {},
  "field_mask": {},
}

Fields:

Field ids
Type ApplicationPackageAssociationIdentifiers
Description

required
Field field_mask
Type google.protobuf. FieldMask

Message SetApplicationPackageAssociationRequest

Show object example 
{
  "association": {},
  "field_mask": {},
}

Fields:

Field association
Type ApplicationPackageAssociation
Description

required
Field field_mask
Type google.protobuf. FieldMask

Message ApplicationPackageAssociationIdentifiers

Show object example 
{
  "end_device_ids": {},
  "f_port": 0,
}

Fields:

Field end_device_ids
Type EndDeviceIdentifiers
Description

required
Field f_port
Type uint32
Description

gte: 1

lte: 255

Message GetApplicationPackageDefaultAssociationRequest

Show object example 
{
  "ids": {},
  "field_mask": {},
}

Fields:

Field ids
Type ApplicationPackageDefaultAssociationIdentifiers
Description

required
Field field_mask
Type google.protobuf. FieldMask

Message ListApplicationPackageDefaultAssociationRequest

Show object example 
{
  "ids": {},
  "limit": 0,
  "page": 0,
  "field_mask": {},
}

Fields:

Field ids
Type ApplicationIdentifiers
Description

required
Field limit
Type uint32
Description

Limit the number of results per page. Each page is ordered by the FPort.

lte: 1000
Field page
Type uint32
Description

Page number for pagination. 0 is interpreted as 1.
Field field_mask
Type google.protobuf. FieldMask

Message SetApplicationPackageDefaultAssociationRequest

Show object example 
{
  "default": {},
  "field_mask": {},
}

Fields:

Field default
Type ApplicationPackageDefaultAssociation
Description

required
Field field_mask
Type google.protobuf. FieldMask

Message ApplicationPackageDefaultAssociationIdentifiers

Show object example 
{
  "application_ids": {},
  "f_port": 0,
}

Fields:

Field application_ids
Type ApplicationIdentifiers
Description

required
Field f_port
Type uint32
Description

gte: 1

lte: 255

Message ApplicationIdentifiers

Show object example 
{
  "application_id": "",
}

Fields:

Field application_id
Type string
Description

max_len: 36

pattern: ^[a-z0-9](?:[-]?[a-z0-9]){2,}$

Message ApplicationPackageAssociation

Show object example 
{
  "ids": {},
  "created_at": "0001-01-01T00:00:00Z",
  "updated_at": "0001-01-01T00:00:00Z",
  "package_name": "",
  "data": {},
}

Fields:

Field ids
Type ApplicationPackageAssociationIdentifiers
Description

required
Field created_at
Type google.protobuf. Timestamp
Field updated_at
Type google.protobuf. Timestamp
Field package_name
Type string
Description

max_len: 36

pattern: ^[a-z0-9](?:[-]?[a-z0-9]){2,}$
Field data
Type google.protobuf. Struct

Message ApplicationPackageDefaultAssociation

Show object example 
{
  "ids": {},
  "created_at": "0001-01-01T00:00:00Z",
  "updated_at": "0001-01-01T00:00:00Z",
  "package_name": "",
  "data": {},
}

Fields:

Field ids
Type ApplicationPackageDefaultAssociationIdentifiers
Description

required
Field created_at
Type google.protobuf. Timestamp
Field updated_at
Type google.protobuf. Timestamp
Field package_name
Type string
Description

max_len: 36

pattern: ^[a-z0-9](?:[-]?[a-z0-9]){2,}$
Field data
Type google.protobuf. Struct

Message ListApplicationPackageAssociationRequest

Show object example 
{
  "ids": {},
  "limit": 0,
  "page": 0,
  "field_mask": {},
}

Fields:

Field ids
Type EndDeviceIdentifiers
Description

required
Field limit
Type uint32
Description

Limit the number of results per page. Each page is ordered by the FPort.

lte: 1000
Field page
Type uint32
Description

Page number for pagination. 0 is interpreted as 1.
Field field_mask
Type google.protobuf. FieldMask
← Application APIs Application Pub/Sub APIs →