We reserve the right to log and verify your API calls and to contact you if we detect abuse on your part. For example:
- the requests takes too long to return
- the requests return too much data at a time
- The requests are too frequent
We strongly suggest using the date filter parameters to return only the data that is relevant.
Public Class Sample
Public Sub CodeSample_getprojects()
Dim params = New NameValueCollection From {
{"fct", "getprojects"},
{"guid", "###"},
{"pagenumber", 1},
{"rowsperpage", 100}
}
Dim jsonText = apiCall(params)
Dim jsonObj = Newtonsoft.Json.Linq.JObject.Parse(jsonText)
Dim success = jsonObj.Item("status").ToString <> "fail"
Dim jResults = DirectCast(jsonObj.Item("results"), Newtonsoft.Json.Linq.JArray)
End Sub
Function apiCall(_param As NameValueCollection) As String
Dim wc As New System.Net.WebClient With {
.Encoding = System.Text.Encoding.UTF8
}
Net.ServicePointManager.SecurityProtocol = CType(Net.SecurityProtocolType.Tls12, Net.SecurityProtocolType)
_param.Item("format") = "iso8601"
Dim responseBytes = wc.UploadValues("https://api.aceproject.com", "POST", _param)
Return System.Text.Encoding.UTF8.GetString(responseBytes)
End Function
End Class
Guid |
String |
False |
|
|
|
|
|
True |
Unique identifier for the authenticated user. The GUID has an expiry date and time which is managed automatically by the API. |
Projectid |
String |
True |
|
|
NULL |
|
|
False |
Auto-generated unique identifier of a project. |
PortfolioId |
Integer |
True |
|
|
NULL |
|
|
False |
Unique identifier of a Portfolio. |
Filterprojectstatusid |
Integer |
True |
|
|
NULL |
|
|
True |
|
IsGroupingProjectStatus |
Boolean |
True |
|
True or False |
NULL |
|
|
True |
|
Filterprojecttypeid |
Integer |
True |
|
|
NULL |
|
|
False |
Unique identifier of a project type to filter on. |
Filterprojectpriorityid |
Integer |
True |
|
|
NULL |
|
|
False |
Unique identifier of a project priority to filter on. |
Filtercompletedproject |
Boolean |
True |
|
True or False |
NULL |
|
|
False |
Indicates whether to filter on project status (completed, incomplete or all) |
Filterclientid |
Integer |
True |
|
|
NULL |
|
|
False |
Unique identifier of a project's client to filter on. |
ProjectTemplate |
String |
True |
|
|
NULL |
|
|
True |
|
Filtercreatoruserid |
Integer |
True |
|
|
NULL |
|
|
False |
Unique identifier of a user to filter on creators. |
Filterassigneduserid |
Integer |
True |
|
|
NULL |
|
|
False |
Unique identifier of a user to filter on assignees. |
Filtermarkedonly |
String |
False |
|
|
False |
|
|
True |
Filter list based on marked by the calling user. |
FilterFirstDate |
String |
True |
|
|
NULL |
|
|
True |
|
FilterFirstDateOperator |
Integer |
True |
|
|
NULL |
|
|
True |
|
FilterFirstDateValue |
Date |
True |
|
|
NULL |
|
|
True |
|
FilterSecondDate |
String |
True |
|
|
NULL |
|
|
True |
|
FilterSecondDateOperator |
Integer |
True |
|
|
NULL |
|
|
True |
|
FilterSecondDateValue |
Date |
True |
|
|
NULL |
|
|
True |
|
Texttosearch |
String |
True |
|
|
NULL |
|
|
False |
Search list based on specified text |
SortOrder |
String |
True |
|
|
NULL |
|
|
False |
Comma separated fields used for ordering a list. |
Useshowhide |
Boolean |
False |
|
True or False |
False |
|
|
True |
Indicates whether to use the calling user's Show/Hide settings to filter and sort data and to filter returned columns. |
Assignedonly |
Boolean |
False |
|
True or False |
False |
|
|
True |
Indicates whether to filter the list based on assigned project's only. This parameter is ignored if the calling user is not an administrator. Only assigned projects are returned for non administrators. |
Forgantt |
Boolean |
False |
|
True or False |
False |
|
|
True |
|
IsPmView |
Boolean |
True |
|
True or False |
NULL |
|
|
True |
|
OnlyProjectCanAddTask |
Boolean |
False |
|
True or False |
False |
|
|
True |
|
OnlyTimeApproval |
Boolean |
False |
|
True or False |
False |
|
|
True |
|
OnlyExpenseApproval |
Boolean |
False |
|
True or False |
False |
|
|
True |
|
OnlyCanOpenProject |
Boolean |
False |
|
True or False |
False |
|
|
True |
|
OnlyProjectManager |
Boolean |
False |
|
True or False |
False |
|
|
True |
|
ForCombo |
Boolean |
False |
|
True or False |
False |
|
|
False |
Indicates whether returns a simplified list to display drop-down list. |
PageNumber |
Integer |
True |
|
NULL or greater than 0 |
NULL |
|
|
False |
When the page number is not NULL, the API returns only the entries of the specified page within the list. A default rows per page is used within the API to determine pages if RowsPerPage parameter is not specified. |
RowsPerPage |
Integer |
True |
|
NULL or greater than 0 |
NULL |
|
|
False |
When the number of rows per page is NULL, the API uses the default value in the system. This parameter is used only when PageNumber has a value. |
Deletedprojects |
Boolean |
False |
|
True or False |
False |
|
|
True |
Indicates whether to filter on deleted projects. |
Format |
String |
False |
|
RS: RecordSet DS: DataSet JSON: JSON |
DS |
|
|
True |
Return Format |