Update Process Element rpa.item.update

Scope: rpa

Who can execute the method: a user allowed to edit stage items or change the item stage, or the element author allowed to start the workflow

This method updates the element with the identifier id in the process with the identifier typeId.

The method checks permissions in the following order.

1. The user must be able to view the element. All Bitrix24 employees can view elements; they are not available to extranet users. Without view access, the method returns an error and does not return the element data. The error code depends on the request:

   • RPA_ITEM_MOVE_ACCESS_DENIED — the request contains stageId
   • RPA_ITEM_MODIFY_ACCESS_DENIED — the request contains custom fields
   • RPA_ITEM_VIEW_ACCESS_DENIED — in all other cases

2. If the request contains stageId, the method checks the permission to change the stage. The user has it if any of the following is true:

   • the user is listed in the "Users allowed to change item stage" setting of the current stage
   • the user is the element author and is listed in "Users allowed to start the workflow"
   • the user is the element author, and the element is at the first stage

3. If the request changes custom field values, the method checks the permission to edit the element. The user has it if any of the following is true:

   • the user is listed in the "Users allowed to edit stage items" setting of the current stage
   • the user is the element author and is listed in "Users allowed to start the workflow". In this case, the user can edit their own element at any stage

A Bitrix24 administrator passes all checks. The permission to start the workflow does not allow editing or moving other users' elements.

If the request does not change field values, for example, it passes the current values, the edit permission is not checked.

Method ParametersMethod Parameters

Required parameters are marked with *

Parameter fieldsParameter fields

Code ExamplesCode Examples

1. Upload a new file to replace the old one (non-multiple field)

   To replace a file in a non-multiple field, simply upload the new file. The old one will be automatically deleted.

   JS

   {
               "fields": {
                   "UF_RPA_1_1585069397": [
                       "myfile.pdf", "...base64_encoded_file_content..."
                   ]
               }
           }
           

2. Remove the value of a custom file field

   To do this, simply pass an empty string '' instead of the value.

3. Keep the value of a non-multiple file field unchanged

   The simplest option is to not include the key for this field in fields. However, if you need to pass it without changing it, you should provide a list where the key id contains the file identifier.

   JS

   {
               "fields": {
                   "UF_RPA_1_1585069397": {
                       "id": 433    
                   }
               }
           }
           

   Warning

   If a value different from the current one is passed in id, the field value will be reset and the file will be deleted.

4. Working with a multiple file field

   The value of a multiple field is an array. Each element of the array follows the same rules as for non-multiple values.

5. Partial overwrite of a multiple file field value

   For example, currently the multiple file field contains the values [12, 255, 44].

   You need to keep files 12 and 44, and upload a new file instead of 255.

   The request should look as follows:

   JS

   {
               "fields": {
                   "UF_RPA_1_1585069397": [
                       {
                           "id": 12
                       },
                       {
                           "id": 44
                       },
                       [
                           "myNewFile.pdf",
                           "...base64_encoded_file_content..."
                       ]
                   ]
               }
           }
           

Error HandlingError Handling

HTTP Status: 400

{
            "error": "RPA_ITEM_MODIFY_ACCESS_DENIED",
            "error_description": "You do not have permission to edit items in stage Approval"
        }
        

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Continue LearningContinue Learning

• Elements: Overview of Methods
• Add Process Element rpa.item.add
• Get Information About the rpa.item.get Element
• Get Data on Current Tasks of the Element rpa.item.getTasks
• Retrieve an Array of Process Elements rpa.item.list
• Delete Element rpa.item.delete