The Activity entity is used to manage all the comments and worklogs in Deepser.
Activities can be accessed by all user Roles in the API.
Activities API access changes based on the Main Model (model_alias) the Activity is referring to.
At the moment Activity are supported for Service Operation Model only.
Endpoints
http://deepserhost/api/rest/service/operation/[operation_id]/activity/[activity_id]http://deepserhost/api/rest/service/operation/[operation_id]/activitiesRoles
Here we list all the permissions by user role regarding the API:
| Admininistrator | Agent | Key User | User | |
|---|---|---|---|---|
| Actions Allowed | RETRIEVE CREATE UPDATE DELETE | RETRIEVE CREATE UPDATE DELETE | RETRIEVE CREATE UPDATE DELETE | RETRIEVE * CREATE * |
* A user can create only Activity of type Comment and the created_by User is forced to the End User itself by default.
Fields
Here we list all the fields of the entity to describe their meainings in Deepser:
| Field | Meaning |
|---|---|
| entity_id | The unique ID to identify the record. |
| type | 1 for Comments, 2 for Worklogs. |
| description | The description of the Activity. |
| portal_visibility | If 0 the Activity is not visibile to the End Users. If 1 it is visibile in the User Portal. |
| position | The order in which are displayed the Types. |
| started_at | Date when the activity has started. |
| ended_at | Date when the activity has ended. |
| duration | The duration of the activity. |
| created_by | The user who created the record. |
| model_alias | The Deepser model the Activity refers to. For example, if the activity is related to a ticket (operation) the model_alias will be deep_service/operation. |
| model_id | The Deepser model ID the Activity refers to. It is the unique ID of the model identified by model_alias field. |
| status | The status of the Activity (Enabled / Disabled). |
| formtemplate_id | The formtemplate ID of the record. |
| created_at | Creation date of the record. |
| updated_at | Date of the last update on the system. |
