Module Ticket

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Helpdesk Ticket Messages

Primary Key: Id

Schema

Field
Type
Description

Attachments

serialize

Attachments

Content

string

Content

Creator

string

Creator

CreatorAvatar

serialize

Creator Avatar

CreatorName

string

Creator Name

CreatorRole

string

Creator Role

DateOfCreated

datetime

Date Of Created

Id

numeric

Id

Mode

string

Mode

State

string

State

SystemUuid

string

System Uuid

Ticket

string

Ticket

Title

string

Title

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/helpdesk/ticket/messages/{Id}: for get exacly item

  • GET /v4/helpdesk/ticket/messages: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/helpdesk/ticket/messages

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/helpdesk/ticket/messages/{Id}: for put exacly item

  • PUT /v4/helpdesk/ticket/messages: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/helpdesk/ticket/messages/{Id}: for delete exacly item

  • DELETE /v4/helpdesk/ticket/messages?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Helpdesk V3 Tickets

Primary Key: Code

Schema

Field
Type
Description

AcceptBy

string

Accept By

CallLog

string

Call Log

CallSessionId

string

Call Session Id

ChatRoom

string

Chat Room

Code

string

Code

Contract

string

Contract

Coordinator

string

Coordinator

CoordinatorEmail

string

Coordinator Email

CoordinatorName

string

Coordinator Name

CoordinatorPhone

string

Coordinator Phone

Creator

string

Creator

DateOfComplete

string

Date Of Complete

DateOfCreate

datetime

Date Of Create

DateOfStart

string

Date Of Start

DateOfUpdate

string

Date Of Update

Description

string

Description

Id

numeric

Id

Latitude

string

Latitude

LocalChatRoom

string

Local Chat Room

Longitude

string

Longitude

Object

string

Object

ObjectAddress

string

Object Address

ObjectBranch

string

Object Branch

ObjectBranchBk

numeric

Object Branch Bk

ObjectEmail

string

Object Email

ObjectName

string

Object Name

ObjectPhone

string

Object Phone

ObjectType

string

Object Type

Priority

string

Priority

Procedure

string

Procedure

RequestIp

string

Request Ip

Service

string

Service

Source

string

Source

State

string

State

SuggestObject

string

Suggest Object

SupportedPerson

string

Supported Person

SupportedPersonAddress

string

Supported Person Address

SupportedPersonEmail

string

Supported Person Email

SupportedPersonName

string

Supported Person Name

SupportedPersonPhone

string

Supported Person Phone

Tags

objects

Tags

TimeDuration

numeric

Time Duration

Title

string

Title

Type

string

Type

UuidIndex

string

Uuid Index

WorkingName

string

Working Name

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/helpdesk/tickets/{Code}: for get exacly item

  • GET /v4/helpdesk/tickets: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/helpdesk/tickets

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/helpdesk/tickets/{Code}: for put exacly item

  • PUT /v4/helpdesk/tickets: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/helpdesk/tickets/{Code}: for delete exacly item

  • DELETE /v4/helpdesk/tickets?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Helpdesk TicketCallingSessions

Primary Key: Ticket, CallingSession

Schema

Field
Type
Description

CallSession

string

Call Session

DateOfCalling

string

Date Of Calling

Id

numeric

Id

State

string

State

Ticket

string

Ticket

CallingSession

string

Calling Session

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/helpdesk/ticketCallingSessions/{Ticket}-{CallingSession}: for get exacly item

  • GET /v4/helpdesk/ticketCallingSessions: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/helpdesk/ticketCallingSessions

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/helpdesk/ticketCallingSessions/{Ticket}-{CallingSession}: for put exacly item

  • PUT /v4/helpdesk/ticketCallingSessions: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/helpdesk/ticketCallingSessions/{Ticket}-{CallingSession}: for delete exacly item

  • DELETE /v4/helpdesk/ticketCallingSessions?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Helpdesk TicketPms

Primary Key: Id

Schema

Field
Type
Description

Address

string

Address

AvatarThumbnail

string

Avatar Thumbnail

ChatRoom

string

Chat Room

Contact

string

Contact

Core

string

Core

CreatedUser

string

Created User

DateOfGranted

string

Date Of Granted

DisabledNotification

string

Disabled Notification

Email

string

Email

Group

string

Group

Id

numeric

Id

IsAllow

numeric

Is Allow

IsSilent

numeric

Is Silent

LastMessageText

string

Last Message Text

LastReport

string

Last Report

LastUpdate

string

Last Update

LastZaloMessageId

string

Last Zalo Message Id

Latitude

string

Latitude

Longitude

string

Longitude

Name

string

Name

Note

string

Note

NumOfMessage

numeric

Num Of Message

NumOfReadMessage

numeric

Num Of Read Message

Page

string

Page

PbxDelegatePhone

string

Pbx Delegate Phone

Permission

string

Permission

Phone

string

Phone

ReadCommit

string

Read Commit

RefConnectState

string

Ref Connect State

RefPlatform

string

Ref Platform

RefType

string

Ref Type

RefUserUuid

string

Ref User Uuid

RefWebhook

string

Ref Webhook

Role

string

Role

Roles

object

Roles

ShortName

string

Short Name

State

string

State

Type

string

Type

User

string

User

ZaloAppId

string

Zalo App Id

ZaloOa

string

Zalo Oa

ZaloOaId

string

Zalo Oa Id

ZaloUser

string

Zalo User

ZaloUserStatus

numeric

Zalo User Status

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/helpdesk/ticketPms/{Id}: for get exacly item

  • GET /v4/helpdesk/ticketPms: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/helpdesk/ticketPms

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/helpdesk/ticketPms/{Id}: for put exacly item

  • PUT /v4/helpdesk/ticketPms: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/helpdesk/ticketPms/{Id}: for delete exacly item

  • DELETE /v4/helpdesk/ticketPms?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Helpdesk Services

Primary Key: Code

Schema

Field
Type
Description

Code

string

Code

CurrentChatRoom

string

Current Chat Room

Description

string

Description

Id

numeric

Id

Name

string

Name

Type

string

Type

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/helpdesk/services/{Code}: for get exacly item

  • GET /v4/helpdesk/services: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/helpdesk/services

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/helpdesk/services/{Code}: for put exacly item

  • PUT /v4/helpdesk/services: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/helpdesk/services/{Code}: for delete exacly item

  • DELETE /v4/helpdesk/services?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Helpdesk Users

Primary Key: Code

Schema

Field
Type
Description

Activated

string

Activated

ActiveCode

string

Active Code

Address

string

Address

AllowLoginSignature

string

Allow Login Signature

Avatar

string

Avatar

AvatarId

numeric

Avatar Id

AvatarThumbnail

string

Avatar Thumbnail

Banner

string

Banner

Birthday

string

Birthday

BkAddress

string

Bk Address

BkEmail

string

Bk Email

BkGlobalPhone

string

Bk Global Phone

BkPassword

string

Bk Password

BkPhone

string

Bk Phone

BkUsername

string

Bk Username

BuildIn

numeric

Build In

Code

string

Code

ComplexId

string

Complex Id

ContactAddress

string

Contact Address

ContactEmail

string

Contact Email

ContactFax

string

Contact Fax

ContactGroupId

numeric

Contact Group Id

ContactGtalkId

string

Contact Gtalk Id

ContactHomeTel

string

Contact Home Tel

ContactMaxDebt

string

Contact Max Debt

ContactOtherEmail

string

Contact Other Email

ContactOtherMobile

string

Contact Other Mobile

ContactPersonalEmail

string

Contact Personal Email

ContactPhone

string

Contact Phone

ContactSkypeId

string

Contact Skype Id

ContactTaxCode

string

Contact Tax Code

ContactTypeId

numeric

Contact Type Id

ContactWebsite

string

Contact Website

ContactWorkTel

string

Contact Work Tel

ContactYahooId

string

Contact Yahoo Id

CookieCode

string

Cookie Code

Created

string

Created

CreationDate

string

Creation Date

CreationUserId

numeric

Creation User Id

DisabledNotificationTypes

string

Disabled Notification Types

Email

string

Email

EmailVerified

string

Email Verified

ForceUpdate

numeric

Force Update

ForgetPassCode

string

Forget Pass Code

ForgetRequested

string

Forget Requested

Gender

string

Gender

GlobalPhone

string

Global Phone

GroupId

numeric

Group Id

Id

numeric

Id

IdentityCardImage1

string

Identity Card Image1

IdentityCardImage2

string

Identity Card Image2

IdentityCardNumber

string

Identity Card Number

IdentityCardVerified

string

Identity Card Verified

IsActive

numeric

Is Active

IsRegenerateCode

numeric

Is Regenerate Code

IsSync

numeric

Is Sync

LocationId

numeric

Location Id

Name

string

Name

NumOfChildren

numeric

Num Of Children

OldCode

string

Old Code

ParentId

numeric

Parent Id

Password

string

Password

Phone

string

Phone

PhoneVerified

string

Phone Verified

PinCodeSignature

string

Pin Code Signature

ReferralByCode

string

Referral By Code

ReferralByTypeId

numeric

Referral By Type Id

ShortName

string

Short Name

StoreId

numeric

Store Id

TagName

string

Tag Name

Title

string

Title

Updated

string

Updated

Username

string

Username

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/helpdesk/users/{Code}: for get exacly item

  • GET /v4/helpdesk/users: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/helpdesk/users

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/helpdesk/users/{Code}: for put exacly item

  • PUT /v4/helpdesk/users: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/helpdesk/users/{Code}: for delete exacly item

  • DELETE /v4/helpdesk/users?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Helpdesk UserExtensions

Primary Key: Id

Schema

Field
Type
Description

DisplayName

string

Display Name

Domain

string

Domain

DomainUuid

string

Domain Uuid

Extension

string

Extension

Host

string

Host

Id

numeric

Id

Password

string

Password

Pbx

string

Pbx

PbxDelegatePhone

string

Pbx Delegate Phone

Port

numeric

Port

Transport

string

Transport

Type

string

Type

User

string

User

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/helpdesk/userExtensions/{Id}: for get exacly item

  • GET /v4/helpdesk/userExtensions: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/helpdesk/userExtensions

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/helpdesk/userExtensions/{Id}: for put exacly item

  • PUT /v4/helpdesk/userExtensions: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/helpdesk/userExtensions/{Id}: for delete exacly item

  • DELETE /v4/helpdesk/userExtensions?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Helpdesk CallLogs

Primary Key: xml_cdr_uuid

Schema

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/helpdesk/relativeCallLogs/{xml_cdr_uuid}: for get exacly item

  • GET /v4/helpdesk/relativeCallLogs: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/helpdesk/relativeCallLogs

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/helpdesk/relativeCallLogs/{xml_cdr_uuid}: for put exacly item

  • PUT /v4/helpdesk/relativeCallLogs: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/helpdesk/relativeCallLogs/{xml_cdr_uuid}: for delete exacly item

  • DELETE /v4/helpdesk/relativeCallLogs?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Helpdesk Routes

Primary Key: Code

Schema

Field
Type
Description

Code

string

Code

Description

string

Description

Id

numeric

Id

Name

string

Name

Priority

numeric

Priority

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/helpdesk/routes/{Code}: for get exacly item

  • GET /v4/helpdesk/routes: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/helpdesk/routes

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/helpdesk/routes/{Code}: for put exacly item

  • PUT /v4/helpdesk/routes: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/helpdesk/routes/{Code}: for delete exacly item

  • DELETE /v4/helpdesk/routes?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Helpdesk Params

Primary Key: Name

Schema

Field
Type
Description

DefaultDataType

string

Default Data Type

DefaultOperator

string

Default Operator

Description

string

Description

Id

numeric

Id

Name

string

Name

RemoteDataResource

string

Remote Data Resource

RemoteDataSource

string

Remote Data Source

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/helpdesk/params/{Name}: for get exacly item

  • GET /v4/helpdesk/params: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/helpdesk/params

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/helpdesk/params/{Name}: for put exacly item

  • PUT /v4/helpdesk/params: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/helpdesk/params/{Name}: for delete exacly item

  • DELETE /v4/helpdesk/params?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Helpdesk Actions

Primary Key: Name

Schema

Field
Type
Description

ActionFunction

string

Action Function

Description

string

Description

Id

numeric

Id

Name

string

Name

Param

string

Param

SetValue

string

Set Value

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/helpdesk/actions/{Name}: for get exacly item

  • GET /v4/helpdesk/actions: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/helpdesk/actions

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/helpdesk/actions/{Name}: for put exacly item

  • PUT /v4/helpdesk/actions: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/helpdesk/actions/{Name}: for delete exacly item

  • DELETE /v4/helpdesk/actions?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Helpdesk Procedures

Primary Key: Code

Schema

Field
Type
Description

Code

string

Code

Creator

numeric

Creator

DateOfCreated

string

Date Of Created

Description

string

Description

Id

numeric

Id

Name

string

Name

State

string

State

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/helpdesk/procedures/{Code}: for get exacly item

  • GET /v4/helpdesk/procedures: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/helpdesk/procedures

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/helpdesk/procedures/{Code}: for put exacly item

  • PUT /v4/helpdesk/procedures: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/helpdesk/procedures/{Code}: for delete exacly item

  • DELETE /v4/helpdesk/procedures?id0=123&id1=456&...: for delete multiple items with id0 id1,...