Skip to end of metadata
Go to start of metadata

Space Index

0-9 ... 0 A ... 13 B ... 0 C ... 7 D ... 0 E ... 1
F ... 0 G ... 3 H ... 1 I ... 2 J ... 0 K ... 1
L ... 1 M ... 0 N ... 0 O ... 0 P ... 1 Q ... 0
R ... 4 S ... 3 T ... 4 U ... 3 V ... 1 W ... 0
X ... 0 Y ... 0 Z ... 1 !@#$ ... 0    

0-9

A

Page: AccountingInfo
AccountingInfo JSON Format Name Type Read-only Mandatory Comment id integer yes no   poNumber string no no   accountNumber string       accumulatedNumber string       expenseNumber string       leaseNumber string       leaseExpirationDate string       lea
Page: Address
Address JSON Format Name Type Read-only Mandatory Comment id integer yes no   line1 string no yes   line2 string no no   city string no yes   state string no yes   postalCode string no yes   country string no yes   addressType string no yes One of: Office
Page: Asset
Asset JSON Format Name Type Read-only Mandatory Comment id integer yes no Automatically assigned when creating Assets assetNumber string no yes User supplied value uniquely identifying Asset name string no yes   description string       accountingInfo Acc
Page: Asset Resources
Drill down to see all Asset related resources.  
Page: AssetCustomField
AssetCustomField JSON Format Name Type Read-only Mandatory Comment id integer yes no   name string no yes   description string no no   customFieldType string no yes one of: "text", "textarea", "select", "checkbox", "radio", "date" assetFieldGroupId intege
Page: AssetCustomFieldOption
AssetCustomFieldOption JSON Format Name Type Read-only Mandatory Comment id integer yes no   value string no yes   optionOrder integer no     customFieldId integer no yes   URIs Accessed through AssetCustomField Api  
Page: AssetCustomFieldValue
AssetCustomFieldValue JSON Format Name Type Read-only Mandatory Comment id integer yes no   customFieldId integer no yes   fieldValue string no no   fieldValueText string no no   assetId integer no yes   URIs Accessed through Asset Api  
Page: AssetFieldGroup
AssetFieldGroup JSON Format Name Type Read-only Mandatory Comment id integer yes no   name string no yes   description string no no   tabOrder integer no     customFieldIds array     Array of AssetCustomField IDs assetTypeIds array     Array of AssetType
Page: AssetFilter
AssetFilter JSON Format Name Type Read-only Mandatory Comment id integer yes no   userId integer no no User.id name string no yes   private boolean no no   assetNumbers array     array of string names array     array of string typeIds array     array of A
Page: AssetStatus
AssetStatus JSON Format Name Type Read-only Mandatory Comment id integer yes no   name string no yes   description string no no   URIs Uri Method Request Data Success Response Code Description /api/asset-statuses GET   200 Returns an Array of all AssetSta
Page: AssetType
AssetType JSON Format Name Type Read-only Mandatory Comment id integer yes no   name string no yes   notes string no no   fieldGroupIds array no no Array of AssetFieldGroup IDs associated with this AssetType URIs Uri Method Request Data Success Response C
Page: Assignment
Assignment JSON Format Name Type Read-only Mandatory Comment id integer yes no   userRoleGroupId integer no yes UserRoleGroup.id http://UserRoleGroup.id locationId integer no no Location.id http://Location.id groupId integer no no Group.id http://Group.id
Page: Attachment
Attachment JSON Format Name Type Read-only Mandatory Comment id integer yes no   fileName string no yes   contentType string no yes   contentUrl string yes no   URIs Accessed through Ticket Api and KnowledgeBaseArticle Api  

B

C

Page: Category
Category JSON Format Name Type Read-only Mandatory Comment id integer yes no   name string no yes   active boolean no no   categoryOptionIds array no no array of CategoryOption.id http://CategoryOption.id groupId array no yes Group.id http://Group.id URIs
Page: CategoryOption
CategoryOption JSON Format Name Type Read-only Mandatory Comment id integer yes no   name string no yes   categoryId integer no yes Category.id http://Category.id active boolean no no   URIs Uri Method Request Data Success Response Code Description /api/c
Page: Common Response Structures
Successful requests get a response in the 200 or 300 range. When creating or updating a resource, the resulting JSON representation will be rendered in the response body and a Location header pointing to the resource. Example response for create call usin
Page: Curl Examples
It is possible to call the api's using the command line tool curl http://curl.haxx.se/docs/manpage.html. This provides a simple way to use and test the api. These examples also use the json_reformat tool provided by the yajl http://lloyd.github.io/yajl/ l
Page: CustomField
CustomField JSON Format Name Type Read-only Mandatory Comment id integer yes no   name string no yes   required boolean no no   active boolean no no   order integer no no   fieldType string no yes one of: text, textarea, select, checkbox, radio, date, num
Page: CustomFieldOption
CustomFieldOption Name Type Read-only Mandatory Comment id integer yes no   displayValue string       order integer       customFieldId integer     CustomField.id http://CustomField.id URIs Accessed through CustomField Api  
Page: CustomFieldValue
CustomFieldValues Name Type Read-only Mandatory Comment id integer yes no   ticketId integer no yes Ticket.id http://Ticket.id fieldValue string no no   customFieldId integer no yes CustomField.id http://CustomField.id URIs Accessed through Ticket Api  

D

E

Home page: eHD API Documentation
This is the home of the eHD API Documentation space. Navigation links are located in the left sidebar. First, check out the pages in the Getting Started section, then look through the Resource Listing pages.     Search this documentation

F

G

Page: Getting Started
Getting Stated Pages: Introduction Resources Resource URIs Headers Security & Authentication Common Response Structures
Page: GMAIL INCOMING AND OUTGOING MAIL SETUP
A.      Create a project at Google API Console Go to https://console.developers.google.com/ https://console.developers.google.com/ Login with the admin user of the domain(admin@example.com http://example.com) Select a project and create a new project    
Page: Group
Group JSON Format Name Type Read-only Mandatory Comment id integer yes no   name string no yes   comments string no no   active boolean no false   assetTrackerType string no no One of: EHD, ZEN10, NONE categoryIds array no no array of Category.id http://C

H

Page: Headers
The API is JSON-only. You must supply a Content-Type: application/json header on PUT and POST operations. You must set a Accept: application/json header on all requests. You may get a text/plain response in case of error, e.g. in case of a bad request, yo

I

Page: Index
Page: Introduction
The purpose of this project is to develop a set of APIs for eHelpDesk that can be used to integrate eHD with the UVNetworks application, or any other third-party application. The API will be based on REST style architecture principles with JSON as the dat

J

K

Page: KnowledgeBaseArticle
KnowledgeBaseArticle JSON Format Name Type Read-only Mandatory Comment id integer yes no   subject string no yes   problem string no yes   resolution string no yes   date date       private boolean no no   groupId integer no yes   timesViewed integer yes

L

Page: Location
Location JSON Format Name Type Read-only Mandatory Comment id integer yes no   name string no yes   comments string no no   active boolean no no   URIs Uri Method Request Data Success Response Code Description /api/locations GET   200 Returns an Array of

M

N

O

P

Page: Phone
Phone JSON Format Name Type Read-only Mandatory Comment id integer yes no   number string no yes   extension string no no   phoneType string no yes One of: Home, Office, Cell, Fax URIs Uri Method Request Data Success Response Code Description /api/phones

Q

R

Page: Resource Listing
Individual resource detail pages are available using navigation in left sidebar.  
Page: Resource URIs
Each Resource provides a standard set or URIs for creating, updating, deleting, and listing data. Additional URIs may be created for doing things like applying an action to a resource, custom look up methods, etc.
Page: Resources
Individual resources are specified by the request URI. A representation of the resource may be included in the response. Using this representation, a client has enough information to modify or delete the resource.
Page: Role
JSON Format Name Type     Comment id integer       name string       URIs URI Method Request Data Successful Reponse Comment /api/roles GET   200 Returns an array of all Roles /api/roles/{id} GET   200 Return one Role

S

Page: Security & Authentication
All requests to the API Resource URIs need to provide the authentication credentials using HTTP BASIC authentication (preferably over SSL). Only the Admin user should be allowed to call the APIs for this version.
Page: SoftwareLicense
SoftwareLicense JSON Format Name Type Read-only Mandatory Comment id integer yes no   productName string no yes   productVersion string no     vendorId integer no     numberOfLicenses integer no     purchaseDate date no     supportExpirationDate date no  
Page: Status
Status Name Type Read-only Mandatory Comment id integer yes no   name string no yes   order integer no no   active boolean no no   URIs Uri Method Request Data Success Response Code Description /api/statuses GET   200 Returns an Array of all Status's /api

T

Page: Ticket
Ticket JSON Format Name Type Read-only Mandatory Comment id integer yes no   contactId integer no yes User.id http://User.id submittedById integer yes no User.id http://User.id assignedToId integer no yes UserRoleGroup.id http://UserRoleGroup.id priorityI
Page: TicketFilter
TicketFilter JSON Format Name Type Read-only Mandatory Comment id integer yes no   name string no yes   userId integer no yes User.id http://User.id of owner privateFilter boolean no no default = true ticketNumbers array     array of Ticket.id http://Tick
Page: TicketHistory
TicketHistory JSON Format Name Type Read-only Mandatory Comment id integer yes no   subject string no yes   note string no yes   ticketId integer no yes Ticket.id http://Ticket.id userId integer no yes User.id http://User.id createdDate date yes no   atta
Page: TicketPriority
TicketPriority JSON Format Name Type Read-only Mandatory Comment id integer yes no   name string no yes   icon string no no   order integer no no   active boolean no no   URIs Uri Method Request Data Success Response Code Description /api/ticket-prioritie

U

Page: User
User JSON Format Name Type Read-only Mandatory Comment id integer yes no   firstName string no yes   lastName string no yes   email string no yes   loginId string no yes   active boolean no     onVacation bolean       creationDate date       creator strin
Page: UserRole
UserRole JSON Format Name Type Read-only Mandatory Comment id integer yes no   userId integer no yes User.id http://User.id roleId integer no yes Role.id http://Role.id active boolean       userRoleGroupIds array     array of UserRoleGroup IDs URISs Uri M
Page: UserRoleGroup
UserRoleGroup JSON Format Name Type Read-only Mandatory Comment id integer yes no   userRoleId integer no no UserRole.id http://UserRole.id groupid integer no yes Group.id http://Group.id active boolean no     backUpTechId integer     UserRoleGroup.id htt

V

Page: Vendor
Vendor JSON Format Name Type Read-only Mandatory Comment id integer yes no   name string no yes   contactName string no no   primaryPhone string no no   fax string       email string       notes string       street1 string       street2 string       city

W

X

Y

Z

Page: ZenAsset
JSON Format Name Type     Comment id integer       workstationId byte[]       deviceId byte[]       assetName string       assetType string       operatingSystem string       URIs URI Method Request Data Successful Response Comment /api/zen-assets GET   2

!@#$

  • No labels