Get or Change Access Permissions for entity.rights

We are still updating this page

Some data may be missing — we will complete it shortly.

Scope: entity

Who can execute the method: any user

The entity.rights method retrieves or modifies access permissions for the storage. It returns the current set of access permissions.

To change the set of access permissions, the user must have management rights (X) for the storage. A user cannot revoke their own management rights.

Parameters

Parameter

Description

ENTITY*
string

Required. String identifier of the storage being updated.

ACCESS
unknown

Description of the new set of access permissions for the storage.
It should be in the form of an associative array, where the keys are the identifiers of the access permissions, and the values are R (read), W (write), or X (manage).

Required parameters are marked with *

Example

try
        {
        	const response = await $b24.callMethod(
        		'entity.rights',
        		{
        			'ENTITY': 'dish'
        		}
        	);
        	
        	const result = response.getData().result;
        }
        catch( error )
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'entity.rights',
                    [
                        'ENTITY' => 'dish'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error calling entity rights: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'entity.rights',
            {
                'ENTITY': 'dish'
            }
        );
        

How to Use Examples in Documentation

Response

200 OK

{"result":
            {
                "AU":"R",
                "U254":"W",
                "D115":"W",
                "U255":"W",
                "U260":"W"
            }
        }