Manages the Breaking News.
Returns the requested Breaking News.
Parameters
| Name |
Description |
Type |
|
date_format
|
Indicate the date format. The available formats are 'epoch' or 'iso8601'. If null, epoch format is returned.
|
STRING |
|
id
required
|
Breaking News ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
created_at
|
Creation date in epoch or ISO-8601 format depending on the date_format parameter.
|
STRING |
|
affected_helpdesk_ids
|
Array with IDs of affected help desks.
|
ARRAY |
|
created_by_id
|
Breaking News creator ID.
|
INTEGER |
|
type_id
|
Breaking News type ID.
|
INTEGER |
|
resolution_time
|
Resolution time in epoch or ISO-8601 format depending on the date_format parameter.
|
STRING |
|
affected_group_ids
|
Array with IDs of affected groups.
|
ARRAY |
|
title
|
Breaking News title.
|
STRING |
|
id
|
Breaking News ID.
|
INTEGER |
|
body
|
Breaking News body.
|
TEXT |
|
status_id
|
Breaking News status ID.
|
INTEGER |
Creates Breaking News.
Parameters
| Name |
Description |
Type |
|
affected_group_ids
|
Groups that are affected. It is required unless there is at least one help desk affected.
|
ARRAY |
|
creator_id
|
ID of the Breaking News' creator. If none is provided then it will be the system.
|
INTEGER |
|
type_id
required
|
Type ID of the breaking news based on importance. 1: High, 2: Medium, 3: Low.
|
INTEGER |
|
resolution_time
|
Estimated resolution time. Must be a timestamp (epoch format).
|
INTEGER |
|
affected_helpdesk_ids
|
Help desks that are affected. It is required unless there is at least one group affected.
|
ARRAY |
|
major_incident_id
|
ID of the major incident associated with the Breaking News.
|
INTEGER |
|
title
required
|
Breaking News title.
|
STRING |
|
body
required
|
Breaking News body.
|
TEXT |
Response
| Name |
Description |
Type |
|
id
|
ID of the Breaking News created.
|
INTEGER |
|
info
|
Description of the result.
|
STRING |
|
status
|
Returns 'OK' if the Breaking News was correctly created; or 'ERROR' if something went wrong.
|
STRING |
Modifies a set of Breaking News.
Parameters
| Name |
Description |
Type |
|
affected_helpdesk_ids
|
Help desks that are affected. It is required unless there is at least one group affected.
|
ARRAY |
|
creator_id
|
ID of the Breaking News' creator. If none is provided then it will be the system.
|
INTEGER |
|
type_id
|
Type ID of the breaking news based on importance. 1: High, 2: Medium, 3: Low.
|
INTEGER |
|
resolution_time
|
Estimated resolution time. Must be a timestamp (epoch format).
|
INTEGER |
|
affected_group_ids
|
Groups that are affected. It is required unless there is at least one help desk affected.
|
ARRAY |
|
title
|
Breaking News title.
|
STRING |
|
id
required
|
Breaking News ID.
|
INTEGER |
|
body
|
Breaking News body.
|
TEXT |
|
status_id
|
Breaking News status ID. 1: Open, 2: Closed.
|
INTEGER |
Response
| Name |
Description |
Type |
|
info
|
Description of the result.
|
STRING |
|
status
|
Returns 'OK' if the Breaking News was correctly modified; or 'ERROR' if something went wrong.
|
STRING |
Lists the Breaking News.
Lists all the Breaking News.
Parameters
| Name |
Description |
Type |
|
date_format
|
Indicate the date format. The available formats are 'epoch' or 'iso8601'. If null, epoch format is returned.
|
STRING |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
created_by_id
|
Breaking News creator ID.
|
INTEGER |
|
affected_helpdesk_ids
|
Array with IDs of affected help desks.
|
ARRAY |
|
type_id
|
Breaking News type ID.
|
INTEGER |
|
resolution_time
|
Resolution time in epoch or ISO-8601 format depending on the date_format parameter.
|
STRING |
|
title
|
Breaking News title.
|
STRING |
|
created_at
|
Creation date in epoch or ISO-8601 format depending on the date_format parameter.
|
STRING |
|
affected_group_ids
|
Array with IDs of affected groups.
|
ARRAY |
|
id
|
Breaking News ID.
|
INTEGER |
|
body
|
Breaking News body.
|
TEXT |
|
status_id
|
Breaking News status ID.
|
INTEGER |
Lists the status of the Breaking News.
Lists all the possible status for the Breaking News' and their descriptions. If an ID is provided, only one will be listed.
Parameters
| Name |
Description |
Type |
|
id
|
Status ID.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
name
|
Status name.
|
STRING |
|
id
|
Status ID.
|
INTEGER |
Lists all the Breaking News importance types.
Lists all the importance types of the Breaking News. If an ID its provided, only one will be listed.
Parameters
| Name |
Description |
Type |
|
id
|
Importance type ID.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
name
|
Importance type name.
|
STRING |
|
id
|
Importance type ID.
|
INTEGER |
Manages the updates of the Breaking News.
Returns the updates of the requested Breaking News.
Parameters
| Name |
Description |
Type |
|
date_format
|
Indicate the date format. The available formats are 'epoch' or 'iso8601'. If null, epoch format is returned.
|
STRING |
|
id
required
|
Breaking News ID.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
created_at
|
Creation date in epoch or ISO-8601 format depending on the date_format parameter.
|
STRING |
|
creator_id
|
Breaking News creator ID.
|
INTEGER |
|
body
|
Body of the update.
|
TEXT |
Creates a new update to the given Breaking News.
Parameters
| Name |
Description |
Type |
|
is_solution
|
Send 1 to close Breaking News. Send 0 to keep open. Default: 0.
|
BOOLEAN |
|
creator_id
|
ID of the Breaking News' creator. If none is provided then it will be the system.
|
INTEGER |
|
id
required
|
Breaking News ID.
|
INTEGER |
|
body
required
|
Breaking News body.
|
TEXT |
Response
| Name |
Description |
Type |
|
info
|
Description of the result.
|
STRING |
|
status
|
Returns 'OK' if the Breaking News update was correctly created; or 'ERROR' if something went wrong.
|
STRING |
Lists all the categories with optional text search and pagination.
Lists all the categories, or the required one if an ID is provided. Supports text search and pagination.
Parameters
| Name |
Description |
Type |
|
id
|
Category ID.
|
INTEGER |
|
search
|
Search text for category names.
|
STRING |
|
page_size
|
Number of items per page. Default 20, max 500.
|
INTEGER |
|
page
|
Page number for pagination.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
name
|
Category name.
|
STRING |
|
id
|
Category ID.
|
INTEGER |
|
parent_category_id
|
Category parent ID.
|
INTEGER |
Manages the settings of the list type custom fields.
Lists the configuration of custom fields that are a list type.
Parameters
| Name |
Description |
Type |
|
uid
required
|
Custom field ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
key-value
|
Returns an array with the key-values dictionary of the custom field.
|
ARRAY |
Configures list type custom fields. If the key already exists, the previous value will be overwritten.
Parameters
| Name |
Description |
Type |
|
uid
required
|
Custom field ID.
|
INTEGER |
|
type
required
|
Type of configuration to change.
Types:
key-value.
|
STRING |
|
key_values
required
|
Dictionary {key1: value1, key2: value2, ...} with key-values pairs to be added to the CF list.
|
ARRAY |
Response
| Name |
Description |
Type |
|
total
|
Number of modified/added values.
|
INTEGER |
|
info
|
Description of the result.
|
STRING |
|
status
|
Returns 'OK' if the custom field option was correctly added or modified; or 'ERROR' if something went wrong.
|
STRING |
Erases keys from the list type custom fields configuration.
Parameters
| Name |
Description |
Type |
|
uid
required
|
Custom field ID.
|
INTEGER |
|
type
required
|
Type of configuration to change.
Types:
key-value.
|
STRING |
|
keys
required
|
Array [key1,key2] of keys to be erased.
|
ARRAY |
Response
| Name |
Description |
Type |
|
total
|
Number of deleted values.
|
INTEGER |
|
info
|
Description of the result.
|
STRING |
|
status
|
Returns 'OK' if the custom field option was correctly deleted; or 'ERROR' if something went wrong.
|
STRING |
Lists the configuration of the list type custom fields.
Lists the configuration of custom fields that are of type list.
Parameters
| Name |
Description |
Type |
|
uid
required
|
Custom field ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
count
|
The count of configurations in the response.
|
INTEGER |
|
configurations
|
Returns an array with the list of options with its configurations for the custom field.
|
ARRAY |
Manages the settings of the tree type custom fields.
Returns the structure of the tree type custom fields options. The hash is system internal, but it is used to make modifications.
Parameters
| Name |
Description |
Type |
|
uid
required
|
Custom field ID.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
name
|
Option name.
|
STRING |
|
key
|
Key defined by the user for the option.
|
STRING |
|
hash
|
The unique internal identifier of the option.
|
STRING |
|
children
|
Array of the option's children.
|
ARRAY |
Adds configuration to the tree type custom fields. If the key already exists, the previous value will be overwritten.
Parameters
| Name |
Description |
Type |
|
uid
required
|
Custom field ID.
|
INTEGER |
|
name
required
|
Name of the option, value that the user sees when selecting.
|
STRING |
|
key
|
Key defined by the user; if no value is set, the hash will be used as key.
|
STRING |
|
parent_hash
|
Hash value of the parent; if not set, it will be added to the root.
|
STRING |
Response
| Name |
Description |
Type |
|
info
|
Description of the result.
|
STRING |
|
status
|
Returns 'OK' if the custom field option was correctly added; or 'ERROR' if something went wrong.
|
STRING |
Modifies the configuration of the tree type custom fields. If there is no such key, it will be added.
Parameters
| Name |
Description |
Type |
|
uid
required
|
Custom field ID.
|
INTEGER |
|
name
|
Name of the option, value that the user sees when selecting.
|
STRING |
|
key
|
Key defined by the user; if no value is set the previous value will be used.
|
STRING |
|
hash
required
|
Hash value of the item to modify.
|
STRING |
Response
| Name |
Description |
Type |
|
info
|
Description of the result.
|
STRING |
|
status
|
Returns 'OK' if the custom field option was correctly modified; or 'ERROR' if something went wrong.
|
STRING |
Erases the options from the tree type custom fields and any of its children.
Parameters
| Name |
Description |
Type |
|
uid
required
|
Custom field ID.
|
INTEGER |
|
hash
required
|
Hash value of the item to modify.
|
STRING |
Response
| Name |
Description |
Type |
|
info
|
Description of the result.
|
STRING |
|
status
|
Returns 'OK' if the custom field option was correctly deleted; or 'ERROR' if something went wrong.
|
STRING |
Lists the active custom fields.
Returns a list of all the active custom fields.
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
uid
|
Custom field ID.
|
INTEGER |
|
label
|
Custom field name.
|
STRING |
|
is_required
|
Indicates if the custom field is required. True if it's required and false if it's not.
|
BOOLEAN |
|
description
|
Custom field description.
|
TEXT |
|
type
|
Custom field type ID.
|
INTEGER |
|
categories
|
Categories where custom field applies.
|
STRING |
Custom fields by category.
Returns a list of the custom fields related to a category ID.
Parameters
| Name |
Description |
Type |
|
category_id
required
|
Category ID.
|
INTEGER |
Response
Returns an array with the IDs of the custom fields that apply to the category received as a parameter.
| Name |
Description |
Type |
|
uid
|
Custom field ID.
|
INTEGER |
Lists the active shared custom fields.
Returns a list of all the active shared custom fields.
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
uid
|
Shared custom field ID.
|
INTEGER |
|
label
|
Shared custom field label.
|
STRING |
|
type
|
Shared custom field type ID.
|
INTEGER |
|
description
|
Shared custom field description.
|
TEXT |
Lists all the supported custom field types.
Returns a list of all the supported custom field types, with a brief description of the data type for each field.
Response
Returns an array with the following structure:
| Name |
Description |
Type |
|
name
|
Custom field type name.
|
STRING |
|
id
|
Custom field type ID.
|
INTEGER |
Manages configuration items from custom fields and shared custom fields by IDs.
Returns an array of CIs, linked through custom fields and shared custom fields, with their IDs and properties.
Parameters
| Name |
Description |
Type |
|
ci_internal_ids
required
|
Configuration items IDs from Service Management.
|
ARRAY |
|
ci_source_id
|
ID of the ITAM tool integration in Service Management.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
ci_name
|
Configuration item name.
|
STRING |
|
ci_internal_id
|
Configuration item ID from Service Management.
|
INTEGER |
|
ci_external_id
|
Configuration item external source ID.
|
INTEGER |
Manages companies.
Returns all the active companies.
Parameters
| Name |
Description |
Type |
|
name
|
Company name.
|
STRING |
|
id
|
Company ID.
|
INTEGER |
|
external_id
|
External ID.
|
STRING |
Response
Returns an array of companies with the following structure:
| Name |
Description |
Type |
|
total
|
Users total.
|
INTEGER |
|
name
|
Company name.
|
STRING |
|
id
|
Company ID.
|
INTEGER |
|
external_id
|
External ID.
|
STRING |
Creates a new company.
Parameters
| Name |
Description |
Type |
|
name
required
|
Company name.
|
STRING |
|
external_id
|
External ID.
|
STRING |
Response
| Name |
Description |
Type |
|
name
|
Company name.
|
STRING |
|
id
|
ID of the created object.
|
INTEGER |
|
external_id
|
External ID.
|
STRING |
|
status
|
Returns 'OK' if the company was correctly created; or 'ERROR' if something went wrong.
|
STRING |
Modifies an existing company.
Parameters
| Name |
Description |
Type |
|
name
|
Company name.
|
STRING |
|
id
required
|
Company ID.
|
INTEGER |
|
external_id
|
External ID.
|
STRING |
Response
| Name |
Description |
Type |
|
name
|
Company name.
|
STRING |
|
id
|
Company ID.
|
INTEGER |
|
external_id
|
External ID.
|
STRING |
|
status
|
Returns 'OK' if the company was correctly modified; or 'ERROR' if something went wrong.
|
STRING |
Erases an existing company.
Parameters
| Name |
Description |
Type |
|
id
required
|
Company ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the company was correctly deleted; or 'ERROR' if something went wrong.
|
STRING |
Manages the relationships between users groups and companies.
Lists all the users groups related to a company.
Parameters
| Name |
Description |
Type |
|
id
required
|
Company ID.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
total
|
Users total.
|
INTEGER |
|
name
|
Name of the related group.
|
STRING |
|
id
|
ID of the related group.
|
INTEGER |
Relates a users group to a company.
Parameters
| Name |
Description |
Type |
|
id
required
|
Company ID.
|
INTEGER |
|
groups
required
|
Groups IDs.
|
ARRAY |
Response
Returns an array of groups IDs as keys and TRUE as values of the created relations.
| Name |
Description |
Type |
|
id
|
Group ID.
|
ARRAY |
Suppresses the relationship between a users group and a company.
Parameters
| Name |
Description |
Type |
|
id
required
|
Company ID.
|
INTEGER |
|
unlink_users_too
|
When is set to true, it breaks the relation between the company users and the group.
|
BOOLEAN |
|
groups
required
|
Groups IDs.
|
ARRAY |
Response
Returns an array of groups IDs as keys and TRUE as values of the deleted relations.
| Name |
Description |
Type |
|
id
|
Group ID.
|
ARRAY |
Manages companies observers.
Returns all active companies and their observers,
or the observers for the specified companies.
Parameters
| Name |
Description |
Type |
|
ids
|
Company IDs.
|
ARRAY |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
observer_groups
|
The groups’ IDs that are observers of the entity.
|
ARRAY |
|
name
|
Company name.
|
STRING |
|
id
|
Company ID.
|
INTEGER |
|
observer_users
|
The observers’ users IDs.
|
ARRAY |
Add users as observers to a company.
Parameters
| Name |
Description |
Type |
|
observer_users
required
|
Users IDs to be added as observers.
|
ARRAY |
|
id
required
|
Company ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
value
|
Returns 'true' if the users were correctly added as observers to the company.
Returns 'false' if, for any reason, they weren't added to the company,
or if the users were already observers of the company.
|
BOOLEAN |
|
id
|
User ID.
|
INTEGER |
Removes observers from a company.
Parameters
| Name |
Description |
Type |
|
observer_users
required
|
Users IDs to be removed as observers.
|
ARRAY |
|
id
required
|
Company ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
value
|
Returns 'true' if the users were correctly removed as observers from the company.
Returns 'false' if, for any reason, they weren't removed from the company,
or if the users weren't observers of the company.
|
BOOLEAN |
|
id
|
User ID.
|
INTEGER |
Manages the relationships between users and companies.
Lists the members of a company.
Parameters
| Name |
Description |
Type |
|
user_id
|
User ID
|
INTEGER |
|
id
required
|
Company ID.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
name
|
User full name.
|
STRING |
|
id
|
User ID.
|
INTEGER |
|
username
|
Username.
|
STRING |
|
email
|
User email.
|
STRING |
Adds a user to a company. If the company contains groups, the users will also be added to those groups.
Parameters
| Name |
Description |
Type |
|
id
required
|
Company ID.
|
INTEGER |
|
users
required
|
Users IDs.
|
ARRAY |
Response
Returns an array of users IDs as keys and TRUE as values of the created relations.
| Name |
Description |
Type |
|
id
|
User ID.
|
ARRAY |
Removes a user from a company. If the user is within a group that belongs to that company, they will also be removed from that group.
Parameters
| Name |
Description |
Type |
|
id
required
|
Company ID.
|
INTEGER |
|
users
required
|
Users IDs.
|
ARRAY |
Response
Returns an array of users IDs as keys and TRUE as values of the deleted relations.
| Name |
Description |
Type |
|
id
|
User ID.
|
ARRAY |
Manages data exports.
Returns the data export URL.
Parameters
| Name |
Description |
Type |
|
id
required
|
The UUID of the data export report, obtained during report configuration.
|
STRING |
Response
| Name |
Description |
Type |
|
url
|
Data export report URL.
|
STRING |
|
status
|
Returns 'OK' if the data export report was correctly executed; or 'ERROR' if something went wrong.
|
STRING |
Manages groups.
Returns all active groups of users, or one in particular if an ID or name is provided.
Parameters
| Name |
Description |
Type |
|
name
|
Group name.
|
STRING |
|
id
|
Group ID.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
total
|
Users total.
|
INTEGER |
|
name
|
Group name.
|
STRING |
|
id
|
Group ID.
|
INTEGER |
Creates a group of users.
Parameters
| Name |
Description |
Type |
|
name
required
|
Group name.
|
STRING |
Response
| Name |
Description |
Type |
|
id
|
ID of the created object.
|
INTEGER |
Erases a group of users.
Parameters
| Name |
Description |
Type |
|
id
required
|
Group ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the object was correctly deleted; or 'ERROR' if something went wrong.
|
STRING |
Manages groups observers.
Returns all active groups and their observers,
or the observers for the specified groups.
Parameters
| Name |
Description |
Type |
|
ids
|
Group IDs.
|
ARRAY |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
observer_groups
|
The groups’ IDs that are observers of the entity.
|
ARRAY |
|
name
|
Group name.
|
STRING |
|
id
|
Group ID.
|
INTEGER |
|
observer_users
|
The observers’ users IDs.
|
ARRAY |
Add users as observers to a group.
Parameters
| Name |
Description |
Type |
|
observer_users
required
|
Users IDs to be added as observers.
|
ARRAY |
|
id
required
|
Group ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
value
|
Returns 'true' if the users were correctly added as observers to the group.
Returns 'false' if, for any reason, they weren't added to the group,
or if the users were already observers of the group.
|
BOOLEAN |
|
id
|
User ID.
|
INTEGER |
Removes observers from a group.
Parameters
| Name |
Description |
Type |
|
observer_users
required
|
Users IDs to be removed as observers.
|
ARRAY |
|
id
required
|
Group ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
value
|
Returns 'true' if the users were correctly removed as observers from the group.
Returns 'false' if, for any reason, they weren't removed from the group,
or if the users weren't observers of the group.
|
BOOLEAN |
|
id
|
User ID.
|
INTEGER |
Manages the relationships between users and groups.
Lists the members of a group.
Parameters
| Name |
Description |
Type |
|
user_id
|
User ID
|
INTEGER |
|
id
required
|
Group ID.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
name
|
User full name.
|
STRING |
|
id
|
User ID.
|
INTEGER |
|
username
|
Username.
|
STRING |
|
email
|
User email.
|
STRING |
Adds a user to a group.
Parameters
| Name |
Description |
Type |
|
id
required
|
Group ID.
|
INTEGER |
|
users
required
|
Users IDs.
|
ARRAY |
Response
Returns an array of users IDs as keys and TRUE as values of the created relations.
| Name |
Description |
Type |
|
id
|
User ID.
|
ARRAY |
Removes a user from a group.
Parameters
| Name |
Description |
Type |
|
id
required
|
Group ID.
|
INTEGER |
|
users
required
|
Users IDs.
|
ARRAY |
Response
Returns an array of users IDs as keys and TRUE as values of the deleted relations.
| Name |
Description |
Type |
|
id
|
User ID.
|
ARRAY |
Manages the help desks.
Returns all the active help desks, or one in particular.
Parameters
| Name |
Description |
Type |
|
name
|
Help desk name.
|
STRING |
|
id
|
Help desk ID.
|
INTEGER |
|
include_deleted
|
True if deleted help desks should be included.
|
BOOLEAN |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
total_members
|
Total of members.
|
INTEGER |
|
parent_id
|
Help desk parent ID.
|
INTEGER |
|
name
|
Help desk name.
|
STRING |
|
id
|
Help desk ID.
|
INTEGER |
|
engine_id
|
Help desk engine ID.
|
INTEGER |
|
status_id
|
Help desk status ID.
|
INTEGER |
Manages help desks observers.
Returns all active help desks and their observers,
or the observers for the specified help desks.
Parameters
| Name |
Description |
Type |
|
ids
|
Help Desk IDs.
|
ARRAY |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
observer_groups
|
The groups’ IDs that are observers of the entity.
|
ARRAY |
|
name
|
Help Desk name.
|
STRING |
|
id
|
Help Desk ID.
|
INTEGER |
|
observer_users
|
The observers’ users IDs.
|
ARRAY |
Add users as observers to a help desk.
Parameters
| Name |
Description |
Type |
|
observer_users
required
|
Users IDs to be added as observers.
|
ARRAY |
|
id
required
|
Help Desk ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
value
|
Returns 'true' if the users were correctly added as observers to the help desk.
Returns 'false' if, for any reason, they weren't added to the help desk,
or if the users were already observers of the help desk.
|
BOOLEAN |
|
id
|
User ID.
|
INTEGER |
Removes observers from a help desk.
Parameters
| Name |
Description |
Type |
|
observer_users
required
|
Users IDs to be removed as observers.
|
ARRAY |
|
id
required
|
Help Desk ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
value
|
Returns 'true' if the users were correctly removed as observers from the help desk.
Returns 'false' if, for any reason, they weren't removed from the help desk,
or if the users weren't observers of the help desk.
|
BOOLEAN |
|
id
|
User ID.
|
INTEGER |
Manages help desks and levels.
Returns all the help desks and levels, or one in particular.
Parameters
| Name |
Description |
Type |
|
id
|
Level ID.
|
INTEGER |
|
include_deleted
|
True if deleted help desks and levels should be included.
|
BOOLEAN |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
members_ids
|
Members IDs.
|
ARRAY |
|
total_members
|
Total of members.
|
INTEGER |
|
parent_id
|
Parent ID.
|
INTEGER |
|
level_order
|
If it's a level, indicates the order.
|
INTEGER |
|
name
|
If it is a help desk, indicates the name.
|
STRING |
|
id
|
Level ID.
|
INTEGER |
|
engine_id
|
Engine ID. 1: Round robin, 2: By load, 3: Free, 4: Manual.
|
INTEGER |
|
status_id
|
Status ID. 1: Enabled, 2: Suspend, 3: Out time work, 4: Disabled.
|
INTEGER |
Manages a request.
Returns the information of the given request.
Parameters
| Name |
Description |
Type |
|
date_format
|
Indicate the date format. The available formats are 'epoch' or 'iso8601'. If null, epoch format is returned.
|
STRING |
|
comments
|
When set to true, it includes the comments of the request.
|
BOOLEAN |
|
decoded_special_characters
|
Indicate if the message is returned decoded. If null, coded format is returned.
|
BOOLEAN |
|
id
required
|
Request ID.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
category_id
|
Category ID.
|
INTEGER |
|
created_at
|
Creation date in epoch or ISO-8601 format depending on the date_format parameter.
|
STRING |
|
request_customer_sentiment_initial
|
Initial customer sentiment for the request. "positive", "neutral", "negative"
|
STRING |
|
rating
|
Stars given to the solution. If there's no rating, this field won't be shown.
|
INTEGER |
|
last_update
|
Last update in epoch or ISO-8601 format depending on the date_format parameter.
|
STRING |
|
closed_reason
|
Reason of closing. 1: Solution accepted, 2: Solution expired, 3: Customer timeout, 4: Finalized workflow.
|
STRING |
|
user_id
|
Customer ID.
|
INTEGER |
|
request_customer_sentiment_current
|
Current customer sentiment for the request. "positive", "neutral", "negative"
|
STRING |
|
solved_at
|
Solution date in epoch or ISO-8601 format depending on the date_format parameter.
|
STRING |
|
process_id
|
Process ID of the request if it is a workflow instance.
|
INTEGER |
|
assigned_id
|
Assigned agent ID.
|
INTEGER |
|
custom_fields
|
Array with the custom fields ids as keys and the respective values.
|
ARRAY |
|
creator_id
|
Creator ID.
|
INTEGER |
|
pretty_id
|
Request pretty ID as configured on the Service Management instance.
|
STRING |
|
date_ocurred
|
Occurrence date in epoch or ISO-8601 format depending on the date_format parameter.
|
STRING |
|
comments
|
Array with comments of the requests with the comment structure.
|
ARRAY |
|
closed_at
|
Closing date in epoch or ISO-8601 format depending on the date_format parameter.
|
STRING |
|
assigned_group_id
|
Help desk ID.
|
INTEGER |
|
id
|
Request ID.
|
INTEGER |
|
sla_incident_first_reply
|
First response SLA of the request.
|
STRING |
|
status_id
|
Status ID.
|
INTEGER |
|
source_id
|
Source ID.
|
INTEGER |
|
type_id
|
Type ID.
|
INTEGER |
|
description
|
Request description.
|
STRING |
|
attachments
|
Array with the IDs of the attachments.
|
ARRAY |
|
sla_incident_resolution
|
Resolution SLA of the request.
|
STRING |
|
priority_id
|
Priority ID.
|
INTEGER |
|
title
|
Request title.
|
STRING |
Creates a new request in the system. To include custom fields, read
this guide.
Parameters
| Name |
Description |
Type |
|
creator_id
required
|
Creator ID.
|
INTEGER |
|
source_id
|
Source ID.
|
INTEGER |
|
title
required
|
Request title.
|
STRING |
|
location_id
|
Location ID.
|
INTEGER |
|
date
|
Occurred on timestamp in epoch format.
|
STRING |
|
category_id
required
|
Category name can be obtained calling https://releases.invgate.com/service-desk/api/#categories-GET
|
INTEGER |
|
type_id
required
|
Incident = 1, Service Request = 2, Question = 3, Problem = 4, Change = 5, Major Incident = 6
|
INTEGER |
|
description
|
Request description. Required for requests and Workflows with descriptions.
|
TEXT |
|
attachments
|
Array of request's attachments.
|
ARRAY |
|
related_to
|
Requests IDs to link.
|
ARRAY |
|
customer_id
required
|
Client ID.
|
INTEGER |
|
priority_id
required
|
Low = 1, Medium = 2, High = 3, Urgent = 4, Critical = 5
|
INTEGER |
Response
| Name |
Description |
Type |
|
request_id
|
ID of the created request.
|
INTEGER |
|
info
|
Description of the result.
|
STRING |
|
status
|
Returns 'OK' if the request was correctly created; or 'ERROR' if something went wrong.
|
STRING |
Change attributes of a request.
Parameters
| Name |
Description |
Type |
|
reassignment
|
Set to true to reassign the request to a help desk according to the new properties.
|
BOOLEAN |
|
source_id
|
Source ID.
|
INTEGER |
|
title
|
Request title.
|
STRING |
|
location_id
|
Location ID.
|
INTEGER |
|
id
required
|
Request ID.
|
INTEGER |
|
date
|
Occurred on timestamp.
|
STRING |
|
category_id
|
Category name can be obtained calling https://releases.invgate.com/service-desk/api/#categories-GET
|
INTEGER |
|
type_id
|
Incident = 1, Service Request = 2, Question = 3, Problem = 4, Change = 5, Major Incident = 6
|
INTEGER |
|
description
|
Request description.
|
TEXT |
|
date_format
|
Indicate the date format. The available formats are 'epoch' or 'iso8601'. If null, epoch format is returned.
|
STRING |
|
customer_id
|
Client ID.
|
INTEGER |
|
priority_id
|
Low = 1, Medium = 2, High = 3, Urgent = 4, Critical = 5
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
category_id
|
Category ID.
|
INTEGER |
|
created_at
|
Creation date in epoch or ISO-8601 format depending on the date_format parameter.
|
STRING |
|
last_update
|
Last update in epoch or ISO-8601 format depending on the date_format parameter.
|
STRING |
|
closed_reason
|
Reason of closing. 1: Solution accepted, 2: Solution expired, 3: Customer timeout, 4: Finalized workflow
|
STRING |
|
user_id
|
Customer ID.
|
INTEGER |
|
solved_at
|
Solution date in epoch or ISO-8601 format depending on the date_format parameter.
|
STRING |
|
process_id
|
Process ID of the request if it is a workflow instance.
|
INTEGER |
|
assigned_id
|
Assigned agent ID.
|
INTEGER |
|
custom_fields
|
Array with the custom fields IDs as keys and the respective values.
|
ARRAY |
|
creator_id
|
Creator ID.
|
INTEGER |
|
date_ocurred
|
Occurrence date in epoch or ISO-8601 format depending on the date_format parameter.
|
STRING |
|
closed_at
|
Closing date in epoch or ISO-8601 format depending on the date_format parameter.
|
STRING |
|
assigned_group_id
|
Help desk ID.
|
INTEGER |
|
location_id
|
Location ID.
|
INTEGER |
|
id
|
Request ID.
|
INTEGER |
|
status_id
|
Status ID.
|
INTEGER |
|
source_id
|
Source ID.
|
INTEGER |
|
type_id
|
Type ID.
|
INTEGER |
|
description
|
Request description.
|
STRING |
|
attachments
|
Array with the IDs of the attachments.
|
ARRAY |
|
priority_id
|
Priority ID.
|
INTEGER |
|
title
|
Request title.
|
STRING |
Manages the approvals instances of a request.
Lists the approvals instances that the given request has.
Parameters
| Name |
Description |
Type |
|
date_format
|
Indicate the date format. The available formats are 'epoch' or 'iso8601'. If null, epoch format is returned.
|
STRING |
|
only_pending
|
When set to true, it only returns pending approvals.
|
BOOLEAN |
|
request_id
required
|
Request ID.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
approval_request_description
|
Description of the approval.
|
TEXT |
|
author_id
|
Author ID of the approval.
|
INTEGER |
|
created_at
|
Date when the approval was triggered, in epoch or ISO-8601 format depending on the date_format parameter.
|
STRING |
|
id
|
ID of the approval instance.
|
INTEGER |
|
approval_request_id
|
ID of the approval template.
|
INTEGER |
|
type
|
Type ID of the approval. 1: Predefined approval, 2: Spontaneous approval.
|
INTEGER |
|
status
|
Status ID of the approval. -2: Cancelled, -1: Waiting, 0: Rejected, 1: Approved.
|
INTEGER |
Manages the acceptance of an approval.
Accepts an approval.
Parameters
| Name |
Description |
Type |
|
note
|
Note for the approval acceptance.
|
STRING |
|
user_id
required
|
ID of the user who will accept the approval.
|
INTEGER |
|
approval_id
required
|
Approval ID to be accepted.
|
INTEGER |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the approval was correctly accepted.
|
STRING |
Manages the voters of an approval.
Adds a voter to an approval.
Parameters
| Name |
Description |
Type |
|
user_id
required
|
Author ID of the approval.
|
INTEGER |
|
approval_id
required
|
ID of the approval instance.
|
INTEGER |
Response
| Name |
Description |
Type |
|
user_id
|
Author ID of the approval.
|
INTEGER |
|
approval_id
|
ID of the approval instance.
|
INTEGER |
Manages the cancellation of an approval.
Cancels an approval.
Parameters
| Name |
Description |
Type |
|
user_id
required
|
ID of the user who will cancel the approval.
|
INTEGER |
|
approval_id
required
|
Approval ID to be cancelled.
|
INTEGER |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the approval was correctly canceled; or 'ERROR' if something went wrong.
|
STRING |
Manages the users that could accept or reject the approval.
Lists users that could accept or reject the approval.
Parameters
| Name |
Description |
Type |
|
only_pending
|
When set to true, it only returns voters who have not voted.
|
BOOLEAN |
|
approval_id
required
|
Approval ID.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
id
|
User ID.
|
INTEGER |
|
status
|
Approval status ID. -2: Annulled, -1: Waiting, 0: Rejected, 1: Approved, 2:Expired.
|
INTEGER |
Manages the rejection of an approval.
Rejects an approval.
Parameters
| Name |
Description |
Type |
|
note
|
Note for the approval rejection.
|
STRING |
|
user_id
required
|
ID of the user will reject the approval.
|
INTEGER |
|
approval_id
required
|
Approval ID to be rejected.
|
INTEGER |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the approval was correctly rejected; or 'ERROR' if something went wrong.
|
STRING |
Lists the statuses of the approvals.
Lists the statuses of the approvals.
Response
Returns an array with status ID as keys and status description as values.
| Name |
Description |
Type |
|
id
|
Status ID and description.
|
ARRAY |
Lists the available approvals types.
Lists the available approvals types.
Response
Returns an array with type id as keys and type description as values.
| Name |
Description |
Type |
|
id
|
Type ID and description.
|
ARRAY |
Lists the status of the approval votes.
Lists the status of the approval votes.
Response
Returns an array with status id as keys and status description as values.
| Name |
Description |
Type |
|
id
|
Status ID and description.
|
ARRAY |
Manages the attachments of the requests.
Returns the requested attachment.
Parameters
| Name |
Description |
Type |
|
id
required
|
Attachment ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
url
|
URL of the attached file.
|
STRING |
|
name
|
Name of the attached file.
|
STRING |
|
id
|
ID of the attached file.
|
INTEGER |
|
hash
|
Hash of the attached file.
|
STRING |
|
extension
|
Extension of the attached file.
|
STRING |
Lists all the priorities.
Lists all the priorities, or only one if an ID its provided.
Parameters
| Name |
Description |
Type |
|
id
|
Priority ID.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
name
|
Priority name.
|
STRING |
|
id
|
Priority ID.
|
INTEGER |
Lists all the requests sources.
Lists all the sources. If an ID is provided, only the one that matches the specified ID will be listed.
Parameters
| Name |
Description |
Type |
|
id
|
Source ID.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
name
|
Source name.
|
STRING |
|
id
|
Source ID.
|
INTEGER |
Lists all the status.
Lists all the status. If an ID is provided, only the one that matches the specified ID will be listed.
Parameters
| Name |
Description |
Type |
|
id
|
Status ID.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
name
|
Status name.
|
STRING |
|
id
|
Status ID.
|
INTEGER |
Lists all the types.
Lists all the types. If an ID is provided, only the one that matches the specified ID will be listed. Use the status filter to include deleted types.
Parameters
| Name |
Description |
Type |
|
id
|
Type ID.
|
INTEGER |
|
status
|
Filter by status: active|deleted|all.
|
STRING |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
is_system
|
Whether the type is a system-defined one.
|
BOOLEAN |
|
name
|
Type name.
|
STRING |
|
id
|
Type ID.
|
INTEGER |
|
status
|
Type status: 'active' or 'deleted'.
|
STRING |
Manages the cancellation of a request.
Cancel a request.
Parameters
| Name |
Description |
Type |
|
author_id
required
|
ID of the user cancelling the request.
|
INTEGER |
|
request_id
required
|
ID of the request to cancel.
|
INTEGER |
|
comment
|
Cancellation message
|
STRING |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the request was correctly cancelled; or 'ERROR' if something went wrong.
|
STRING |
Manages the collaborators of the requests.
Lists the collaborators IDs.
Parameters
| Name |
Description |
Type |
|
request_id
required
|
Request ID.
|
INTEGER |
Response
Returns an array of the collaborators' IDs.
| Name |
Description |
Type |
|
id
|
Collaborator ID.
|
ARRAY |
Requests collaboration from the defined user.
Parameters
| Name |
Description |
Type |
|
users_id
|
Users IDs.
|
ARRAY |
|
user_id
|
User ID.
|
INTEGER |
|
author_id
required
|
Author ID. Must be the ID of the user that asks for collaboration.
|
INTEGER |
|
request_id
required
|
Request ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the collaboration was correctly requested; or 'ERROR' if something went wrong.
|
STRING |
Manages the replies from a given request.
Gets the replies from a given request.
Parameters
| Name |
Description |
Type |
|
date_format
|
Indicate the date format. The available formats are 'epoch' or 'iso8601'. If null, epoch format is returned.
|
STRING |
|
is_solution
|
Indicate if the comments returned are the request's solution. 1: Is solution, 0: Is not solution. If this parameter is not provided then all comments will be returned.
|
BOOLEAN |
|
decoded_special_characters
|
Indicate if the message is returned decoded. If null, coded format is returned.
|
BOOLEAN |
|
request_id
required
|
Request ID.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
is_solution
|
Indicates if this comment is the solution of the request. 1: if is the solution, 0: if not.
|
BOOLEAN |
|
incident_id
|
Request ID.
|
INTEGER |
|
attachments
|
Attachment IDs.
|
ARRAY |
|
author_id
|
Author ID.
|
INTEGER |
|
message
|
Message of the comment.
|
STRING |
|
created_at
|
Creation time in epoch or ISO-8601 format depending on the date_format parameter.
|
STRING |
|
msg_num
|
Number of the message in the request.
|
INTEGER |
|
id
|
Comment ID.
|
INTEGER |
|
customer_visible
|
Indicates if the comment is internal or not. 0: Internal, 1: Public.
|
BOOLEAN |
|
reference
|
ID of the comment that is replying to.
|
INTEGER |
Adds a reply to a request.
Parameters
| Name |
Description |
Type |
|
is_solution
|
Mark as solution. 1: Is solution, 0: Is not solution.
|
BOOLEAN |
|
is_propagation
|
Mark as propagation comment. 1: Is propagation comment, 0: Is not propagation comment.
|
BOOLEAN |
|
attachments
|
Attachments IDs.
|
ARRAY |
|
author_id
required
|
Author ID.
|
INTEGER |
|
customer_visible
|
Mark as internal. 0: Internal, 1: Public.
|
BOOLEAN |
|
request_id
required
|
Request ID.
|
INTEGER |
|
comment
required
|
Comment to be added.
|
TEXT |
Response
| Name |
Description |
Type |
|
error
|
Description of the error.
|
STRING |
|
status
|
Returns 'OK' if the comment was correctly added; or 'ERROR' if something went wrong.
|
STRING |
Manages the custom approvals.
Lists the custom approvals templates that the given request has.
Parameters
| Name |
Description |
Type |
|
date_format
|
Indicate the date format. The available formats are 'epoch' or 'iso8601'. If null, epoch format is returned.
|
STRING |
|
request_id
required
|
Request ID.
|
INTEGER |
Response
Returns an array of the approval templates that a request has, using the approval ID as key and values with the following structure:
| Name |
Description |
Type |
|
title
|
Approval title.
|
STRING |
|
id
|
Approval template ID.
|
INTEGER |
|
description_prompt
|
Template description.
|
STRING |
|
pause_sla
|
Indicates if the approval pauses the SLA. 1: Pause, 0: Do not pause.
|
BOOLEAN |
|
description_required
|
Indicates if the description is required or not. 0: Required, 1: Not required.
|
BOOLEAN |
|
created_at
|
Creation time in epoch or ISO-8601 format depending on the date_format parameter.
|
STRING |
|
expired_approved
|
Indicates the action when the approval expires. 1: Approve, 2: Reject.
|
INTEGER |
|
wf_item_id
|
ID of the phase of the associated workflow.
|
INTEGER |
|
status
|
Approval status ID. 1: Active, -1: Deleted.
|
INTEGER |
|
expired_in
|
Expiration time in seconds.
|
STRING |
|
description
|
Approval description.
|
STRING |
|
wf_process_id
|
ID of the associated workflow.
|
INTEGER |
Requests a custom approval in the given request.
Parameters
| Name |
Description |
Type |
|
approval_id
required
|
Custom approval ID.
|
INTEGER |
|
author_id
required
|
Author ID of the approval request.
|
INTEGER |
|
request_id
required
|
Request ID.
|
INTEGER |
|
description
|
Custom approval description.
|
TEXT |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the approval was correctly requested; or 'ERROR' if something went wrong.
|
STRING |
Manages the custom fields from a request.
Add values for a multiple custom field from a request. This only works for the custom field with type CI. It can only be sent one CI name at a time in the values variable. It must be the complete name of the CI and all the CIs that have that exact name will be added to the multiple custom field.
Response
| Name |
Description |
Type |
|
info
|
Deletes value in the associated custom field.
|
STRING |
|
status
|
Returns 'OK' if the values were correctly created; or 'ERROR' if something went wrong.
|
STRING |
Creates values for a custom field from a request. Different types of data can be sent in the values variable. No value (empty string) means erase value. When sending files, the name of the file has to be in the values array (including its extension), and the file(s) itself should be sent in the body of the request.
Parameters
| Name |
Description |
Type |
|
custom_field_uid
required
|
Custom field UID.
|
INTEGER |
|
author_id
required
|
Author ID.
|
INTEGER |
|
request_id
required
|
Request ID.
|
INTEGER |
|
values
required
|
Array of values. If only one is required, only the first will be processed. If you are sending files, here you should list the names (with extension) of the files.
|
ARRAY |
Response
| Name |
Description |
Type |
|
info
|
Description of the result.
|
STRING |
|
status
|
Returns 'OK' if the values were correctly created; or 'ERROR' if something went wrong.
|
STRING |
Deletes value in the associated custom field.
Parameters
| Name |
Description |
Type |
|
custom_field_uid
required
|
Custom field UID.
|
INTEGER |
|
author_id
required
|
Author ID.
|
INTEGER |
|
request_id
required
|
Request ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
info
|
Deletes value in the associated custom field.
|
STRING |
|
status
|
Returns 'OK' if the values were correctly created; or 'ERROR' if something went wrong.
|
STRING |
Manages the external entities linked to a request.
Lists all the external entities linked to a request.
Parameters
| Name |
Description |
Type |
|
request_id
required
|
Request ID.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
ext_ref_id
|
External entity reference ID.
|
INTEGER |
|
link_id
|
Relation ID.
|
INTEGER |
|
name
|
External entity name.
|
STRING |
|
ref_id
|
External entity ID.
|
INTEGER |
|
type
|
Entity type. Always 100.
|
STRING |
|
status
|
Entity status. 1: Enabled, 0: Deleted.
|
BOOLEAN |
Links a request to an external entity.
Parameters
| Name |
Description |
Type |
|
external_entity_ref_id
|
External entity reference ID.
|
STRING |
|
external_entity_id
required
|
External entity ID.
|
INTEGER |
|
request_id
required
|
Request ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
link_id
|
ID of the created relation.
|
STRING |
|
info
|
Description of the result.
|
STRING |
|
status
|
Returns 'OK' if the external entity was correctly linked; or 'ERROR' if something went wrong.
|
STRING |
Manages the requests linked to a request.
Lists all the linked requests from a given request.
Parameters
| Name |
Description |
Type |
|
request_id
required
|
Request ID.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
title
|
Related request title.
|
STRING |
|
id
|
Related request ID.
|
INTEGER |
Links a request to another request.
Parameters
| Name |
Description |
Type |
|
request_id
required
|
Request ID.
|
INTEGER |
|
request_ids
required
|
Request IDs to link.
|
ARRAY |
Response
| Name |
Description |
Type |
|
error
|
Description of the error.
|
STRING |
|
info
|
Description of the result.
|
STRING |
|
status
|
Returns 'OK' if the request was correctly linked; or 'ERROR' if something went wrong.
|
STRING |
Manages the linked assets counters.
Returns counters with the number of incidents of each status.
Parameters
| Name |
Description |
Type |
|
cis_source_id
required
|
ID of the ITAM tool integration in Service Management.
|
INTEGER |
|
from
required
|
Date timestamp from which the counters are picked.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
ci_id
|
ID of the CI.
|
INTEGER |
|
group
|
Name of the group for this CI.
|
STRING |
|
requests
|
An object that contains two arrays: one counting linked CIs by request status and the other counting linked CIs by request type (only for open requests).
|
ARRAY |
Manages the request's observers.
Lists all the IDs of the request's observers.
Parameters
| Name |
Description |
Type |
|
request_id
required
|
Request ID.
|
INTEGER |
Response
Returns an array with the IDs of the observers.
| Name |
Description |
Type |
|
user_id
|
User ID.
|
INTEGER |
Adds a user as observer.
Parameters
| Name |
Description |
Type |
|
users_id
|
Users IDs.
|
ARRAY |
|
user_id
|
User ID.
|
INTEGER |
|
author_id
required
|
Author ID.
|
INTEGER |
|
request_id
required
|
Request ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the observer was correctly added; or 'ERROR' if something went wrong.
|
STRING |
Promotes a request to a major incident.
Promotes the given request to a major incident and returns the ID of the created major incident.
Parameters
| Name |
Description |
Type |
|
confirm
|
confirm changes if needed.
|
BOOLEAN |
|
author_id
required
|
User ID.
|
INTEGER |
|
request_id
required
|
Request ID.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
success
|
Promotion Result.
|
BOOLEAN |
|
messages
|
In case of error, contains the error message.
|
ARRAY |
Manages the requests reassignations to a help desk or agent.
Reassigns a request to a help desk and/or agent.
Parameters
| Name |
Description |
Type |
|
group_id
required
|
Help desk ID.
|
INTEGER |
|
agent_id
|
Agent ID.
|
INTEGER |
|
author_id
required
|
Author ID.
|
INTEGER |
|
request_id
required
|
Request ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the help desk or group was correctly reassigned; or 'ERROR' if something went wrong.
|
STRING |
Manages the rejection of a request.
Rejects a request.
Parameters
| Name |
Description |
Type |
|
author_id
required
|
ID of the user rejecting the request.
|
INTEGER |
|
request_id
required
|
ID of the request to reject.
|
INTEGER |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the request was correctly rejected; or 'ERROR' if something went wrong.
|
STRING |
Relates a request to every CI that matches a certain keyword.
Relates a request to every CI that matches a certain keyword.
Parameters
| Name |
Description |
Type |
|
keyword
required
|
Keyword to search CIs.
|
STRING |
|
request_id
required
|
Request ID.
|
INTEGER |
|
exact_match
|
Indicates if the results must be an exact match or not.
|
BOOLEAN |
Response
| Name |
Description |
Type |
|
info
|
Description of the result.
|
STRING |
|
status
|
Returns 'OK' if the CIs were correctly related; or 'ERROR' if something went wrong.
|
STRING |
Manages a request reopening.
Reopens a request.
Parameters
| Name |
Description |
Type |
|
author_id
|
User ID who reopened the ticket.
|
INTEGER |
|
request_id
required
|
Request ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
error
|
Error code
|
STRING |
|
info
|
Description of the result
|
STRING |
|
status
|
Returns 'OK' if the request was correctly reopened; or 'ERROR' if something went wrong.
|
STRING |
Manages the acceptance of a request's solution.
Accepts the solution of a request.
Parameters
| Name |
Description |
Type |
|
id
required
|
Request ID.
|
INTEGER |
|
rating
required
|
Request rating. Rate the solution on a scale of 1-5, 1 being the lowest and 5 being the highest.
|
INTEGER |
|
comment
|
Solution comment. This parameter is required if the rating is less than 4.
|
STRING |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the solution was correctly accepted; or 'ERROR' if something went wrong.
|
STRING |
Manages the rejection of a request's solution.
Rejects the solution of a request.
Parameters
| Name |
Description |
Type |
|
id
required
|
Request ID.
|
INTEGER |
|
comment
required
|
Rejection reason.
|
STRING |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the solution was correctly rejected; or 'ERROR' if something went wrong.
|
STRING |
Manages the spontaneous approvals from a request.
Creates a spontaneous approval.
Parameters
| Name |
Description |
Type |
|
approval_user_id
required
|
User ID from the approval voter.
|
INTEGER |
|
author_id
required
|
Author ID.
|
INTEGER |
|
request_id
required
|
Request ID.
|
INTEGER |
|
description
required
|
Approval description.
|
TEXT |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the approval was correctly created; or 'ERROR' if something went wrong.
|
STRING |
Manages the tasks linked to a given request.
Retrieves the list of tasks linked to a specified request.
Parameters
| Name |
Description |
Type |
|
request_id
required
|
Request ID.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
linked_request_id
|
ID of the linked request (if any).
|
INTEGER |
|
task_id
|
Task ID.
|
INTEGER |
|
expiration_date
|
Due date of the task (timestamp).
|
INTEGER |
|
helpdesk_id
|
Assigned helpdesk ID.
|
INTEGER |
|
is_predefined
|
Indicates if it comes predefined from a workflow.
|
BOOLEAN |
|
created_at
|
Task creation date (timestamp).
|
INTEGER |
|
name
|
Task name.
|
STRING |
|
assignment_type
|
Assignment type: 1 = USER, 2 = HELPDESK.
|
INTEGER |
|
completed_at
|
Task completion date (timestamp).
|
INTEGER |
|
status
|
Task status: 0 = OPEN, 1 = FINISHED, 2 = DELETED, 3 = SKIPPED.
|
INTEGER |
|
is_required
|
Whether the task is required or not.
|
BOOLEAN |
|
description
|
Task description.
|
STRING |
|
agent_id
|
Assigned agent ID.
|
INTEGER |
|
wf_stage_id
|
ID of the workflow stage if the task is related to one.
|
STRING |
Manages the agent waiting status of the requests.
Sets the agent waiting status to the request.
Parameters
| Name |
Description |
Type |
|
request_id
required
|
Request ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
info
|
Description of the result.
|
STRING |
|
status
|
Returns 'OK' if the waiting status was correctly set; or 'ERROR' if something went wrong.
|
STRING |
Manages the customer waiting status of the requests.
Sets the waiting for customer status to the request.
Parameters
| Name |
Description |
Type |
|
request_id
required
|
Request ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
info
|
Description of the result.
|
STRING |
|
status
|
Returns 'OK' if the waiting status was correctly set; or 'ERROR' if something went wrong.
|
STRING |
Manages the waiting for date status of the requests.
Sets the waiting for date status to the request.
Parameters
| Name |
Description |
Type |
|
timestamp
required
|
Date timestamp to set.
|
STRING |
|
request_id
required
|
Request ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
info
|
Description of the result.
|
STRING |
|
status
|
Returns 'OK' if the waiting status was correctly set; or 'ERROR' if something went wrong.
|
STRING |
Manages the waiting for external entities status of the requests.
Sets the request in the waiting for external entity status. The entity should be already linked.
Parameters
| Name |
Description |
Type |
|
entity_link_id
required
|
External entity ID to link to the request status.
|
INTEGER |
|
request_id
required
|
Request ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
info
|
Description of the result.
|
STRING |
|
status
|
Returns 'OK' if the waiting status was correctly set; or 'ERROR' if something went wrong.
|
STRING |
Manages the waiting for another request status.
Sets the request in the waiting for another request status.
Parameters
| Name |
Description |
Type |
|
wait_request_id
required
|
Request ID that will be waiting for.
|
INTEGER |
|
request_id
required
|
Request ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
info
|
Description of the result.
|
STRING |
|
status
|
Returns 'OK' if the waiting status was correctly set; or 'ERROR' if something went wrong.
|
STRING |
Manages the requests.
Lists the requests.
Parameters
| Name |
Description |
Type |
|
date_format
|
Indicate the date format. The available formats are 'epoch' or 'iso8601'. If null, epoch format is returned.
|
STRING |
|
comments
|
When set to true, it includes the comments of the request.
|
BOOLEAN |
|
ids
required
|
Request IDs.
|
ARRAY |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
category_id
|
Category ID.
|
INTEGER |
|
created_at
|
Creation date in epoch or ISO-8601 format depending on the date_format parameter.
|
STRING |
|
request_customer_sentiment_initial
|
Initial customer sentiment for the request. "positive", "neutral", "negative"
|
STRING |
|
rating
|
Stars given to the solution. If there's no rating, this field won't be shown.
|
INTEGER |
|
last_update
|
Last update in epoch or ISO-8601 format depending on the date_format parameter.
|
STRING |
|
closed_reason
|
Reason of closing. 1: Solution accepted, 2: Solution expired, 3: Customer timeout, 4: Finalized workflow.
|
INTEGER |
|
user_id
|
Customer ID.
|
INTEGER |
|
request_customer_sentiment_current
|
Current customer sentiment for the request. "positive", "neutral", "negative"
|
STRING |
|
solved_at
|
Solution date in epoch or ISO-8601 format depending on the date_format parameter.
|
STRING |
|
process_id
|
Process ID of the request if it is a workflow instance.
|
INTEGER |
|
assigned_id
|
Assigned agent ID.
|
INTEGER |
|
custom_fields
|
Array with the custom fields IDs as keys and the respective values.
|
ARRAY |
|
creator_id
|
Creator ID.
|
INTEGER |
|
pretty_id
|
Request pretty ID as configured on the Service Management instance.
|
STRING |
|
date_ocurred
|
Occurrence date in epoch or ISO-8601 format depending on the date_format parameter.
|
STRING |
|
comments
|
Array with comments of the requests with the comment structure.
|
ARRAY |
|
closed_at
|
Closing date in epoch or ISO-8601 format depending on the date_format parameter.
|
STRING |
|
assigned_group_id
|
Help desk ID.
|
INTEGER |
|
id
|
Request ID.
|
INTEGER |
|
sla_incident_first_reply
|
First response SLA of the request.
|
STRING |
|
status_id
|
Status ID.
|
INTEGER |
|
source_id
|
Source ID.
|
INTEGER |
|
type_id
|
Type ID.
|
INTEGER |
|
description
|
Request description.
|
STRING |
|
attachments
|
Array with the IDs of the attachments.
|
ARRAY |
|
sla_incident_resolution
|
Resolution SLA of the request.
|
STRING |
|
priority_id
|
Priority ID.
|
INTEGER |
|
title
|
Request title.
|
STRING |
Open requests by agent.
Lists the requests from a given agent.
Parameters
| Name |
Description |
Type |
|
comments
|
When set to true, it includes the comments of the request.
|
BOOLEAN |
|
page_key
|
Hash key of the results page to retrieve. If null, the first page of results will be returned.
|
STRING |
|
limit
|
Number of items per page.
|
INTEGER |
|
username
|
Agent username.
|
STRING |
|
id
|
Agent ID.
|
INTEGER |
|
email
|
Agent email.
|
STRING |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
category_id
|
Category ID.
|
INTEGER |
|
created_at
|
Creation date in epoch.
|
STRING |
|
request_customer_sentiment_initial
|
Initial customer sentiment for the request. "positive", "neutral", "negative"
|
STRING |
|
last_update
|
Last update in epoch.
|
STRING |
|
closed_reason
|
Reason of closing. 1: Solution accepted, 2: Solution expired, 3: Customer timeout, 4: Finalized workflow.
|
INTEGER |
|
user_id
|
Customer ID.
|
INTEGER |
|
request_customer_sentiment_current
|
Current customer sentiment for the request. "positive", "neutral", "negative"
|
STRING |
|
solved_at
|
Solution date in epoch.
|
STRING |
|
process_id
|
Process ID of the request if it is a workflow instance.
|
INTEGER |
|
assigned_id
|
Assigned agent ID.
|
INTEGER |
|
custom_fields
|
Array with the custom fields IDs as keys and the respective values.
|
ARRAY |
|
creator_id
|
Creator ID.
|
INTEGER |
|
pretty_id
|
Request pretty ID as configured on the Service Management instance.
|
STRING |
|
date_ocurred
|
Occurrence date in epoch.
|
STRING |
|
comments
|
Array with comments of the requests with the comment structure.
|
ARRAY |
|
closed_at
|
Closing date in epoch.
|
STRING |
|
assigned_group_id
|
Help desk ID.
|
INTEGER |
|
id
|
Request ID.
|
INTEGER |
|
sla_incident_first_reply
|
First response SLA of the request.
|
STRING |
|
status_id
|
Status ID.
|
INTEGER |
|
source_id
|
Source ID.
|
INTEGER |
|
type_id
|
Type ID.
|
INTEGER |
|
next_page_key
|
Hash key of the next page of results. If null, the results page retrieved is the last one.
|
STRING |
|
description
|
Request description.
|
STRING |
|
attachments
|
Array with the IDs of the attachments.
|
ARRAY |
|
sla_incident_resolution
|
Resolution SLA of the request.
|
STRING |
|
priority_id
|
Priority ID.
|
INTEGER |
|
title
|
Request title.
|
STRING |
Manages requests linked to CIs.
Returns all the requests linked to a CI, considering its IDs, its groups and the ID of the integration it belongs to.
Parameters
| Name |
Description |
Type |
|
ci_ids
required
|
IDs of the CIs.
|
ARRAY |
|
cis_source_id
required
|
ID of the ITAM tool integration in Service Management.
|
INTEGER |
|
group
required
|
Name of the group the CIs belong to. Possible values are "asset", "business_application", "cloud_asset", "database". Legacy PascalCase variants (e.g. "Asset", "BusinessApplication") are also accepted.
|
STRING |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
ci_id
|
ID of the CI.
|
STRING |
|
group
|
Name of the group for this CI.
|
STRING |
|
requests
|
An object that contains two arrays, one listing linked CIs by request status and the other counting linked CIs by request type, only for open requests.
|
ARRAY |
Manages open requests by customer.
Lists the open requests from a customer.
Parameters
| Name |
Description |
Type |
|
comments
|
When set to true, it includes the comments of the request.
|
BOOLEAN |
|
page_key
|
Hash key of the results page to retrieve. If null, the first page of results will be returned.
|
STRING |
|
limit
|
Number of items per page.
|
INTEGER |
|
username
|
Customer username.
|
STRING |
|
id
|
Customer ID.
|
INTEGER |
|
email
|
Customer email.
|
STRING |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
category_id
|
Category ID.
|
INTEGER |
|
created_at
|
Creation date in epoch.
|
STRING |
|
request_customer_sentiment_initial
|
Initial customer sentiment for the request. "positive", "neutral", "negative"
|
STRING |
|
last_update
|
Last update in epoch.
|
STRING |
|
closed_reason
|
Reason of closing. 1: Solution accepted, 2: Solution expired, 3: Customer timeout, 4: Finalized workflow.
|
INTEGER |
|
user_id
|
Customer ID.
|
INTEGER |
|
request_customer_sentiment_current
|
Current customer sentiment for the request. "positive", "neutral", "negative"
|
STRING |
|
solved_at
|
Solution date in epoch.
|
STRING |
|
process_id
|
Process ID of the request if it is a workflow instance.
|
INTEGER |
|
assigned_id
|
Assigned agent ID.
|
INTEGER |
|
custom_fields
|
Array with the custom fields IDs as keys and the respective values.
|
ARRAY |
|
creator_id
|
Creator ID.
|
INTEGER |
|
pretty_id
|
Request pretty ID as configured on the Service Management instance.
|
STRING |
|
date_ocurred
|
Occurrence date in epoch.
|
STRING |
|
comments
|
Array with comments of the requests with the comment structure.
|
ARRAY |
|
closed_at
|
Closing date in epoch.
|
STRING |
|
assigned_group_id
|
Help desk ID.
|
INTEGER |
|
id
|
Request ID.
|
INTEGER |
|
sla_incident_first_reply
|
First response SLA of the request.
|
STRING |
|
status_id
|
Status ID.
|
INTEGER |
|
source_id
|
Source ID.
|
INTEGER |
|
type_id
|
Type ID.
|
INTEGER |
|
next_page_key
|
Hash key of the next page of results. If null, the results page retrieved is the last one.
|
STRING |
|
description
|
Request description.
|
STRING |
|
attachments
|
Array with the IDs of the attachments.
|
ARRAY |
|
sla_incident_resolution
|
Resolution SLA of the request.
|
STRING |
|
priority_id
|
Priority ID.
|
INTEGER |
|
title
|
Request title.
|
STRING |
Manages open requests by help desk.
Lists the open requests from a help desk.
Parameters
| Name |
Description |
Type |
|
helpdesk_ids
|
Help desks IDs.
|
ARRAY |
|
helpdesk_id
|
Help desk ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
requestIds
|
Request IDs.
|
ARRAY |
|
info
|
Description of the result.
|
STRING |
|
status
|
Returns 'OK' if the query was correctly executed; or 'ERROR' if something went wrong.
|
STRING |
Manages open requests by sentiment.
Lists the open requests from a sentiment.
Parameters
| Name |
Description |
Type |
|
sentiment_id
|
Sentiment ID. [negative|positive|neutral]
|
STRING |
|
offset
|
Skip this number of items in the response.
|
INTEGER |
|
limit
|
Number of items per page.
|
INTEGER |
|
sentiment_ids
|
Sentiments IDs.
|
ARRAY |
Response
| Name |
Description |
Type |
|
offset
|
Items skipped in the response.
|
INTEGER |
|
limit
|
Number of items per page.
|
INTEGER |
|
requestIds
|
Request IDs.
|
ARRAY |
|
info
|
Description of the result.
|
STRING |
|
status
|
Returns 'OK' if the query was correctly executed; or 'ERROR' if something went wrong.
|
STRING |
Manages the open requests by status.
Lists all open requests matching the status specified by parameter.
Parameters
| Name |
Description |
Type |
|
limit
|
Number of items per page.
|
INTEGER |
|
offset
|
Skip this number of items in the response.
|
INTEGER |
|
status_ids
|
Status IDs.
|
ARRAY |
|
status_id
|
Status ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
total
|
Total items.
|
INTEGER |
|
offset
|
Items skipped in the response.
|
INTEGER |
|
limit
|
Number of items per page.
|
INTEGER |
|
info
|
Description of the result.
|
STRING |
|
requestIds
|
Request IDs.
|
ARRAY |
|
status
|
Returns 'OK' if the query was correctly executed; or 'ERROR' if something went wrong.
|
STRING |
Manages the requests from a given view ID.
Lists the requests from a view ID.
Parameters
| Name |
Description |
Type |
|
view_id
required
|
View ID.
|
INTEGER |
|
offset
|
Skip this amount of requests in the response.
|
INTEGER |
|
limit
|
Number of items per page.
|
INTEGER |
Response
| Name |
Description |
Type |
|
offset
|
This amount of request were skipped in the response.
|
INTEGER |
|
limit
|
Number of items per page.
|
INTEGER |
|
requestIds
|
Request IDs returned by the view.
|
ARRAY |
|
info
|
Description of the result.
|
STRING |
|
status
|
Returns 'OK' if the query was correctly executed; or 'ERROR' if something went wrong.
|
STRING |
Lists the requests with their details from a view ID.
Lists the requests with their details from a view ID.
Parameters
| Name |
Description |
Type |
|
order_by
|
The order in which the results should be sorted. "asc" if the results should be sorted in ascending order, or "desc" if they should be sorted in descending order. If null, requests will be returned sorted in ascending order.
|
STRING |
|
view_id
required
|
View ID.
|
INTEGER |
|
page_key
|
Hash key of the results page to retrieve. If null, the first page of results will be returned.
|
STRING |
|
sort_by
|
Attribute upon which the sorting of the results will be performed. "id" if results should be sorted by the request ID, or "last_update" if they should be sorted by the request's last update date. If null, requests will be returned sorted by ID.
|
STRING |
Response
| Name |
Description |
Type |
|
data
|
Contains a JSON array (with pagination, 1000 requests per page) representing the primary data of the requests in the request view.
|
ARRAY |
|
metadata
|
Provides resource objects that are related to the primary data, including the labels of the columns from the view.
|
ARRAY |
|
next_page_key
|
Hash key of the next page of results. If null, the results page retrieved is the last one.
|
STRING |
Manages the requests that were created within the last hour.
Lists all the requests that were created within the last hour.
Parameters
| Name |
Description |
Type |
|
page_key
|
Hash key of the results page to retrieve. If null, the first page of results will be returned.
|
STRING |
|
limit
|
Number of items per page.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
category_id
|
Category ID.
|
INTEGER |
|
created_at
|
Creation date in epoch.
|
STRING |
|
request_customer_sentiment_initial
|
Initial customer sentiment for the request. "positive", "neutral", "negative"
|
STRING |
|
rating
|
Stars given to the solution. If there's no rating, this field won't be shown.
|
INTEGER |
|
last_update
|
Last update in epoch.
|
STRING |
|
closed_reason
|
Reason of closing. 1: Solution accepted, 2: Solution expired, 3: Customer timeout, 4: Finalized workflow.
|
INTEGER |
|
user_id
|
Customer ID.
|
INTEGER |
|
request_customer_sentiment_current
|
Current customer sentiment for the request. "positive", "neutral", "negative"
|
STRING |
|
solved_at
|
Solution date in epoch.
|
STRING |
|
process_id
|
Process ID of the request if it is a workflow instance.
|
INTEGER |
|
assigned_id
|
Assigned agent ID.
|
INTEGER |
|
custom_fields
|
Array with the custom fields IDs as keys and the respective values.
|
ARRAY |
|
creator_id
|
Creator ID.
|
INTEGER |
|
pretty_id
|
Request pretty ID as configured on the Service Management instance.
|
STRING |
|
date_ocurred
|
Occurrence date in epoch.
|
STRING |
|
comments
|
Array with comments of the requests with the comment structure.
|
ARRAY |
|
closed_at
|
Closing date in epoch.
|
STRING |
|
assigned_group_id
|
Help desk ID.
|
INTEGER |
|
id
|
Request ID.
|
INTEGER |
|
sla_incident_first_reply
|
First response SLA of the request.
|
STRING |
|
status_id
|
Status ID.
|
INTEGER |
|
source_id
|
Source ID.
|
INTEGER |
|
type_id
|
Type ID.
|
INTEGER |
|
next_page_key
|
Hash key of the next page of results. If null, the results page retrieved is the last one.
|
STRING |
|
description
|
Request description.
|
STRING |
|
attachments
|
Array with the IDs of the attachments.
|
ARRAY |
|
sla_incident_resolution
|
Resolution SLA of the request.
|
STRING |
|
priority_id
|
Priority ID.
|
INTEGER |
|
title
|
Request title.
|
STRING |
Manages internal notes.
Lists all the internal notes, or one in particular.
Parameters
| Name |
Description |
Type |
|
date_format
|
Indicate the date format. The available formats are 'epoch' or 'iso8601'. If null, epoch format is returned.
|
STRING |
|
object_id
|
Entity ID.
|
INTEGER |
|
id
required
|
Note ID.
|
INTEGER |
|
object_type
|
Entity type ID. 1: User, 2: Helpdesk, 3: Company, 4: Users Group, 5: External Entity.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
last_update
|
Last update of the note in epoch or ISO-8601 format depending on the date_format .
|
STRING |
|
object_id
|
Entity ID.
|
INTEGER |
|
title
|
Note title.
|
STRING |
|
last_author
|
Last author ID.
|
INTEGER |
|
author_id
|
Author ID.
|
INTEGER |
|
description
|
Note description.
|
STRING |
|
created_at
|
Creation date of the note in epoch or ISO-8601 format depending on the date_format parameter.
|
STRING |
|
id
|
Note ID.
|
INTEGER |
|
object_type
|
Entity type ID. 1: User, 2: Helpdesk, 3: Company, 4: Users Group, 5: External Entity.
|
INTEGER |
Creates an internal note.
Parameters
| Name |
Description |
Type |
|
object_id
required
|
Entity ID.
|
INTEGER |
|
title
required
|
Note title.
|
STRING |
|
object_type
required
|
Entity type ID. 1: User, 2: Helpdesk, 3: Company, 4: Users Group, 5: External Entity.
|
INTEGER |
|
author_id
required
|
Author ID.
|
INTEGER |
|
description
required
|
Note description.
|
STRING |
Response
| Name |
Description |
Type |
|
Status
|
Returns 'OK' if the internal note was correctly created; or 'ERROR' if something went wrong.
|
STRING |
Updates the info of an internal note.
Parameters
| Name |
Description |
Type |
|
title
|
Note title.
|
STRING |
|
id
required
|
Note ID.
|
INTEGER |
|
author_id
required
|
Author ID.
|
INTEGER |
|
description
|
Note description.
|
STRING |
Response
| Name |
Description |
Type |
|
Status
|
Returns 'OK' if the internal note was correctly updated; or 'ERROR' if something went wrong.
|
STRING |
Deletes an internal note.
Parameters
| Name |
Description |
Type |
|
id
required
|
Note ID.
|
INTEGER |
|
author_id
required
|
Author ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
Status
|
Returns 'OK' if the internal note was correctly deleted; or 'ERROR' if something went wrong.
|
STRING |
Manages articles from the Knowledge Base.
Lists all the articles with their properties.
Parameters
| Name |
Description |
Type |
|
limit
|
Number of items per page.
|
INTEGER |
|
order_by
|
Attribute upon which the sorting of the results will be performed. "last_update_date" if they should be sorted by the articles last update date. If null, articles will be returned sorted by ID
|
STRING |
|
offset
|
Skip this number of items in the response.
|
INTEGER |
|
sort_by
|
The order in which the results should be sorted. "asc" if the results should be sorted in ascending order, or "desc" if they should be sorted in descending order. If null, articles will be returned sorted in ascending order.
|
STRING |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
external_id
|
External ID of the article.
|
STRING |
|
id
|
Article ID.
|
INTEGER |
|
category_id
|
Category ID.
|
INTEGER |
|
title
|
Article title.
|
STRING |
|
content
|
Content of the article.
|
STRING |
|
last_update_date
|
Last update date in epoch.
|
STRING |
|
responsible_id
|
Responsible ID.
|
INTEGER |
|
status
|
Article status ID. 1: Published, 4: Draft, 5: Archived.
|
INTEGER |
|
creation_date
|
Creation date in epoch.
|
STRING |
|
solved_requests
|
Amount of requests that this article helped to solve.
|
INTEGER |
|
attachments
|
Array with the ID, name and URL of each attachment.
|
ARRAY |
|
rating
|
Average scoring of the article.
|
FLOAT |
|
author_id
|
Author ID.
|
INTEGER |
|
is_private
|
If the article is private or not.
|
BOOLEAN |
|
source
|
Creation origin of the article: web, manual, ai, api, initial_setup, import or external_sync. Read-only.
|
STRING |
|
views
|
Amount of views that the article has.
|
INTEGER |
Creates an article.
Parameters
| Name |
Description |
Type |
|
is_private
|
Mark as private. 1: Is private. 0: Is public.
|
BOOLEAN |
|
attachments
|
Array of attachments.
|
ARRAY |
|
author_id
required
|
Author ID.
|
INTEGER |
|
description
|
Article description.
|
STRING |
|
category_id
required
|
Category ID.
|
INTEGER |
|
title
required
|
Article title.
|
STRING |
|
content
required
|
Article content.
|
STRING |
|
external_id
|
External ID of the article. Optional; must be unique among articles.
|
STRING |
|
responsible_id
|
Article responsible. If it's null, the assigned responsible user will be the same as the author.
|
INTEGER |
|
status
|
Article status ID. 1: Published, 4: Draft. If null, the article is created as published. With KB article versioning enabled, publishing in a category whose approvers must approve the author's versions creates the article as a draft and sends its version to approval.
|
INTEGER |
Response
| Name |
Description |
Type |
|
version_status
|
Status of that version: "published", "draft", "pending_approval", "rejected" or "approved". Null when KB article versioning is disabled.
|
STRING |
|
article_id
|
Article ID.
|
INTEGER |
|
version_id
|
ID of the newest version of the article: the draft in progress if there is one, otherwise the current version. Null when KB article versioning is disabled.
|
INTEGER |
|
version
|
Number of that version (e.g. "2.0" or "1.1"). Null when KB article versioning is disabled.
|
STRING |
|
status
|
Returns 'OK' if the article was correctly created; or 'ERROR' if something went wrong.
|
STRING |
Modifies an article given a certain ID.
Parameters
| Name |
Description |
Type |
|
is_private
|
Mark as private. 1: Is private. 0: Is public. With KB article versioning enabled, if null the visibility is left unchanged.
|
BOOLEAN |
|
content
|
Article content.
|
STRING |
|
author_id
required
|
Author ID.
|
INTEGER |
|
description
|
Article description.
|
STRING |
|
category_id
|
Category ID.
|
INTEGER |
|
title
|
Article title.
|
STRING |
|
id
required
|
Article ID.
|
INTEGER |
|
external_id
|
External ID of the article. Optional; must be unique among articles. Send an empty string to clear it. If null, it is left unchanged.
|
STRING |
|
responsible_id
|
Article responsible. If it's null, the assigned responsible user will be the same as the author; with KB article versioning enabled, it is left unchanged.
|
INTEGER |
|
status
|
Article status ID. 1: Published, 4: Draft, 5: Archived. If null, the status is left unchanged. With KB article versioning enabled, content changes follow the versioned editor: without status, a published article publishes the new version, and a draft or archived article saves a draft; 4 saves the content as a draft without unpublishing the current version; 1 publishes it. Publishing in a category whose approvers must approve the author's versions sends the version to approval instead. Responds 409 if another user has the article open in the editor.
|
INTEGER |
Response
| Name |
Description |
Type |
|
version_status
|
Status of that version: "published", "draft", "pending_approval", "rejected" or "approved". Null when KB article versioning is disabled.
|
STRING |
|
version_id
|
ID of the newest version of the article: the draft in progress if there is one, otherwise the current version. Null when KB article versioning is disabled.
|
INTEGER |
|
version
|
Number of that version (e.g. "2.0" or "1.1"). Null when KB article versioning is disabled.
|
STRING |
|
status
|
Returns 'OK' if the article was correctly modified; or 'ERROR' if something went wrong.
|
STRING |
Deletes an article from a given ID.
Parameters
| Name |
Description |
Type |
|
id
required
|
Article ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the article was correctly deleted; or 'ERROR' if something went wrong.
|
STRING |
Manages the attachments from a Knowledge Base article.
Lists the attachments from an article.
Parameters
| Name |
Description |
Type |
|
article_id
required
|
Article ID.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
url
|
Attachment URL.
|
STRING |
|
name
|
Attachment Filename.
|
STRING |
|
id
|
Attachment ID.
|
INTEGER |
|
status
|
Returns 'OK' if the query was correctly executed; or 'ERROR' if something went wrong.
|
STRING |
Adds attachments to an article.
Parameters
| Name |
Description |
Type |
|
article_id
required
|
Article ID.
|
INTEGER |
|
attachments
|
Array of attachments.
|
ARRAY |
|
author_id
required
|
ID of the user in whose name the update of the article will be done.
|
INTEGER |
Response
| Name |
Description |
Type |
|
version_status
|
Status of that version: "published", "draft", "pending_approval", "rejected" or "approved". Null when KB article versioning is disabled.
|
STRING |
|
version_id
|
ID of the newest version of the article after the change. Null when KB article versioning is disabled.
|
INTEGER |
|
version
|
Number of that version (e.g. "2.0" or "1.1"). Null when KB article versioning is disabled.
|
STRING |
|
status
|
Returns 'OK' if the attachment was correctly added; or 'ERROR' if something went wrong.
|
STRING |
Deletes an attachment from an article.
Parameters
| Name |
Description |
Type |
|
article_id
required
|
Article ID.
|
INTEGER |
|
author_id
|
ID of the user in whose name the attachment is removed. With KB article versioning enabled, removing an attachment creates a new version like any content change; if null, the System user is used.
|
INTEGER |
|
attachment_id
required
|
Attachment ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
version_status
|
Status of that version: "published", "draft", "pending_approval", "rejected" or "approved". Null when KB article versioning is disabled.
|
STRING |
|
version_id
|
ID of the newest version of the article after the change. Null when KB article versioning is disabled.
|
INTEGER |
|
version
|
Number of that version (e.g. "2.0" or "1.1"). Null when KB article versioning is disabled.
|
STRING |
|
status
|
Returns 'OK' if the attachment was correctly deleted; or 'ERROR' if something went wrong.
|
STRING |
Manages Knowledge Base articles by category.
Lists all the articles that belong to a certain category.
Parameters
| Name |
Description |
Type |
|
category_id
required
|
Category ID.
|
INTEGER |
|
offset
|
Skip this number of items in the response.
|
INTEGER |
|
limit
|
Number of items per page.
|
INTEGER |
|
visibility
|
Visibility type of the articles to fetch. 1 => Private, 2 => Registered Users, 3 => Public.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
external_id
|
External ID of the article.
|
STRING |
|
id
|
Article ID.
|
INTEGER |
|
category_id
|
Category ID.
|
INTEGER |
|
title
|
Article title.
|
STRING |
|
content
|
Content of the article.
|
STRING |
|
last_update_date
|
Last update date in epoch.
|
STRING |
|
responsible_id
|
Responsible ID.
|
INTEGER |
|
status
|
Article status ID. 1: Published, 4: Draft, 5: Archived.
|
INTEGER |
|
creation_date
|
Creation date in epoch.
|
STRING |
|
solved_requests
|
Amount of requests that this article helped to solve.
|
INTEGER |
|
attachments
|
Array with the ID, name and URL of each attachment.
|
ARRAY |
|
rating
|
Average scoring of the article.
|
FLOAT |
|
author_id
|
Author ID.
|
INTEGER |
|
is_private
|
If the article is private or not.
|
BOOLEAN |
|
source
|
Creation origin of the article: web, manual, ai, api, initial_setup, import or external_sync. Read-only.
|
STRING |
|
views
|
Amount of views that the article has.
|
INTEGER |
Manages Knowledge Base articles by ID.
Lists articles by ID.
Parameters
| Name |
Description |
Type |
|
ids
required
|
Article IDs.
|
ARRAY |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
external_id
|
External ID of the article.
|
STRING |
|
id
|
Article ID.
|
INTEGER |
|
category_id
|
Category ID.
|
INTEGER |
|
title
|
Article title.
|
STRING |
|
content
|
Content of the article.
|
STRING |
|
last_update_date
|
Last update date in epoch.
|
STRING |
|
responsible_id
|
Responsible ID.
|
INTEGER |
|
status
|
Article status ID. 1: Published, 4: Draft, 5: Archived.
|
INTEGER |
|
creation_date
|
Creation date in epoch.
|
STRING |
|
solved_requests
|
Amount of requests that this article helped to solve.
|
INTEGER |
|
attachments
|
Array with the ID, name and URL of each attachment.
|
ARRAY |
|
rating
|
Average scoring of the article.
|
FLOAT |
|
author_id
|
Author ID.
|
INTEGER |
|
is_private
|
If the article is private or not.
|
BOOLEAN |
|
source
|
Creation origin of the article: web, manual, ai, api, initial_setup, import or external_sync. Read-only.
|
STRING |
|
views
|
Amount of views that the article has.
|
INTEGER |
Manages Knowledge Base articles by keywords.
Searches for articles by keywords.
Parameters
| Name |
Description |
Type |
|
min_search_scoring
|
Minimum search scoring from 0 to 1, which measures the accuracy of the search results.
|
FLOAT |
|
keywords
required
|
Keywords to search.
|
STRING |
|
limit
|
Number of results, 25 by default.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
external_id
|
External ID of the article.
|
STRING |
|
search_scoring
|
Score from 0 to 1 that measures the accuracy of the search result.
|
FLOAT |
|
id
|
Article ID.
|
INTEGER |
|
category_id
|
Category ID.
|
INTEGER |
|
title
|
Article title.
|
STRING |
|
content
|
Content of the article.
|
STRING |
|
last_update_date
|
Last update date in epoch.
|
STRING |
|
responsible_id
|
Responsible ID.
|
INTEGER |
|
status
|
Article status ID. 1: Published, 4: Draft, 5: Archived.
|
INTEGER |
|
creation_date
|
Creation date in epoch.
|
STRING |
|
solved_requests
|
Amount of requests that this article helped to solve.
|
INTEGER |
|
attachments
|
Array with the ID, name and URL of each attachment.
|
ARRAY |
|
rating
|
Average scoring of the article.
|
FLOAT |
|
author_id
|
Author ID.
|
INTEGER |
|
is_private
|
If the article is private or not.
|
BOOLEAN |
|
source
|
Creation origin of the article: web, manual, ai, api, initial_setup, import or external_sync. Read-only.
|
STRING |
|
views
|
Amount of views that the article has.
|
INTEGER |
Manages Knowledge Base categories.
Lists all the Knowledge Base categories.
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
parent_id
|
Category parent ID.
|
INTEGER |
|
name
|
Category name.
|
STRING |
|
id
|
Category ID.
|
INTEGER |
Creates a new Knowledge Base category.
Parameters
| Name |
Description |
Type |
|
parent_id
|
Category Parent ID.
|
INTEGER |
|
name
required
|
Category name.
|
STRING |
Response
| Name |
Description |
Type |
|
category_id
|
Category ID.
|
STRING |
|
status
|
Returns 'OK' if the category was correctly created; or 'ERROR' if something went wrong.
|
STRING |
Modifies a Knowledge Base category.
Parameters
| Name |
Description |
Type |
|
parent_id
|
Category parent ID.
|
INTEGER |
|
name
|
Category name.
|
STRING |
|
id
required
|
Category ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the category was correctly modified; or 'ERROR' if something went wrong.
|
STRING |
Deletes a Knowledge Base category.
Parameters
| Name |
Description |
Type |
|
id
required
|
Category ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the category was correctly deleted; or 'ERROR' if something went wrong.
|
STRING |
Manages Knowledge Base categories by IDs.
Lists Knowledge Base categories by some given IDs.
Parameters
| Name |
Description |
Type |
|
ids
required
|
Category IDs.
|
ARRAY |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
parent_id
|
Category parent ID.
|
INTEGER |
|
name
|
Category name.
|
STRING |
|
id
|
Category ID.
|
INTEGER |
Retrieves help desks' levels.
Returns all active help desks' levels, or one in particular.
Parameters
| Name |
Description |
Type |
|
id
|
Level ID.
|
INTEGER |
|
include_deleted
|
Set it to 'false' to exclude deleted levels. By default, it will retrieve deleted levels.
|
BOOLEAN |
Response
Returns an array of objects or one object with the following structure:
| Name |
Description |
Type |
|
members_ids
|
List of members IDs that the level has.
|
ARRAY |
|
total_members
|
Total amount of members that the level has.
|
INTEGER |
|
level_order
|
Level order.
|
INTEGER |
|
id
|
Level ID.
|
INTEGER |
|
engine_id
|
Engine ID. 1: Round robin, 2: By load, 3: Free, 4: Manual.
|
INTEGER |
|
status_id
|
Status ID. 1: Enabled, 2: Suspend, 3: Out time work, 4: Disabled.
|
INTEGER |
Manages help desk levels observers.
Returns all active help desk levels and their observers,
or the observers for the specified help desk levels.
Parameters
| Name |
Description |
Type |
|
ids
|
Level IDs.
|
ARRAY |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
observer_groups
|
The groups’ IDs that are observers of the entity.
|
ARRAY |
|
name
|
Level name.
|
STRING |
|
id
|
Level ID.
|
INTEGER |
|
observer_users
|
The observers’ users IDs.
|
ARRAY |
Add users as observers to a help desk level.
Parameters
| Name |
Description |
Type |
|
observer_users
required
|
Users IDs to be added as observers.
|
ARRAY |
|
id
required
|
Level ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
value
|
Returns 'true' if the users were correctly added as observers to the help desk level.
Returns 'false' if, for any reason, they weren't added to the help desk level,
or if the users were already observers of the help desk level.
|
BOOLEAN |
|
id
|
User ID.
|
INTEGER |
Removes observers from a help desk level.
Parameters
| Name |
Description |
Type |
|
observer_users
required
|
Users IDs to be removed as observers.
|
ARRAY |
|
id
required
|
Level ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
value
|
Returns 'true' if the users were correctly removed as observers from the help desk level.
Returns 'false' if, for any reason, they weren't removed from the help desk level,
or if the users weren't observers of the help desk level.
|
BOOLEAN |
|
id
|
User ID.
|
INTEGER |
Manages locations.
Returns all active locations, or one in particular.
Parameters
| Name |
Description |
Type |
|
id
|
Location ID.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
total
|
Number of users with this location.
|
INTEGER |
|
parent_id
|
Parent location ID.
|
INTEGER |
|
name
|
Location name.
|
STRING |
|
id
|
Location ID.
|
INTEGER |
Creates a location.
Parameters
| Name |
Description |
Type |
|
parent_id
|
Parent location ID.
|
INTEGER |
|
name
required
|
Location name.
|
STRING |
Response
| Name |
Description |
Type |
|
id
|
Location ID.
|
INTEGER |
Erases an existing location and its sublocations.
Parameters
| Name |
Description |
Type |
|
id
required
|
Location ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the location was correctly deleted; or 'ERROR' if something went wrong.
|
STRING |
Manages locations observers.
Returns all active locations and their observers,
or the observers for the specified locations.
Parameters
| Name |
Description |
Type |
|
ids
|
Location IDs.
|
ARRAY |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
observer_groups
|
The groups’ IDs that are observers of the entity.
|
ARRAY |
|
name
|
Location name.
|
STRING |
|
id
|
Location ID.
|
INTEGER |
|
observer_users
|
The observers’ users IDs.
|
ARRAY |
Add users as observers to a location.
Parameters
| Name |
Description |
Type |
|
observer_users
required
|
Users IDs to be added as observers.
|
ARRAY |
|
id
required
|
Location ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
value
|
Returns 'true' if the users were correctly added as observers to the location.
Returns 'false' if, for any reason, they weren't added to the location,
or if the users were already observers of the location.
|
BOOLEAN |
|
id
|
User ID.
|
INTEGER |
Removes observers from a location.
Parameters
| Name |
Description |
Type |
|
observer_users
required
|
Users IDs to be removed as observers.
|
ARRAY |
|
id
required
|
Location ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
value
|
Returns 'true' if the users were correctly removed as observers from the location.
Returns 'false' if, for any reason, they weren't removed from the location,
or if the users weren't observers of the location.
|
BOOLEAN |
|
id
|
User ID.
|
INTEGER |
Manages the relationships between users and locations.
Lists the members of a location.
Parameters
| Name |
Description |
Type |
|
user_id
|
User ID
|
INTEGER |
|
id
required
|
Location ID.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
name
|
User full name.
|
STRING |
|
id
|
User ID.
|
INTEGER |
|
username
|
Username.
|
STRING |
|
email
|
User email.
|
STRING |
Adds users to a location.
Parameters
| Name |
Description |
Type |
|
id
required
|
Location ID.
|
INTEGER |
|
users
required
|
Users IDs linked to the location.
|
ARRAY |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
value
|
Returns 'true' if the user was correctly associated with the location or 'false' if it wasn't.
|
BOOLEAN |
|
id
|
Location ID.
|
INTEGER |
Removes users from a location.
Parameters
| Name |
Description |
Type |
|
id
required
|
Location ID.
|
INTEGER |
|
users
required
|
Users IDs to be removed from the location.
|
ARRAY |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
value
|
Returns 'true' if the user was correctly removed from the location or 'false' if it wasn't.
|
BOOLEAN |
|
id
|
Location ID.
|
INTEGER |
Returns the current version of the InvGate Service Management instance.
Returns the current version of the InvGate Service Management instance.
Response
Returns a string with the current version of InvGate Service Management.
| Name |
Description |
Type |
|
version
|
InvGate Service Management version.
|
STRING |
Retrieves time tracking records.
Lists all the available time tracking records within a specific time interval or a request ID.
Parameters
| Name |
Description |
Type |
|
date_format
|
Indicate the date format. The available formats are 'iso8601noT' or 'iso8601'. If null, 'iso8601noT' format is returned, which is ISO-8601 no T (YYYY-mm-dd H:i).
|
STRING |
|
from
|
Initial date and time of the interval (must be in ISO-8601 format). Required if the request_id parameter is not provided.
|
STRING |
|
to
|
Ending date and time of the interval (must be in ISO-8601 format). If it's not specified, the current time will be used.
|
STRING |
|
request_id
|
Request ID. Required if the from parameter is not provided.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
total
|
Total amount of time in seconds.
|
STRING |
|
incident
|
Request ID.
|
INTEGER |
|
from
|
Initial date and time of the interval (in ISO 8601 format).
|
STRING |
|
timetracking_category_id
|
Time tracking category ID.
|
INTEGER |
|
to
|
Ending date and time of the interval (in ISO 8601 format).
|
STRING |
|
timetracking_id
|
Time tracking entry ID.
|
INTEGER |
|
comment
|
Comment of the logged period.
|
STRING |
|
user_id
|
Author ID.
|
INTEGER |
|
status
|
Time tracking entry status. 1: Enabled, 0: Deleted.
|
INTEGER |
Logs the indicated time within a request.
Parameters
| Name |
Description |
Type |
|
from
|
Initial date and time of the interval (timestamp format). If it's not specified, the current time will be used.
|
INTEGER |
|
to
required
|
Ending date and time of the interval (timestamp format).
|
INTEGER |
|
category_id
|
Time tracking category ID.
|
INTEGER |
|
user_id
required
|
Author ID.
|
INTEGER |
|
comment
|
Add a comment for the logged time.
|
STRING |
|
request_id
required
|
Request ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
timetracking_id
|
The ID of the created time tracking entry.
|
INTEGER |
|
status
|
Returns 'OK' if the time tracking entry was correctly created; or 'ERROR' if something went wrong.
|
STRING |
Deletes a time log entry from a request.
Parameters
| Name |
Description |
Type |
|
timetracking_id
required
|
Time tracking entry ID
|
INTEGER |
|
user_id
required
|
Author ID.
|
INTEGER |
|
request_id
required
|
Request ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the time tracking entry was correctly deleted; or 'ERROR' if something went wrong.
|
STRING |
Lists all the time tracking categories, or the required one if an ID is provided.
Parameters
| Name |
Description |
Type |
|
id
|
Time tracking category ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
parent_id
|
Time tracking parent category ID
|
INTEGER |
|
name
|
Time tracking category name.
|
STRING |
|
id
|
Time tracking category ID.
|
INTEGER |
|
cost_per_hour
|
Cost of a working hour under the category.
|
FLOAT |
Gets user defined triggers.
If no ID is specified, it returns a list with all the user defined triggers. Otherwise, it returns the trigger matching the specific trigger ID (if it exists).
Parameters
| Name |
Description |
Type |
|
trigger_id
|
Trigger ID.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
trigger_name
|
Trigger name.
|
STRING |
|
id
|
Trigger ID.
|
INTEGER |
Gets a list of user defined triggers that were executed in the last hour.
Returns a list detailing each time that a specific trigger was executed in the last hour. If no trigger ID is provided, it returns all the times that user defined triggers were executed in the last hour.
Parameters
| Name |
Description |
Type |
|
trigger_id
|
Trigger ID.
|
INTEGER |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
trigger_id
|
Trigger ID.
|
INTEGER |
|
id
|
Execution ID.
|
INTEGER |
|
request_id
|
ID of the affected request.
|
INTEGER |
|
executed_at
|
Execution timestamp.
|
INTEGER |
Manages users.
Returns the info of a user.
Parameters
| Name |
Description |
Type |
|
id
required
|
User ID.
|
INTEGER |
|
include_disabled
|
Indicate if disabled users should be included. True if they should be included and false if not. If this parameter is not provided then disabled users won't be returned.
|
BOOLEAN |
Response
| Name |
Description |
Type |
|
role_name
|
User’s role.
|
STRING |
|
lastname
|
User lastname.
|
STRING |
|
id
|
User ID.
|
INTEGER |
|
user_type
|
User’s type. Returns 1 if the user is an agent and 2 if it is an end user.
|
INTEGER |
|
address
|
User home address.
|
STRING |
|
office
|
User office phone number.
|
STRING |
|
phone
|
User phone number.
|
STRING |
|
department
|
User department.
|
STRING |
|
doc
|
User national ID number.
|
STRING |
|
is_disabled
|
Returns 'true' if the user has been disabled.
|
BOOLEAN |
|
location
|
User localization.
|
STRING |
|
birthday
|
User birthday.
|
STRING |
|
other_email
|
User secondary email address.
|
STRING |
|
country
|
User country.
|
STRING |
|
username
|
Username.
|
STRING |
|
is_deleted
|
Returns 'true' if the user has been deleted.
|
BOOLEAN |
|
name
|
User name.
|
STRING |
|
city
|
User city.
|
STRING |
|
fax
|
User fax number.
|
STRING |
|
email
|
User email address.
|
STRING |
|
is_external
|
Returns 'true' if the user is external.
|
BOOLEAN |
|
mobile
|
User mobile phone number.
|
STRING |
|
manager_id
|
User's manager ID.
|
INTEGER |
|
employee_number
|
User's employee number.
|
STRING |
|
position
|
User position.
|
STRING |
|
other
|
User secondary phone number.
|
STRING |
|
type
|
User type: 1: System, 2: LDAP, 3: Webservice, 4: Customer, 5: Mailbox.
|
INTEGER |
Creates a new user.
Parameters
| Name |
Description |
Type |
|
lastname
required
|
User lastname.
|
STRING |
|
office
|
User office phone number.
|
STRING |
|
pass
|
User password.
|
STRING |
|
other-email
|
User secondary email address.
|
STRING |
|
phone
|
User phone number.
|
STRING |
|
doc
|
User national ID number.
|
STRING |
|
force_password_change
|
If true, the user will be forced to change their password on the next login.
|
BOOLEAN |
|
address
|
User home address.
|
STRING |
|
send_set_password_email
|
If true, the user will receive an email with a link to set their password.
|
BOOLEAN |
|
username
|
Username.
|
STRING |
|
country
|
User country.
|
STRING |
|
employee_number
|
User employee number.
|
STRING |
|
name
required
|
User name.
|
STRING |
|
city
|
User city.
|
STRING |
|
department
|
User department.
|
STRING |
|
email
required
|
User email address.
|
STRING |
|
is_external
|
An external user can't login to the system and can only interact with it via email.
|
BOOLEAN |
|
mobile
|
User mobile phone number.
|
STRING |
|
manager_id
|
User's manager ID.
|
INTEGER |
|
fax
|
User fax number.
|
STRING |
|
position
|
User position.
|
STRING |
|
other
|
User secondary phone number.
|
STRING |
|
localization
|
Localization of the user.
|
STRING |
|
birthday
|
Birthday of the user.
|
STRING |
Response
| Name |
Description |
Type |
|
role_name
|
User’s role.
|
STRING |
|
lastname
|
User lastname.
|
STRING |
|
id
|
User ID.
|
INTEGER |
|
user_type
|
User’s type. Returns 1 if the user is an agent and 2 if it is an end user.
|
INTEGER |
|
address
|
User home address.
|
STRING |
|
office
|
User office phone number.
|
STRING |
|
phone
|
User phone number.
|
STRING |
|
department
|
User department.
|
STRING |
|
doc
|
User national ID number.
|
STRING |
|
is_disabled
|
Returns 'true' if the user has been disabled.
|
BOOLEAN |
|
location
|
User localization.
|
STRING |
|
birthday
|
User birthday.
|
STRING |
|
other_email
|
User secondary email address.
|
STRING |
|
country
|
User country.
|
STRING |
|
username
|
Username.
|
STRING |
|
is_deleted
|
Returns 'true' if the user has been deleted.
|
BOOLEAN |
|
name
|
User name.
|
STRING |
|
city
|
User city.
|
STRING |
|
fax
|
User fax number.
|
STRING |
|
email
|
User email address.
|
STRING |
|
is_external
|
Returns 'true' if the user is external.
|
BOOLEAN |
|
mobile
|
User mobile phone number.
|
STRING |
|
manager_id
|
User's manager ID.
|
INTEGER |
|
employee_number
|
User's employee number.
|
STRING |
|
position
|
User position.
|
STRING |
|
other
|
User secondary phone number.
|
STRING |
|
type
|
User type: 1: System, 2: LDAP, 3: Webservice, 4: Customer, 5: Mailbox.
|
INTEGER |
Updates the info of a user.
Parameters
| Name |
Description |
Type |
|
lastname
|
User lastname.
|
STRING |
|
id
required
|
User ID.
|
INTEGER |
|
address
|
User home address.
|
STRING |
|
other-email
|
User secondary email address.
|
STRING |
|
phone
|
User phone number.
|
STRING |
|
department
|
User department.
|
STRING |
|
doc
|
User national ID number.
|
STRING |
|
office
|
User office phone number.
|
STRING |
|
birthday
|
User birthday.
|
STRING |
|
country
|
User country.
|
STRING |
|
username
|
Username.
|
STRING |
|
employee_number
|
User employee number.
|
STRING |
|
name
|
User name.
|
STRING |
|
city
|
User city.
|
STRING |
|
fax
|
User fax number.
|
STRING |
|
email
|
User email address.
|
STRING |
|
language
|
User language. es: Español, en: English (US), en_GB: English (UK), pt: Português (Brasil), pt_PT: Português (Portugal), fr: Français, de: Deutsch, ca: Català, it: Italiano, nl: Nederlands, el: Ελληνικά.
|
STRING |
|
mobile
|
User mobile phone number.
|
STRING |
|
manager_id
|
User's manager ID.
|
INTEGER |
|
position
|
User position.
|
STRING |
|
other
|
User secondary phone number.
|
STRING |
|
localization
|
Localization of the user.
|
STRING |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the user was correctly updated; or 'ERROR' if something went wrong.
|
STRING |
Deletes a user.
Parameters
| Name |
Description |
Type |
|
id
required
|
User ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the user was correctly deleted; or 'ERROR' if something went wrong.
|
STRING |
Fetches users by username or email.
Retrieves the user matching the username or email and displays some basic information about the user. At least one of the input parameters is required.
Parameters
| Name |
Description |
Type |
|
username
|
Username.
|
STRING |
|
email
|
User email address.
|
STRING |
Response
| Name |
Description |
Type |
|
role_name
|
User’s role.
|
STRING |
|
lastname
|
User lastname.
|
STRING |
|
id
|
User ID.
|
INTEGER |
|
user_type
|
User’s type. Returns 1 if the user is an agent and 2 if it is an end user.
|
INTEGER |
|
address
|
User home address.
|
STRING |
|
office
|
User office phone number.
|
STRING |
|
phone
|
User phone number.
|
STRING |
|
department
|
User department.
|
STRING |
|
doc
|
User national ID number.
|
STRING |
|
is_disabled
|
Returns 'true' if the user has been disabled.
|
BOOLEAN |
|
location
|
User localization.
|
STRING |
|
birthday
|
User birthday.
|
STRING |
|
other_email
|
User secondary email address.
|
STRING |
|
country
|
User country.
|
STRING |
|
username
|
Username.
|
STRING |
|
is_deleted
|
Returns 'true' if the user has been deleted.
|
BOOLEAN |
|
name
|
User name.
|
STRING |
|
city
|
User city.
|
STRING |
|
fax
|
User fax number.
|
STRING |
|
email
|
User email address.
|
STRING |
|
is_external
|
Returns 'true' if the user is external.
|
BOOLEAN |
|
mobile
|
User mobile phone number.
|
STRING |
|
manager_id
|
User's manager ID.
|
INTEGER |
|
employee_number
|
User's employee number.
|
STRING |
|
position
|
User position.
|
STRING |
|
other
|
User secondary phone number.
|
STRING |
|
type
|
User type: 1: System, 2: LDAP, 3: Webservice, 4: Customer, 5: Mailbox.
|
INTEGER |
Changes the user type by converting it from external into internal user.
Changes the user from external into internal and sends an email to the user requesting a new password.
Parameters
| Name |
Description |
Type |
|
id
required
|
User ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the user was successfully converted from external into internal; or 'ERROR' if something went wrong.
|
STRING |
Disables a user.
Disables a user.
Parameters
| Name |
Description |
Type |
|
id
required
|
User ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the user was successfully disabled; or 'ERROR' if something went wrong.
|
STRING |
Enables a user.
Enables a user.
Parameters
| Name |
Description |
Type |
|
id
required
|
User ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the user was successfully enabled; or 'ERROR' if something went wrong.
|
STRING |
Changes the password of a user.
Changes the password of a user.
Parameters
| Name |
Description |
Type |
|
force_password_change
|
If true, the user will be forced to change their password on the next login.
|
BOOLEAN |
|
id
required
|
User ID.
|
INTEGER |
|
password
required
|
New password.
|
STRING |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the password has been successfully changed; or 'ERROR' if something went wrong.
|
STRING |
Resets the user's password and sends an action required email to the user.
Sends an email to the user requesting a new password.
Parameters
| Name |
Description |
Type |
|
id
required
|
User ID.
|
INTEGER |
|
type
required
|
Either 'NEW_USER' for new users or 'RESET_PASSWORD' for existing ones.
|
STRING |
Response
| Name |
Description |
Type |
|
status
|
Returns 'OK' if the password has been successfully reset; or 'ERROR' if something went wrong.
|
STRING |
Creates a session token for a user.
Creates a new session token for the user that matches the input ID.
Parameters
| Name |
Description |
Type |
|
id
required
|
User ID.
|
INTEGER |
Response
| Name |
Description |
Type |
|
token
|
The new token ID.
|
STRING |
Fetches users and allows filtering by IDs.
Retrieves users and displays some basic information about them. It's possible to specify an array of user IDs in order to filter specific users; otherwise, it retrieves all users.
Parameters
| Name |
Description |
Type |
|
include_disabled
|
True if disabled users should be included.
|
BOOLEAN |
|
ids
|
Users IDs.
|
ARRAY |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
role_name
|
User’s role.
|
STRING |
|
lastname
|
User lastname.
|
STRING |
|
id
|
User ID.
|
INTEGER |
|
user_type
|
User’s type. Returns 1 if the user is an agent and 2 if it is an end user.
|
INTEGER |
|
address
|
User home address.
|
STRING |
|
office
|
User office phone number.
|
STRING |
|
phone
|
User phone number.
|
STRING |
|
department
|
User department.
|
STRING |
|
doc
|
User national ID number.
|
STRING |
|
is_disabled
|
Returns 'true' if the user has been disabled.
|
BOOLEAN |
|
location
|
User localization.
|
STRING |
|
birthday
|
User birthday.
|
STRING |
|
other_email
|
User secondary email address.
|
STRING |
|
country
|
User country.
|
STRING |
|
username
|
Username.
|
STRING |
|
is_deleted
|
Returns 'true' if the user has been deleted.
|
BOOLEAN |
|
name
|
User name.
|
STRING |
|
city
|
User city.
|
STRING |
|
fax
|
User fax number.
|
STRING |
|
email
|
User email address.
|
STRING |
|
is_external
|
Returns 'true' if the user is external.
|
BOOLEAN |
|
mobile
|
User mobile phone number.
|
STRING |
|
manager_id
|
User's manager ID.
|
INTEGER |
|
employee_number
|
User's employee number.
|
STRING |
|
position
|
User position.
|
STRING |
|
other
|
User secondary phone number.
|
STRING |
|
type
|
User type: 1: System, 2: LDAP, 3: Webservice, 4: Customer, 5: Mailbox.
|
INTEGER |
Fetches users by username, email or any phone numbers.
Retrieves users matching username, email or any of their phone numbers and displays basic information about them.
Parameters
| Name |
Description |
Type |
|
phone
|
User phone number.
|
STRING |
|
page_key
|
Hash key of the results page to retrieve. If null, the first page of results will be returned. Ignored when page or page_size is sent (offset pagination).
|
STRING |
|
username
|
Username.
|
STRING |
|
fax_phone
|
User fax number.
|
STRING |
|
office_phone
|
User office phone number.
|
STRING |
|
email
|
User email address.
|
STRING |
|
mobile_phone
|
User mobile phone number.
|
STRING |
|
include_disabled
|
Indicate if disabled users should be included. True if they should be included and false if not. If this parameter is not provided then disabled users won't be returned.
|
BOOLEAN |
|
other_phone
|
User secondary phone number.
|
STRING |
|
phones
|
User phone number of any kind (main phone number, fax number, office phone number, mobile phone number or other phone number).
|
STRING |
|
exact_match
|
Indicate if the search should return results if (and only if) there are users with an identical value to the parameter. True if the match is exact. If this parameter is not provided then the search will return any users where the search term is contained in the parameter.
|
BOOLEAN |
|
employee_number
|
User employee number.
|
STRING |
Response
Returns an array of objects (with pagination, 10 objects per page) with the following structure:
| Name |
Description |
Type |
|
role_name
|
User’s role.
|
STRING |
|
lastname
|
User lastname.
|
STRING |
|
id
|
User ID.
|
INTEGER |
|
user_type
|
User’s type. Returns 1 if the user is an agent and 2 if it is an end user.
|
INTEGER |
|
address
|
User home address.
|
STRING |
|
office
|
User office phone number.
|
STRING |
|
phone
|
User phone number.
|
STRING |
|
department
|
User department.
|
STRING |
|
doc
|
User national ID number.
|
STRING |
|
is_disabled
|
Returns 'true' if the user has been disabled.
|
BOOLEAN |
|
location
|
User localization.
|
STRING |
|
next_page_key
|
Hash key of the next page of results. If null, the results page retrieved is the last one.
|
STRING |
|
birthday
|
User birthday.
|
STRING |
|
other_email
|
User secondary email address.
|
STRING |
|
country
|
User country.
|
STRING |
|
username
|
Username.
|
STRING |
|
is_deleted
|
Returns 'true' if the user has been deleted.
|
BOOLEAN |
|
name
|
User name.
|
STRING |
|
city
|
User city.
|
STRING |
|
fax
|
User fax number.
|
STRING |
|
email
|
User email address.
|
STRING |
|
is_external
|
Returns 'true' if the user is external.
|
BOOLEAN |
|
mobile
|
User mobile phone number.
|
STRING |
|
manager_id
|
User's manager ID.
|
INTEGER |
|
employee_number
|
User's employee number.
|
STRING |
|
position
|
User position.
|
STRING |
|
other
|
User secondary phone number.
|
STRING |
|
type
|
User type: 1: System, 2: LDAP, 3: Webservice, 4: Customer, 5: Mailbox.
|
INTEGER |
Retrieves user's groups, companies, helpdesks and locations.
Returns the user's groups, companies, helpdesks and locations.
Parameters
| Name |
Description |
Type |
|
ids
required
|
Users IDs.
|
ARRAY |
Response
Returns an array of objects with the following structure:
| Name |
Description |
Type |
|
helpdesks_observed
|
Array with the user observed helpdesks.
|
ARRAY |
|
companies_observed
|
Array with the user observed companies.
|
ARRAY |
|
locations
|
Array with the user locations.
|
ARRAY |
|
companies
|
Array with the user companies.
|
ARRAY |
|
username
|
Username.
|
STRING |
|
helpdesks
|
Array with the user helpdesks/levels.
|
ARRAY |
|
email
|
User email address.
|
STRING |
|
id
|
User ID.
|
INTEGER |
|
locations_observed
|
Array with the user observed locations.
|
ARRAY |
|
groups
|
Array with the user groups.
|
ARRAY |
|
groups_observed
|
Array with the user observed groups.
|
ARRAY |
Deploys a workflow.
Deploys the last version of the workflow.
Parameters
| Name |
Description |
Type |
|
workflow_id
required
|
ID of the workflow to be deployed.
|
INTEGER |
Response
| Name |
Description |
Type |
|
workflow_id
|
ID of the deployed workflow.
|
INTEGER |
|
description
|
Confirmation message.
|
INTEGER |
|
status
|
Returns 'OK' if the workflow was correctly deployed; or 'ERROR' if something went wrong.
|
STRING |
Lists the initial fields needed to create a request from a workflow.
Lists the initial fields needed to create a request from a workflow.
Parameters
| Name |
Description |
Type |
|
category_id
required
|
ID of the category related to a workflow.
|
INTEGER |
Response
| Name |
Description |
Type |
|
category_id
|
ID of the category related to a workflow.
|
INTEGER |
|
associated_workflow_name
|
Name of the associated workflow.
|
STRING |
|
associated_workflow_id
|
ID of the associated workflow.
|
INTEGER |
|
workflow_initial_fields
|
ARRAY with all the properties each field has.
|
ARRAY |
Gets the information of a workflow request.
Returns the general information of a workflow request, the steps it went through with the values loaded in their fields, and the current value of every workflow variable. Steps the workflow has not reached yet are not returned.
Parameters
| Name |
Description |
Type |
|
id
required
|
Request ID.
|
INTEGER |
|
all_executions
|
When set to true, every execution of each step is returned. By default only the last execution of each step is returned.
|
BOOLEAN |
|
date_format
|
Indicate the date format. The available formats are 'epoch' or 'iso8601'. If null, epoch format is returned.
|
STRING |
|
variable_id
|
ID of a workflow variable. When set, only that variable is returned, along with the steps that reference it.
|
STRING |
|
step_id
|
ID of a step in the workflow definition. When set, only that step is returned, along with the variables it references.
|
STRING |
|
language
|
Language used to translate the labels of the workflow fields. If null, the language configured on the instance is used.
|
STRING |
Response
Returns an object with the following structure:
| Name |
Description |
Type |
|
created_at
|
Creation date as an epoch number, or as an ISO-8601 string when the date_format parameter asks for it.
|
INTEGER |
|
description
|
Request description. On workflow requests this is the description configured in the workflow, not a value loaded by the customer: those are in the fields of the steps.
|
STRING |
|
steps
|
Array with the steps the request went through, in chronological order. Each step has id (the step ID in the workflow definition), name, type, state ("completed" or "current"), parent_step_id (only for steps inside a building block), occurrences (how many times the workflow went through the step) and executions. Each execution has occurrence, state, started_at, completed_at, completed_by (the ID of the user that completed the execution, which on automatic steps is the System user, and null while the execution is not completed), assigned_id, assigned_group_id and fields. Each field has id (the ID of the field in this step), variable_id, field_id (the custom field ID), label, type, value and value_label.
|
ARRAY |
|
source_id
|
Source ID.
|
INTEGER |
|
last_update
|
Last update as an epoch number, or as an ISO-8601 string when the date_format parameter asks for it.
|
INTEGER |
|
closed_reason
|
Reason of closing. 1: Solution accepted, 2: Solution expired, 3: Customer timeout, 4: Finalized workflow.
|
INTEGER |
|
user_id
|
Customer ID.
|
INTEGER |
|
current_variables_values
|
Array with the current value of every workflow variable. Each variable has id, name, name_source ("alias", "fixed_label", "field_label" or "id", telling how the name was resolved), type, field_id, value and value_label.
|
ARRAY |
|
solved_at
|
Solution date as an epoch number, or as an ISO-8601 string when the date_format parameter asks for it.
|
INTEGER |
|
assigned_id
|
Assigned agent ID.
|
INTEGER |
|
workflow
|
Object with the workflow of the request: workflow_id (stable ID of the workflow across versions), process_id (ID of the deployed version running this request), name, description, state ("running", "finalized", "rejected" or "cancelled"), current_step_id, current_step_name, started_at and finished_at.
|
ARRAY |
|
creator_id
|
Creator ID.
|
INTEGER |
|
pretty_id
|
Request pretty ID as configured on the Service Management instance.
|
STRING |
|
date_ocurred
|
Occurrence date as an epoch number, or as an ISO-8601 string when the date_format parameter asks for it.
|
INTEGER |
|
closed_at
|
Closing date as an epoch number, or as an ISO-8601 string when the date_format parameter asks for it.
|
INTEGER |
|
assigned_group_id
|
Help desk ID.
|
INTEGER |
|
location_id
|
Location ID.
|
INTEGER |
|
id
|
Request ID.
|
INTEGER |
|
status_id
|
Status ID.
|
INTEGER |
|
category_id
|
Category ID.
|
INTEGER |
|
type_id
|
Type ID.
|
INTEGER |
|
title
|
Request title.
|
STRING |
|
priority_id
|
Priority ID.
|
INTEGER |
Manages values in a workflow instance field of type list.
Retrieves current values from a workflow instance field of type list.
Parameters
| Name |
Description |
Type |
|
field_id
required
|
ID of the variable visible in the workflows variable panel.
|
STRING |
|
request_id
required
|
ID of the workflow instance.
|
INTEGER |
Response
| Name |
Description |
Type |
|
values
|
Current values of the field.
|
ARRAY |
|
field_id
|
The ID of the instance field.
|
STRING |
|
request_id
|
ID of the workflow instance.
|
INTEGER |
|
status
|
Returns "OK" if the operation was successful; or "ERROR" if something went wrong.
|
STRING |
Adds or sets values in a workflow instance field of type list. Use operation "add" to append values (default) or "set" to replace all values.
Parameters
| Name |
Description |
Type |
|
value
|
Single value to add or set. Use this OR values parameter.
|
STRING |
|
field_id
required
|
ID of the variable visible in the workflows variable panel.
|
STRING |
|
author_id
|
User ID for logging purposes. Defaults to system user if not provided.
|
INTEGER |
|
values
|
Array of values to add or set. Use this OR value parameter.
|
ARRAY |
|
request_id
required
|
ID of the workflow instance to update.
|
INTEGER |
|
operation
|
Operation: "add" (append values, default) or "set" (replace all values).
|
STRING |
Response
| Name |
Description |
Type |
|
values
|
Current values of the field after the operation.
|
ARRAY |
|
field_id
|
The ID of the instance field that was updated.
|
STRING |
|
description
|
Description of the operation result.
|
STRING |
|
request_id
|
ID of the workflow instance that was updated.
|
INTEGER |
|
status
|
Returns "OK" if the operation was successful; or "ERROR" if something went wrong.
|
STRING |