GET api/projects?f_node={f_node}&start={start}&count={count}&includeSubs={includeSubs}&includeSubProjects={includeSubProjects}&includeLayout={includeLayout}&includeAccessLevel={includeAccessLevel}&orderBy={orderBy}&filterText={filterText}&filterBy={filterBy}&filterExact={filterExact}&projectName={projectName}&filterStatus={filterStatus}&viewID={viewID}&customFields={customFields}
Returns a list of Projects
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
f_node |
the unique id of the location to look for projects |
integer |
None. |
start |
The start index for the result set, used if are returning projects in pages etc. to limit result set |
integer |
None. |
count |
How many projects to return, note that this counts the parent projects so the total number including sub projects may be much higher. |
integer |
None. |
includeSubs |
Include projects that aren't at the top level when searching for a match |
boolean |
None. |
includeSubProjects |
Include all sub projects of matching projects |
boolean |
None. |
includeLayout |
Include the Layout information for this project type, milestones etc. |
boolean |
None. |
includeAccessLevel |
Return the level of access the current user has to this project |
boolean |
None. |
orderBy |
Order to return projects in, options are "item" (which is default and ordes by project name), "createdTime", "startDate" or "endDate" |
string |
None. |
filterText |
Limits projects to those which contain this text in the project name |
string |
None. |
filterBy |
The filterText will search this field when returning projects, name is default but a form field GUID can be supplied |
string |
None. |
filterExact |
If true, perform an exact search for filterText. If false, perform an 'includes' search. |
boolean |
None. |
projectName |
This is like the filterText except it looks for an exact match on the project name |
string |
None. |
filterStatus |
Limits projects to those with this status |
string |
None. |
viewID |
A view is setup in the Database and specifies the relevant columns to return, passing the view id will return the relevent columns to populate this view |
integer |
None. |
customFields |
List of custom fields to include in the result set, this will be added to the fields included in the view if a view was specified. This should be supplied in a specific JSON format |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of Dictionary of Object [key] and Object [value]Response Formats
application/json, text/json
Sample not available.