Set Full Visibility Settings for rpa.fields.setSettings

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: rpa

Who can execute the method: any user

DEPRECATED

Development of this method has been halted. Use Smart scripts as an alternative to this functionality.

This method sets the full visibility settings for fields at the stage with the identifier stageId of the process with the identifier typeId.

Method Parameters

Required parameters are marked with *

Name
type

Description

typeId*
number

Identifier of the process

stageId
number

Identifier of the stage.

Defaults to 0, meaning — general settings

fields*
object

Array with field visibility settings.

If an empty fields is passed, all settings will be cleared

Code Examples

How to Use Examples in Documentation

try
        {
            const response = await $b24.callMethod(
                'rpa.comment.add',
                {
                    "typeId": 1,
                    "fields": {
                        "kanban": [
                            "createdBy",
                            "UF_RPA_1_NAME"
                        ]
                    }
                }
            );
            
            const result = response.getData().result;
            console.log('response', result.answer);
            if(result.error())
                alert("Error: " + result.error());
            else
                console.log(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'rpa.comment.add',
                    [
                        'typeId' => 1,
                        'fields' => [
                            'kanban' => [
                                'createdBy',
                                'UF_RPA_1_NAME'
                            ]
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            echo 'response: ' . $result['answer'];
            if ($result['error']) {
                echo 'Error: ' . $result['error'];
            } else {
                echo 'Data: ' . print_r($result['data'], true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding comment: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'rpa.comment.add',
            {
                "typeId": 1,
                "fields": {
                    "kanban": [
                        "createdBy",
                        "UF_RPA_1_NAME"
                    ]
                }
            },
            function(result) {
                console.log('response', result.answer);
                if(result.error())
                    alert("Error: " + result.error());
                else
                    console.log(result.data());
            }
        )
        

Response Handling

The method will return a result similar to the request rpa.fields.getSettings.

Continue Learning