Get the list of timeline records for the item rpa.timeline.listForItem

Scope: rpa

Who can execute the method: any user

The method retrieves a list of timeline records for the itemId of the typeId process.

Records are sorted in descending order by creation date, meaning the most recent ones appear at the top of the list.

Method Parameters

Name
type

Description

typeId
integer

Identifier of the process

itemId
integer

Identifier of the item

start
integer

This parameter is used to control pagination.

The page size for results is always static — 50 records.

To select the second page of results, you need to pass the value 50. To select the third page of results — the value 100, and so on.

The formula for calculating the start parameter value:

start = (N - 1) * 50, where N is the desired page number

Response Handling

HTTP Status: 200

{
            "timeline": [
                {
                    "id": 321,
                    "typeId": 24,
                    "itemId": 10,
                    "createdTime": "2020-03-26T20:28:57+02:00",
                    "userId": 1,
                    "title": "Task completed",
                    "description": "",
                    "action": "task_complete",
                    "isFixed": false,
                    "data": {
                        "item": {
                            "name": "New name"
                        },
                        "scope": "task",
                        "stageFrom": {
                            "id": 30,
                            "name": "Approved by accountant"
                        },
                        "stageTo": {
                            "id": 31,
                            "name": "Approved"
                        },
                        "fields": [
                            {
                                "name": "UF_RPA_24_NAME",
                                "title": "Name"
                            }
                        ],
                        "task": {
                            "ID": "91",
                            "USER_ID": "1",
                            "WORKFLOW_ID": "5e7cf3e91ef413.27314358",
                            "ACTIVITY": "RpaRequestActivity",
                            "ACTIVITY_NAME": "A79985_79846_49104_50661",
                            "NAME": "Task",
                            "DESCRIPTION": "",
                            "PARAMETERS": {
                                "DOCUMENT_ID": [
                                    "rpa",
                                    "Bitrix\\Rpa\\Integration\\Bizproc\\Document\\Item",
                                    "24:10"
                                ],
                                "TASK_EDIT_URL": "/rpa/task/id/#ID#/",
                                "ACTIONS": [
                                    {
                                        "color": "3bc8f5",
                                        "stageId": "31",
                                        "label": "Save"
                                    }
                                ],
                                "FIELDS_TO_SHOW": [
                                    "UF_RPA_24_NAME",
                                    "UF_RPA_24_STRING_MANDATORY"
                                ],
                                "RESPONSIBLE_TYPE": null,
                                "APPROVE_TYPE": null,
                                "FIELDS_TO_SET": [
                                    "UF_RPA_24_NAME"
                                ]
                            },
                            "USERS": [
                                1
                            ],
                            "INCOMPLETE_USERS": []
                        }
                    },
                    "createdTimestamp": 1585247337000,
                    "users": {
                        "1": {
                            "id": "1",
                            "name": "Anton",
                            "secondName": "",
                            "lastName": "Gorbylev",
                            "title": null,
                            "workPosition": "",
                            "fullName": "Anton Gorbylev",
                            "link": "/company/personal/user/1/"
                        }
                    }
                }
            ]
        }

Returned Data

Name

Description

id

Identifier of the record

typeId

Identifier of the process

itemId

Identifier of the item

createdTime

Creation time of the record

userId

Identifier of the user who initiated the action

title

Title of the record

description

Text content of the record

action

Action type code

isFixed

Flag indicating if the record is fixed

data

Serialized data about the completed action and related entities at the time of record creation. Depending on the action type, it may contain a different set of data

Data Object

Name

Description

item

Data about the item:

  • item[name] — name of the item at the time of action execution

scope

Code of the action source. Can take the value:

  • manual — manually
  • task — when performing a task
  • automation — by an Automation rule
  • rest — by an application

stageFrom

Data about the original stage at the time of action execution

  • id — identifier
  • name — name

stageTo

Data about the new stage, if it was changed during the action execution

fields

Array of data about the fields whose values were changed during the action execution

  • name — field code
  • title — field title

task

Data about the task, if the action was performed while executing a task

users

Data about the users involved in the action

Continue Exploring

Previous
Update Record Attachment Flag
Next
Delete Timeline Record