Get Information About the rpa.item.get Element
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
rpaWho can execute the method: any user
DEPRECATED
The development of this method has been halted. Use Smart scripts as an alternative to this functionality.
This method retrieves information about the element with the identifier id of the process with the identifier typeId.
|
Name |
Description |
|
typeId |
Identifier of the process |
|
id |
Identifier of the element |
Response Handling
HTTP Status: 200
{
"item": {
"id": 43,
"stageId": 4,
"previousStageId": 3,
"name": "Element Name",
"typeId": 1,
"createdBy": 1,
"updatedBy": 1,
"createdTime": "03/19/2020 01:07:39 PM",
"updatedTime": "03/23/2020 06:34:05 PM",
"movedTime": "03/23/2020 06:34:05 PM",
"detailUrl": "/rpa/item/1/43/",
"movedBy": 1,
"UF_RPA_1_NAME": "Element Name",
"tasksCounter": 0,
"tasksFaces": {
"completed": [
1
],
"running": [],
"all": [
1
]
},
"permissions": {
"draggable": true,
"droppable": true,
"canDelete": true,
"canModify": true
},
"users": {
"1": {
"id": "1",
"name": "Anthony",
"secondName": null,
"lastName": "",
"title": null,
"workPosition": null,
"fullName": "Anthony",
"link": "/company/personal/user/1/"
}
}
}
}
Returned Data
|
Name |
Description |
|
stageId |
Identifier of the stage the element is currently in |
|
previousStageId |
Identifier of the previous stage of the element |
|
name |
Name of the element |
|
typeId |
Identifier of the process |
|
createdBy |
Identifier of the user who created the element |
|
updatedBy |
Identifier of the user who modified the element |
|
movedBy |
Identifier of the user who changed the stage of the element |
|
createdTime |
Time the element was created |
|
updatedTime |
Time the element was modified |
|
movedTime |
Time the stage of the element was changed |
|
detailUrl |
Link to the detail form of the element |
|
tasksCounter |
Number of tasks associated with the element for the user |
|
tasksFaces |
Information for rendering the sequence of responsible parties during approval:
|
|
permissions |
Permissions of the current user for the element:
|
|
users |
Aggregated information about all users related to the element. A list where the key is the user identifier:
|
|
UF_RPA_... |
Values of custom fields. Values of multiple fields are returned as an array. File-type field values are returned as a list:
|
Error Handling
HTTP Status: 400
{
"error": "RPA_ITEM_VIEW_ACCESS_DENIED",
"error_description": "You don't have permission to view this item."
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
You don't have permission to view this item |
The user cannot view the element. All Bitrix24 employees can view elements; they are not available to extranet users |
Statuses 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.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |