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.
Select category  

Select function  

Function Details
Name Guid Required Description
SaveTaskStatus True Creates a task status if no TaskStatusId is specified or updates an existing task status when a valid TaskStatusId is specified. You must be a project manager or an administrator to access this function.

Code Sample (Visual Basic, Dotnet Framework 4.x): 
Public Class Sample
	
	Public Sub CodeSample_savetaskstatus()
		Dim params = New NameValueCollection From {
					{"fct", "savetaskstatus"},
					{"guid", "###"},
					{"projectid", "NULL"},
					{"taskstatusid", "NULL"},
					{"taskstatusname", "NULL"},
					{"completedstatus", "NULL"}
		}

		Dim jsonText = apiCall(params)

		' https://www.newtonsoft.com/json suggested for JSON parsing to DotNet framework 4.x
		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
		}

		' may be needed on some machines
		Net.ServicePointManager.SecurityProtocol = CType(Net.SecurityProtocolType.Tls12, Net.SecurityProtocolType)

		_param.Item("format") = "iso8601" ' json, with dates formatted as ISO8601 string

		Dim responseBytes = wc.UploadValues("https://api.aceproject.com", "POST", _param)
		Return System.Text.Encoding.UTF8.GetString(responseBytes)

	End Function

End Class

Parameter Details
Name DataType Is Nullable Max length Domain Values Default Value Is Required
(Insert)		 Is Required
(Update)		 Is Required Description
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.
PortfolioId Integer True NULL True
ProjectId Integer True NULL True False Auto-generated unique identifier of a project.
TaskStatusId Integer True NULL False True Auto-generated unique identifier of a task status.
TaskStatusName String True 50 NULL True False Unique name given to a task status. The name must be unique within the project.
TaskStatusDesc String True NULL False Describes any relevant task status information for the entry.
CompletedStatus Integer True 0: Waiting
1: Completed
2: In progress		 NULL True False Defines the type of status.
Myorder Decimal True NULL False Order number used for sorting related entries in lists.
IsDefault Boolean True True or False NULL False Indicates whether the entry is the default value selected in lists.
DefaultPercentDone Integer True 0 to 10 (meaning 0 to 100%) NULL False Default percentage done value to set for in progress status types on tasks upon selecting a task status. If task status type is waiting, the default is automatically 0. If the task status type is completed, the default is automatically 10.
Format String False RS: RecordSet
DS: DataSet
JSON: JSON		 DS True Return Format