It allows you to interact with Plumsail HelpDesk ticketing system. Visit https://plumsail.com/docs/help-desk-o365/v1.x/API/ms-flow.html for more information.
Status: Preview |
Tier: Standard |
Version: v4 |
Name |
Summary |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Get tickets
Description: Get tickets list
Syntax:
PlumsailHelpDesk._flowV4TicketsGet ([advanced][Optional]string $select, [advanced][Optional]string $expand, [advanced][Optional]string $filter, [advanced][Optional]string $orderBy, [advanced][Optional]integer $top, [advanced][Optional]string $skiptoken)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
$select |
string ($select) |
An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields. |
False |
|
$expand |
string ($expand) |
An ODATA $expand query option to specify that the request returns the values of lookups. |
False |
|
$filter |
string ($filter) |
An ODATA $filter query option to restrict the entries returned |
False |
|
$orderBy |
string ($orderBy) |
An ODATA $orderBy query option for specifying the order of entries. |
False |
|
$top |
integer ($top) |
An ODATA $top query option to select the first n items of the return set for return (default = 50, maximum = 100). |
False |
|
$skiptoken |
string ($skiptoken) |
An ODATA $skiptoken query option to skip over items until the specified item is reached and return the rest. |
False |
Returns:
Type:array of (TicketRead)
Summary: Create a ticket
Description: Creates new ticket and returns created ticket.
Syntax:
PlumsailHelpDesk._flowV4TicketsPost ([Optional]TicketWrite ticket)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ticket |
|
|
False |
Returns:
Type:TicketRead
Summary: Get a single ticket
Description: Gets a ticket by Id and returns it
Syntax:
PlumsailHelpDesk._flowV4TicketsByIdGet (integer id, [advanced][Optional]string $select, [advanced][Optional]string $expand)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
integer(int32) (Ticket Id) |
Ticket Id |
True |
|
$select |
string ($select) |
An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields. |
False |
|
$expand |
string ($expand) |
An ODATA $expand query option to specify that the request returns the values of lookups. |
False |
Returns:
Type:TicketRead
Summary: Update a ticket
Description: Gets a ticket by Id and updates it. Returns updated ticket.
Syntax:
PlumsailHelpDesk._flowV4TicketsByIdPut (integer id, [Optional]TicketWrite ticket)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
integer(int32) (Ticket Id) |
Ticket Id |
True |
|
ticket |
|
|
False |
Returns:
Type:TicketRead
Summary: Delete a ticket
Description: Deletes ticket by Id.
Syntax:
PlumsailHelpDesk._flowV4TicketsByIdDelete (integer id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
integer(int32) (Ticket Id) |
Ticket Id |
True |
Returns:
Summary: Download attachment
Description: Returns attachment file for specific ticket by its name, or returns error code
Syntax:
PlumsailHelpDesk._flowV4TicketsByIdAttachmentsByFilenameGet (integer id, string filename)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
integer(int32) (Ticket Id) |
Ticket Id |
True |
|
filename |
string (Attachment Filename) |
Attachment Filename |
True |
Returns:
Summary: Get all comments for a ticket
Description: Gets all comments for a ticket with specified Id.
Syntax:
PlumsailHelpDesk._flowV4TicketsByTicketIdCommentsGet (integer ticketId, [advanced][Optional]string $select, [advanced][Optional]string $expand, [advanced][Optional]string $filter, [advanced][Optional]string $orderBy)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ticketId |
integer(int32) (Ticket Id) |
Ticket ID |
True |
|
$select |
string ($select) |
An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields. |
False |
|
$expand |
string ($expand) |
An ODATA $expand query option to specify that the request returns the values of lookups. |
False |
|
$filter |
string ($filter) |
An ODATA $filter query option to restrict the entries returned |
False |
|
$orderBy |
string ($orderBy) |
An ODATA $orderBy query option for specifying the order of entries. |
False |
Returns:
Type:array of (CommentRead)
Summary: Create a comment
Description: Creates new comment for a ticket with specified ID and returns it.
Syntax:
PlumsailHelpDesk._flowV4TicketsByTicketIdCommentsPost ([Optional]CommentWrite comment, integer ticketId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
comment |
|
|
False |
|
ticketId |
integer(int32) (Ticket Id) |
Ticket ID |
True |
Returns:
Type:CommentRead
Summary: Get a single comment
Description: Gets a comment by ID and returns it.
Syntax:
PlumsailHelpDesk._flowV4TicketsByTicketIdCommentsByIdGet (integer ticketId, integer id, [advanced][Optional]string $select, [advanced][Optional]string $expand)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ticketId |
integer(int32) (Ticket Id) |
Ticket Id |
True |
|
id |
integer(int32) (Comment Id) |
Comment ID |
True |
|
$select |
string ($select) |
An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields. |
False |
|
$expand |
string ($expand) |
An ODATA $expand query option to specify that the request returns the values of lookups. |
False |
Returns:
Type:CommentRead
Summary: Get contacts
Description: Get contacts list
Syntax:
PlumsailHelpDesk._flowV4ContactsGet ([advanced][Optional]string $select, [advanced][Optional]string $expand, [advanced][Optional]string $filter, [advanced][Optional]string $orderBy, [advanced][Optional]integer $top, [advanced][Optional]string $skiptoken)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
$select |
string ($select) |
An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields. |
False |
|
$expand |
string ($expand) |
An ODATA $expand query option to specify that the request returns the values of lookups. |
False |
|
$filter |
string ($filter) |
An ODATA $filter query option to restrict the entries returned |
False |
|
$orderBy |
string ($orderBy) |
An ODATA $orderBy query option for specifying the order of entries. |
False |
|
$top |
integer ($top) |
An ODATA $top query option to select the first n items of the return set for return (default = 50, maximum = 100). |
False |
|
$skiptoken |
string ($skiptoken) |
An ODATA $skiptoken query option to skip over items until the specified item is reached and return the rest. |
False |
Returns:
Type:array of (ContactRead)
Summary: Create a contact
Description: Creates new contact and returns it.
Syntax:
PlumsailHelpDesk._flowV4ContactsPost ([Optional]ContactWrite contact, [Optional]boolean updateIfExists)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
contact |
|
|
False |
|
updateIfExists |
boolean (Update Contact if exists) |
Update contact if it already exists |
False |
Returns:
Type:ContactRead
Summary: Get a single contact by Id
Description: Gets a contact by Id and returs it.
Syntax:
PlumsailHelpDesk._flowV4ContactsByIdGet (integer id, [advanced][Optional]string $select, [advanced][Optional]string $expand)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
integer(int32) (Contact Id) |
Contact Id |
True |
|
$select |
string ($select) |
An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields. |
False |
|
$expand |
string ($expand) |
An ODATA $expand query option to specify that the request returns the values of lookups. |
False |
Returns:
Type:ContactRead
Summary: Update a contact
Description: Finds a contact by Id and updates it. Returns updated contact.
Syntax:
PlumsailHelpDesk._flowV4ContactsByIdPut (integer id, [Optional]ContactWrite contact)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
integer(int32) (Contact Id) |
Contact Id |
True |
|
contact |
|
|
False |
Returns:
Type:ContactRead
Summary: Delete a contact
Description: Deletes contact by Id
Syntax:
PlumsailHelpDesk._flowV4ContactsByIdDelete (integer id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
integer(int32) (Contact Id) |
Contact Id |
True |
Returns:
Summary: Get a single contact by Email
Description: Gets a contact by email and returns it.
Syntax:
PlumsailHelpDesk._flowV4ContactsByEmailByEmailGet (string email, [advanced][Optional]string $select, [advanced][Optional]string $expand)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
|
string (Contact Email) |
Contact Email |
True |
|
$select |
string ($select) |
An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields. |
False |
|
$expand |
string ($expand) |
An ODATA $expand query option to specify that the request returns the values of lookups. |
False |
Returns:
Type:ContactRead
Summary: Update a contact by Email
Description: Finds a contact by email and updates it. Returns updated contact.
Syntax:
PlumsailHelpDesk._flowV4ContactsByEmailByEmailPut (string email, [Optional]ContactWrite contact)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
|
string (Contact Email) |
Contact email |
True |
|
contact |
|
|
False |
Returns:
Type:ContactRead
Summary: Get organizations
Description: Get organizations list
Syntax:
PlumsailHelpDesk._flowV4OrganizationsGet ([advanced][Optional]string $select, [advanced][Optional]string $expand, [advanced][Optional]string $filter, [advanced][Optional]string $orderBy, [advanced][Optional]integer $top, [advanced][Optional]string $skiptoken)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
$select |
string ($select) |
An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields. |
False |
|
$expand |
string ($expand) |
An ODATA $expand query option to specify that the request returns the values of lookups. |
False |
|
$filter |
string ($filter) |
An ODATA $filter query option to restrict the entries returned |
False |
|
$orderBy |
string ($orderBy) |
An ODATA $orderBy query option for specifying the order of entries. |
False |
|
$top |
integer ($top) |
An ODATA $top query option to select the first n items of the return set for return (default = 50, maximum = 100). |
False |
|
$skiptoken |
string ($skiptoken) |
An ODATA $skiptoken query option to skip over items until the specified item is reached and return the rest. |
False |
Returns:
Type:array of (OrganizationRead)
Summary: Create an organization
Description: Creates new item in Organizations list and return it
Syntax:
PlumsailHelpDesk._flowV4OrganizationsPost ([Optional]OrganizationWrite organization)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
organization |
|
|
False |
Returns:
Type:OrganizationRead
Summary: Get a single organization
Description: Gets organization by Id and returns it
Syntax:
PlumsailHelpDesk._flowV4OrganizationsByIdGet (integer id, [advanced][Optional]string $select, [advanced][Optional]string $expand)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
integer(int32) (Organization Id) |
Organization Id |
True |
|
$select |
string ($select) |
An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields. |
False |
|
$expand |
string ($expand) |
An ODATA $expand query option to specify that the request returns the values of lookups. |
False |
Returns:
Type:OrganizationRead
Summary: Update an organization
Description: Gets an organization by Id and returns it.
Syntax:
PlumsailHelpDesk._flowV4OrganizationsByIdPut (integer id, [Optional]OrganizationWrite organization)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
integer(int32) (Organization Id) |
Organization Id |
True |
|
organization |
|
|
False |
Returns:
Type:OrganizationRead
Summary: Delete an organization
Description: Deletes organization by Id.
Syntax:
PlumsailHelpDesk._flowV4OrganizationsByIdDelete (integer id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
integer(int32) (Organization Id) |
Organization Id |
True |
Returns:
Summary: Get a single organization by title
Description: Gets an organization by title and returns it.
Syntax:
PlumsailHelpDesk._flowV4OrganizationsByTitleByTitleGet (string title, [advanced][Optional]string $select, [advanced][Optional]string $expand)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
title |
string (Organization title) |
Organization title |
True |
|
$select |
string ($select) |
An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields. |
False |
|
$expand |
string ($expand) |
An ODATA $expand query option to specify that the request returns the values of lookups. |
False |
Returns:
Type:OrganizationRead
Summary: Update an organization by title
Description: Gets an organization by title and updates it. Returns updated organization.
Syntax:
PlumsailHelpDesk._flowV4OrganizationsByTitleByTitlePut (string title, [Optional]OrganizationWrite organization)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
title |
string (Organization title) |
Organization title |
True |
|
organization |
|
|
False |
Returns:
Type:OrganizationRead
Summary: Delete an organization by title
Description: Deletes organization by title
Syntax:
PlumsailHelpDesk._flowV4OrganizationsByTitleByTitleDelete (string title)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
title |
string (Organization title) |
Organization title |
True |
Returns:
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Assignee ID |
|
title |
string Assignee Full Name |
|
|
string Assignee Email |
|
spUserId |
integer(int32) Assignee SPUserId |
|
role |
string Assignee Role |
|
emailAlternate |
string Assignee Alternate Email |
|
customFields |
Assignee CustomFields |
JSON string containing custom field values |
Summary: Assignee CustomFields
Description: JSON string containing custom field values
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Name |
string Attachment File Name |
|
AttachmentContent |
string(binary)
|
File Content |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Cc ID |
|
title |
string Cc Full Name |
|
|
string Cc Email |
|
spUserId |
integer(int32) Cc SPUserId |
|
role |
string Cc Role |
|
emailAlternate |
string Cc Alternate Email |
|
customFields |
Cc CustomFields |
JSON string containing custom field values |
Summary: Cc CustomFields
Description: JSON string containing custom field values
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
body |
string Comment Body |
|
created |
string(date-time) Comment Creation Date |
|
fromEmail |
string Comment Author Email |
|
fromName |
string Comment Author Name |
|
messageId |
string Comment MessageId |
|
id |
integer(int32) Comment ID |
|
customFields |
Comment Custom Fields |
JSON string containing custom field values |
Summary: Comment Custom Fields
Description: JSON string containing custom field values
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
attachments |
array of (Attachment)
|
|
body |
string Comment Body |
|
fromEmail |
string Comment Author Email |
|
messageId |
string Comment MessageId |
|
customFields |
Comment Custom Fields |
JSON string containing custom field values |
Summary: Comment Custom Fields
Description: JSON string containing custom field values
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
title |
string Contact Full Name |
|
|
string Contact Email |
|
spUserId |
integer(int32) Contact SPUserId |
|
role |
string Contact Role |
|
emailAlternate |
string Contact Alternate Email |
|
id |
integer(int32) Contact ID |
|
customFields |
Contact Custom Fields |
JSON string containing custom field values |
Summary: Contact Custom Fields
Description: JSON string containing custom field values
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
title |
string Contact Name |
|
|
string Contact Email |
|
spUserId |
integer(int32) Contact SPUserId |
|
role |
string Contact Role |
|
emailAlternate |
string Contact Alternate Email |
|
customFields |
Contact Custom Fields |
JSON string containing custom field values |
Summary: Contact Custom Fields
Description: JSON string containing custom field values
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
title |
string Organization Title |
|
id |
integer(int32) Organization ID |
|
customFields |
Organization Custom Fields |
JSON string containing custom field values |
Summary: Organization Custom Fields
Description: JSON string containing custom field values
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
title |
string Organization Title |
|
customFields |
Organization Custom Fields |
JSON string containing custom field values |
Summary: Organization Custom Fields
Description: JSON string containing custom field values
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Requester ID |
|
title |
string Requester Full Name |
|
|
string Requester Email |
|
spUserId |
integer(int32) Requester SPUserId |
|
role |
string Requester Role |
|
emailAlternate |
string Requester Alternate Email |
|
customFields |
Requester CustomFields |
JSON string containing custom field values |
Summary: Requester CustomFields
Description: JSON string containing custom field values
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
title |
string Tag Title |
|
id |
integer(int32) Tag ID |
|
customFields |
Tag Custom Fields |
JSON string containing custom field values |
Summary: Tag Custom Fields
Description: JSON string containing custom field values
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
ticketID |
string Custom Ticket ID |
|
subject |
string Ticket Subject |
|
requester |
|
|
assignedTo |
|
|
status |
string Ticket Status |
|
category |
string Ticket Category |
|
priority |
string Ticket Priority |
|
dueDate |
string(date-time) Ticket Due Date |
|
created |
string(date-time) Ticket Creation Date |
|
resolutionDate |
string(date-time) Ticket Resolution Date |
|
cc |
array of (Cc) Ticket Cc |
|
tags |
array of (TagRead) Ticket Tags |
|
attachments |
array of (string) Ticket Attachments |
|
id |
integer(int32) Ticket ID |
|
customFields |
Ticket Custom Fields |
JSON string containing custom field values |
Summary: Ticket Custom Fields
Description: JSON string containing custom field values
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
subject |
string Ticket Subject |
|
body |
string Ticket Body |
|
requesterEmail |
string Ticket Requester Email |
|
assignedToEmail |
string Ticket Assignee Email or SharePoint Group Name |
|
status |
string Ticket Status |
|
category |
string Ticket Category |
|
priority |
string Ticket Priority |
|
dueDate |
string(date-time) Ticket DueDate |
|
ccEmails |
array of (string) Ticket Cc Emails |
|
tagTitles |
array of (string) Ticket Tags Titles |
|
supportChannel |
string Ticket SupportChannel |
|
attachments |
array of (Attachment) Ticket Attachments |
|
customFields |
Ticket Custom Fields |
JSON string containing custom field values |
Summary: Ticket Custom Fields
Description: JSON string containing custom field values
Properties:
Name |
Type |
Summary |