Resources for the REST API
This topic discusses the endpoints on a form.
Endpoints for entries on a form
Operation | Description | URL | HTTP method | Equivalent API call |
|---|---|---|---|---|
Returns the details of an entry on a form. | /entry/{formName}/{entryId} | GET | Get Entry | |
Returns the details of all the entries on a form. | /entry/{formName} | GET | Get List Entries With Fields | |
Returns an attachment for a particular entry or for the list of entries. | /entry/{formName}/{entryId}/attach/{fieldName} | GET | not applicable | |
Returns the list of associated entries for a particular entry. | /entry/{formName}/{entryId}/assoc/{associationName} | GET | not applicable | |
Returns the menu properties and its content. | /menu/{MenuName}?menu_criteria=criteria1,criteria2... | GET | Get Menu | |
Returns the expanded menu content in response. | /menu/expand | POST | Get expanded menu content | |
Creates new entry on the form. | /entry/{formName} | POST | Create Entry | |
Merges an existing entry into a form. | /mergeEntry/{formName} | POST | Merge entry | |
Updates a single entry on a form. | /entry/{formName}/{entryId} | PUT | Set Entry | |
Deletes an entry on a form. | /entry/{formName}/{entryId} | DELETE | Delete Entry |
Endpoints for fields on a form
Operation | Description | URL | HTTP method | Equivalent API call |
|---|---|---|---|---|
Returns information about field metadata for requested field. | /fields/{formName}/{fieldId} | GET | Get Field | |
Returns information about multiple fields metadata. | /fields/{formname} | GET | Get list of fields |
Common parameters for entry APIs
The following table explains the parameters commonly used in the REST operations:
Name | Description | Example |
|---|---|---|
fields | Returns parts of the entry object (fields and association links). You can use values() with a comma-separated list of field names inside the parentheses to return only those field values. You can use assoc to get links to all related entries. You can also use assoc() with a comma-separated list of association names inside the parenthesis to get links following those associations. | fields=values(Status,Notes) fields=assoc fields=assoc(Worklog,Testlog) fields=values(Status,Notes),assoc(WorkLog) |
q | Sends a search qualification. Use a URL-encoded value for the search qualification. | q=%27Submitter%27%20%3D%20%22Allen%22 %27Submitter%27%20%3D%20%22Allen%22 is the URL-encoded version of 'Submitter' = "Allen" to find entries that Allen has submitted. |
offset | Specifies the number (non-negative integer) of entries to offset the results by. Used for paginating results. | offset=50 Offsets the result by 50 entries |
limit | Specifies the number (non-negative integer) of entries to limit the results by. Used for paginating results. | limit=10 Gets no more than 10 entries |
expand | Expands the related entry (associations). You can use assoc() for every association that you want to expand or retrieve the related entries. | expand=assoc(association1)& expand=assoc(association2) Retrieves data related an entry with respect to association1 and association2. |
sort | Sorts results on a search by field name and direction. Multiple field names can be used, separated by commas. The direction is indicated by appending .asc for ascending and .desc for descending after the field name. | sort=Status.asc,Create Date.desc Sorts first by Status in ascending order and then by Create Date in descending order. |
option | Use in delete entry calls. Allowed values:
| options=NOCASCADE&options=FORCE |