Service Operation API
The Service Operation API manages Service Operations in Deepser, including incidents, requests, changes, and other service record types. All user roles can access this API, though with different permission levels. This section describes the endpoints, role-based permissions, and available fields.
Endpoints
http://deepserhost/api/rest/service/operation/[id]
http://deepserhost/api/rest/service/operations
Roles
| Administrator | Operator | Key User | User | |
|---|---|---|---|---|
| Actions Allowed | RETRIEVE CREATE UPDATE DELETE | RETRIEVE CREATE UPDATE DELETE | RETRIEVE CREATE UPDATE DELETE | RETRIEVE CREATE UPDATE |
note
End Users (User role) can create and update their own Service Operations but cannot delete them.
Fields
The following table lists all fields of the Service Operation entity:
| Field | Description |
|---|---|
| entity_id | The unique ID of the record. |
| type_id | The numerical type ID (incident, request, change, etc.). See the Service Type API to retrieve available types. |
| title | Brief title of the Service Operation. |
| category1 | Category (1st level). Used for routing to working teams and cataloging the requested activity. |
| category2 | Category (2nd level). |
| category3 | Category (3rd level). |
| description | Extended description of the Service Operation. |
| status | Lifecycle status of the Service Operation. |
| priority_id | Priority from the working team perspective. |
| urgency_id | Urgency from the requester perspective. |
| submit_username | The user who created the record. May differ from the requester (e.g., a secretary submitting on behalf of a manager). |
| requester_username | The user who is actually requesting the service. |
| assigned_group_id | The working team assigned to resolve the Service Operation. |
| assigned_username | The individual Operator or Key User assigned to the Service Operation. |
| created_at | Creation date of the record. |
| updated_at | Date of the last update. |
| closed_at | Closing date. Reset to null if the record is reopened. |
| archived | Whether the Service Operation is archived. Archived records are hidden from standard grids but remain accessible in the Archived grid. |
| archived_at | Date when the record was archived. |
| updated_by | The user who last updated the record. |
| deleted | Whether the record is soft-deleted. Soft-deleted records are marked as deleted but remain in the database (visible in the Deleted grid). To permanently remove a record, use the physical Delete action. |
| deleted_at | Date when the record was soft-deleted. |
| mailbox_id | The mailbox used for notifications about this Service Operation. Falls back to the default outgoing mailbox if not set. |
| due_date | The agreed resolution date. |
| version | The record version number. Deepser maintains a full version history with change details, author, and timestamps. |
| solution | The resolution description. Can be emailed to the requester or published on the User Portal. |
| formtemplate_id | The form template ID of the record. |