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
MoveOrCopyTask True Moves an existing task to another project or copies an existing task to the same or another project.

Code Sample (Visual Basic, Dotnet Framework 4.x): 
Public Class Sample
	
	Public Sub CodeSample_moveorcopytask()
		Dim params = New NameValueCollection From {
					{"fct", "moveorcopytask"},
					{"guid", "###"},
					{"fromprojectid", ###},
					{"fromtaskid", ###},
					{"toprojectid", ###},
					{"newtasknumber", ###},
					{"newstatusid", ###},
					{"newgroupid", ###},
					{"newtypeid", ###},
					{"newpriorityid", ###}
		}

		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.
FromProjectId Integer False True Unique identifier of a project where the task is from.
FromTaskId Integer False True Unique identifier of a task to move or copy.
ToProjectId Integer False True Unique identifier of a project where the task is to be moved or copied.
Move Boolean False True or False False True Indicates whether to move or copy the task. If true, the task will be moved. If false, the task will be copied.
NewTaskNumber Decimal False Greater or equal to 0 True Unique number given to the new task. The number must be unique within the destination project.
NewEstimatedStartDate DateTime True NULL False Estimated start date of the new task.
NewEstimatedEndDate DateTime True NULL False Estimated end date of the new task.
WeekendsAllowed Boolean False True or False False True
NewStatusId Integer False True Unique identifier of a task status for the new task from the destination project.
NewGroupId Integer False True Unique identifier of a task group for the new task from the destination project.
NewTypeId Integer False True Unique identifier of a task type for the new task from the destination project.
NewPriorityId Integer False True Unique identifier of a task priority for the new task from the destination project.
CopyComments Boolean False True or False False True When Move is false, this parameter indicates whether to copy task comments to the new task.
CopyTaskDocuments Boolean False True or False False True When Move is false, this parameter indicates whether to copy task documents to the new task.
CopyUserAssignments Boolean False True or False False True When Move is false, this parameter indicates whether to copy user assignments to the new task.
GetTaskInReturn Boolean False True or False False True
Format String False RS: RecordSet
DS: DataSet
JSON: JSON		 DS True Return Format