Skip to content

AclService

Method LWM2M request Description
getInstanceId GET /2/{objectId}/1
alias: /acl/{objectId}/instance-id
Get ACL object instance id
getList GET /2/{objectId}/2
alias: /acl/{objectId}/list
Get ACL list
getObjectId GET /2/{objectId}/0
alias: /acl/{objectId}/object-id
Get acl object id
getOwner GET /2/{objectId}/3
alias: /acl/{objectId}/owner
Get ACL group owner id
putList PUT /2/{objectId}/2
alias: /acl/{objectId}/list
Write ACL
putOwner PUT /2/{objectId}/3
alias: /acl/{objectId}/owner
Set access control owner group

getInstanceId

Minimal Tap Firmware version: >= 1.0

Get ACL object instance id

Example

let myService = new AclService();
let objectId = 56; // Integer | 

try{
    let call = myService.getInstanceId(objectId);
    let value = (await call).body();
    console.log(`getInstanceId: ${value}`);
}
catch (ex){
    // No response from device / response error (ie: device is not connected or request timeout)
    console.error(ex);
}
import .AclService;

ServiceFactory serviceFactory = ...;
AclService myService = serviceFactory.create(AclService.class);


Integer objectId = 56; // Integer | 
try {
    Call<Integer> call = myService.getInstanceId(objectId);
    Response<Integer> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling AclService#getInstanceId");
    e.printStackTrace();
}
import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Integer> = try tap.service.acl.getInstanceId(objectId);
print("Response:" + response.body())

Parameters

Name Type Description Notes
objectId Integer

Return type

Integer

Authorization

No authorization required

getList

Minimal Tap Firmware version: >= 1.0

Get ACL list

Ressource contenant les droits d'un groupe sur cet objet : * ressource instance ID = Short Server ID du groupe

Example

let myService = new AclService();
let objectId = 56; // Integer | 

try{
    let call = myService.getList(objectId);
    let value = (await call).body();
    console.log(`getList: ${value}`);
}
catch (ex){
    // No response from device / response error (ie: device is not connected or request timeout)
    console.error(ex);
}
import .AclService;

ServiceFactory serviceFactory = ...;
AclService myService = serviceFactory.create(AclService.class);


Integer objectId = 56; // Integer | 
try {
    Call<AclEntries> call = myService.getList(objectId);
    Response<AclEntries> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling AclService#getList");
    e.printStackTrace();
}
import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<AclEntries> = try tap.service.acl.getList(objectId);
print("Response:" + response.body())

Parameters

Name Type Description Notes
objectId Integer

Return type

AclEntries

Authorization

No authorization required

getObjectId

Minimal Tap Firmware version: >= 1.0

Get acl object id

Example

let myService = new AclService();
let objectId = 56; // Integer | 

try{
    let call = myService.getObjectId(objectId);
    let value = (await call).body();
    console.log(`getObjectId: ${value}`);
}
catch (ex){
    // No response from device / response error (ie: device is not connected or request timeout)
    console.error(ex);
}
import .AclService;

ServiceFactory serviceFactory = ...;
AclService myService = serviceFactory.create(AclService.class);


Integer objectId = 56; // Integer | 
try {
    Call<Integer> call = myService.getObjectId(objectId);
    Response<Integer> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling AclService#getObjectId");
    e.printStackTrace();
}
import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Integer> = try tap.service.acl.getObjectId(objectId);
print("Response:" + response.body())

Parameters

Name Type Description Notes
objectId Integer

Return type

Integer

Authorization

No authorization required

getOwner

Minimal Tap Firmware version: >= 1.0

Get ACL group owner id

Example

let myService = new AclService();
let objectId = 56; // Integer | 

try{
    let call = myService.getOwner(objectId);
    let value = (await call).body();
    console.log(`getOwner: ${value}`);
}
catch (ex){
    // No response from device / response error (ie: device is not connected or request timeout)
    console.error(ex);
}
import .AclService;

ServiceFactory serviceFactory = ...;
AclService myService = serviceFactory.create(AclService.class);


Integer objectId = 56; // Integer | 
try {
    Call<Integer> call = myService.getOwner(objectId);
    Response<Integer> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling AclService#getOwner");
    e.printStackTrace();
}
import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Integer> = try tap.service.acl.getOwner(objectId);
print("Response:" + response.body())

Parameters

Name Type Description Notes
objectId Integer

Return type

Integer

Authorization

No authorization required

putList

Minimal Tap Firmware version: >= 1.0

Write ACL

Example

let myService = new AclService();
let objectId = 56; // Integer | 

try{
    let call = myService.putList(objectId);
    let value = (await call).body();
    console.log(`putList: ${value}`);
}
catch (ex){
    // No response from device / response error (ie: device is not connected or request timeout)
    console.error(ex);
}
import .AclService;

ServiceFactory serviceFactory = ...;
AclService myService = serviceFactory.create(AclService.class);


Integer objectId = 56; // Integer | 
try {
    Call<Void> call = myService.putList(objectId);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling AclService#putList");
    e.printStackTrace();
}
import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.acl.putList(objectId);
print("Response:" + response.body())

Parameters

Name Type Description Notes
objectId Integer

Return type

null (empty response body)

Authorization

No authorization required

putOwner

Minimal Tap Firmware version: >= 1.0

Set access control owner group

Example

let myService = new AclService();
let objectId = 56; // Integer | 
let ownerId = 56; // Integer | 

try{
    let call = myService.putOwner(objectId, ownerId);
    let value = (await call).body();
    console.log(`putOwner: ${value}`);
}
catch (ex){
    // No response from device / response error (ie: device is not connected or request timeout)
    console.error(ex);
}
import .AclService;

ServiceFactory serviceFactory = ...;
AclService myService = serviceFactory.create(AclService.class);


Integer objectId = 56; // Integer | 
Integer ownerId = 56; // Integer | 
try {
    Call<Void> call = myService.putOwner(objectId, ownerId);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling AclService#putOwner");
    e.printStackTrace();
}
import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.acl.putOwner(objectId, ownerId);
print("Response:" + response.body())

Parameters

Name Type Description Notes
objectId Integer
ownerId Integer

Return type

null (empty response body)

Authorization

No authorization required