Vivantio
App Vendor: Vivantio
App Category: IT Services
Connector Version: 1.0.0
API Version: v1.0
About App
The Vivantio platform allows you to manage all aspects of IT operations from incident, problem, and change requests to asset management, all in a single platform.
The Vivantio app is configured with Orchestrate to perform the following actions:
Action Name | Description |
|---|---|
Add Note | This action adds a note to a ticket. |
Close Ticket | This action closes a ticket. |
Create Ticket | This action creates a ticket. |
Fetch Tickets | This action retrieves a list of tickets based on the criteria specified in the query. |
Get Ticket Details | This action retrieves the details of a ticket based on the ticket ID. |
Update Ticket Details | This action updates the details of a ticket. |
Update Ticket Status | This action updates the status of a ticket. |
Configuration Parameters
The following configuration parameters are required for the Vivantio app to communicate with the Vivantio enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Base URL | Enter the base URL to access the Vivantio instance. | Text | Required | |
Username | Enter the username. | Text | Required | |
Password | Enter the password. | Password | Required |
Action: Add Note
This action adds a note to a ticket.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Notes | Enter a note to add to a ticket. Example: "sample note" | Text | Required | |
Extra Params | Enter the extra parameters. Example: {"markprivate": true} | Key Value | Optional | Allowed keys:
|
Example Request
[
{
"notes": "sample note"
}
]Action: Close Ticket
This action closes a ticket.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Close Status ID | Enter the close status ID. Example: 456 | Integer | Required | |
Close Date | Enter the closing date or time of the ticket. Example: "18/05/2022" | Text | Required | |
Extra Params | Enter the extra parameters. | Key Value | Optional | For more information on the extra parameters, see Extra Params. |
Example Request
[
{
"close_id": 123,
"close_date": "21/10/22"
}
]Action: Create Ticket
This action creates a ticket.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Record ID | Enter the record type ID. Example: 1 | Integer | Required | You can retrieve a record ID using the action Fetch Tickets. |
Title | Enter the title. Example: "sample title" | Text | Optional | |
Client ID | Enter the client ID. Example: 3 | Integer | Optional | You can retrieve a client ID using the action Fetch Tickets. |
Caller Name | Enter the caller name. Example: "caller_a" | Text | Optional | |
Description | Enter the description. Example: "sample description" | Text | Optional | |
Effort | Enter the effort in minutes to record ticket history. Example: 23 | Integer | Optional | |
Extra Params | Enter the extra parameters. Example: {"markprivate": true} | Key Value | Optional | Allowed keys:
|
Example Request
[
{
"title": "sample title",
"effort": 1,
"client_id": 34,
"record_id": 23,
"caller_name": "Sample name",
"description": "sample description"
}
]Action: Fetch Tickets
This action retrieves a list of tickets based on the criteria specified in the query.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Query | Enter the query to retrieve tickets. Example: $JSON[{"mode": "matchall","items": [{"fieldname": "id","op": "equals","value": 123,"mode": "matchany","items": []}}] | Any | Required |
Example Request
[
{
"query": {
"Mode": "MatchAll",
"Items": [
{
"Op": "Equals",
"Mode": "MatchAny",
"Items": [],
"Value": 123,
"FieldName": "Id"
}
]
}
}
]Action: Get Ticket Details
This action retrieves the details of a ticket based on the ticket ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Ticket ID | Enter the ticket ID to retrieve the details. Example: 244 | Integer | Required | You can retrieve a ticket ID using the action Fetch Tickets. |
Example Request
[
{
"ticket_id": 244
}
]Action: Update Ticket Details
This action updates the details of a ticket.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Title | Enter the title. Example: "sample title" | Text | Optional | |
Client ID | Enter the client ID. Example: 3 | Integer | Optional | You can retrieve a client ID using the action Fetch Tickets. |
Caller Name | Enter the caller name. Example: "caller_a" | Text | Optional | |
Description | Enter the description. Example: "sample description" | Text | Optional | |
Effort | Enter the effort in minutes to record ticket history. Example: 23 | Integer | Optional | |
Extra Params | Enter the extra optional parameters. Example: {"markprivate": true} | Key Value | Optional | Allowed keys:
|
Example Request
[
{
"title":"sample title",
"effort":1,
"client_id":34,
"caller_name":"Sample name",
"description":"sample description"
}
]Action: Update Ticket Status
This action updates the status of a ticket.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Status ID | Enter the status ID. Example: 3 | Integer | Optional | You can retrieve a status ID using the action Fetch Tickets. |
Status Name | Enter the status name. Example: "in progress" | Text | Optional | |
Effort | Enter the effort in minutes to record ticket history. Example: 23 | Integer | Optional | |
Extra Params | Enter the extra parameters. Example: {"markprivate": true} | Key Value | Optional | Allowed keys:
|
Example Request
[
{
"status_id":34,
"status_name":"in progress",
"effort":23
}
]