Application & Process Automation
- Getting Started
- Common Usage Scenarios
- Troubleshooting
- Using Custom IDs
- API Method Reference
-
- GetPrograms
- GetForms
- GetFormSchema
- GetProjects
- GetProjectsByNumber
- GetProjectsByData
- CreateNewProject
- GetAllProjectData - Admin only
- GetProjectData
- SetProjectData
- GetActiveAttachment
- GetAttachmentAsAdmin – Admin only
- SetProjectAttachment
- SetAttachmentMetadata
- GetAttachmentMetadata
- SubmitProject
- GetStatusList – Admin only
- GetCustomListChoices
- GetProjectStatusHistory – Admin only
- SetProjectStatus – Admin only
- GetExportProject – Admin only
- CreateMfaSessionToken
- DeleteMfaSessionToken
- SetAssignee
- SetProjectOwner
- GetInquiryThreads – Admin Only
- GetNotesInInquiryThread – Admin Only
- SetInquiryNote – Admin Only
- SetInquiryThreadStatus – Admin Only
- SetInquiryThreadExternalId – Admin Only
- SetProjectStatusReportAs – Admin only
- Code Samples
V2 API Changes
All API Methods
– Namespace has been removed.
CreateNewProject
– `Project.Url.Value` has been moved to `Project.Url`
– `Project.Status` has been moved to `Project.CurrentStatus.Name`
– `Project.StatusTimestamp` has been moved to `Project.CurrentStatus.Timestamp`
– `Project.Forms[].Title` has been moved to `Project.Forms[].Name`
– New attribute `Project.ProjectNumber`
– New attribute `Project.CurrentStatus.StatusId`
– New attribute `Project.CurrentStatus.CustomId`
– Removed deprecated attribute `Project.Forms[].AvailableInStatuses[].Deleted`
– Removed deprecated attribute `Project.Forms[].LeadsToStatus`
SubmitProject
– `Project.Url.Value` has been moved to `Project.Url`
– `Project.Status` has been moved to `Project.CurrentStatus.Name`
– `Project.StatusTimestamp` has been moved to `Project.CurrentStatus.Timestamp`
– New attribute `Project.CurrentStatus.StatusId`
– New attribute `Project.CurrentStatus.CustomId`
GetProjectData
– Data field date values return in the format `yyyy-MM-dd` instead of `MM/dd/yyyy`
– Boolean values return `true`/`false` instead of `True`/`False`
– `Project.Url.Value` has been moved to `Project.Url`
– `Project.DataFields[].Instance` has been removed. Multi-instance data fields use a list of values `Project.DataFields[].Values[]` instead of displaying them separately.
– New attribute `Project.LastChangeTimestamp`
– New attribute `Project.CurrentStatus.CustomId`
– New attribute `Project.DataFields[].CustomId`
– New attribute `Project.Attachments[].CustomId`
SetProjectData Request
– Data field date values must be in the format `yyyy-MM-dd`
– Boolean values must be the format `true`/`false`
– Multi-instance data fields use a list of values `DataFields[].Values[]` instead of referencing the index via `DataFields[].InstanceId`
SetProjectData Response
– CalculatedFields has been removed
– Data field date values return in the format `yyyy-MM-dd` instead of `MM/dd/yyyy`
– Boolean values return `true`/`false` instead of `True`/`False`
– `Project.Url.Value` has been moved to `Project.Url`
– `Project.DataFields[].Instance` has been removed. Multi-instance data fields use a list of values `Project.DataFields[].Values[]` instead of displaying them separately.
– New attribute `Project.LastChangeTimestamp`
– New attribute `Project.CurrentStatus.CustomId`
– New attribute `Project.DataFields[].CustomId`
– New attribute `Project.Attachments[].CustomId`
GetProjects
– `Project.OwnerEmailAddress` has been moved to `Project.ProjectOwner.Email`
– `Project.ProjectOwner.Name` has been added.
– `Project.Status` has been moved to `Project.CurrentStatus.Name`
– `Project.StatusCustomId` has been moved to `Project.CurrentStatus.CustomId`
– `Project.StatusPublicId` has been moved to `Project.CurrentStatus.PublicId`
– `Project.StatusTimestamp` has been moved to `Project.CurrentStatus.Timestamp`