API Call Samples
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.
While TaskId and ProjectId are not required, at least one of them must be provided.
Select category
Select function
Function Details
Code Sample (Visual Basic, Dotnet Framework 4.x):
Public Class Sample
Public Sub CodeSample_getassigneduserlist()
Dim params = New NameValueCollection From {
{"fct", "getassigneduserlist"},
{"guid", "###"}
}
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
Parameter Details
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. |
TaskId |
Integer |
True |
|
|
NULL |
|
|
False |
Auto-generated unique identifier of a task. |
ProjectId |
Integer |
True |
|
|
NULL |
|
|
False |
Auto-generated unique identifier of a project. |
IsPmView |
Boolean |
False |
|
True or False |
False |
|
|
True |
|
IncludeInactivesUsers |
Boolean |
False |
|
True or False |
True |
|
|
True |
|
IncludeSystemUser |
Boolean |
False |
|
True or False |
False |
|
|
True |
|
OnlyCanOpenProject |
Boolean |
False |
|
True or False |
False |
|
|
True |
|
SortOrder |
String |
True |
|
|
NULL |
|
|
False |
Comma separated fields used for ordering a list. |
Format |
String |
False |
|
RS: RecordSet DS: DataSet JSON: JSON |
DS |
|
|
True |
Return Format |