Axosoft Developer API (beta)

Current Version: Axosoft 17.0.0, API v6 (API v1 and v2 will be no longer supported after Axosoft 16.5.0)

SDK Migration

The Axosoft SDK methods are now replaced by the new API. If you are currently using the SDK, please refer to these conversion tables below to migrate your applications.

SDK to API Conversion Reference

AttachmentService
SDK Method Call Type API Method Notes
GetAttachmentsList GET /{item_type}/{id}/attachments/projects/{id}/attachments
GetByAttachmentId GET /attachments/{id}
AddAttachment POST /{item_type}/{id}/attachments
UpdateAttachment POST /attachments/{id}
DeleteAttachment DELETE /attachments/{id}
CustomerService
SDK Method Call Type API Method Notes
GetAllCustomers GET /customers
SearchCustomers GET /customers
GetAllCustomerContacts GET /contacts
GetAllCustomerContactsByCustomerId GET /contacts
GetCustomerByCustomerId GET /customers/{id}
GetCustomerContactByCustomerContactId GET /contacts/{id}
AddCustomer POST /customers
AddCustomerContact POST /contacts
UpdateCustomer POST /customers/{id}
UpdateCustomerContact POST /contacts/{id}
DeleteCustomer DELETE /customers/{id}
DeleteCustomerContact DELETE /contacts/{id}
GetRemainingCustomerPortalLicenses
EncryptPassword password is passed in along with the contact
HashPassword password is passed in along with the contact
VerifyPassword customers will be able to log in directly into the API
GetCustomerCustomFieldValuesList custom field values are returned in the object and no longer need to be retrieved separately when adding a new item
GetCustomerCustomFieldsList GET /fields/custom
GetCustomerContactCustomFieldValuesList custom field values are returned in the object and no longer need to be retrieved separately when adding a new item
GetCustomerContactCustomFieldsList GET /fields/custom
DefectService
SDK Method Call Type API Method Notes
AddDefect POST /defects
AddDefectWithNotification will no longer allow overriding notification settings
UpdateDefect POST /defects/{id}
UpdateDefectWithLock POST /defects/{id}
DeleteDefect DELETE /defects/{id}
DeleteDefectWithLock leave out for now, should be no need for locking item before delete
GetAllDefects GET /defects
GetDefectsByProject GET /defects
GetDefectsByRelease GET /defects
GetDefectsByReleaseAndProject GET /defects
GetDefectsByCustomer GET /defects
GetDefectsByCustomerAndProject GET /defects
GetDefectsByCustomerContact GET /defects
GetDefectsByCustomerContactAndProject GET /defects
GetDefectsByUser GET /defects
GetDefectsByUserAndProject GET /defects
GetByDefectId GET /defects/{id}
GetCustomFieldValuesList custom field values are returned in the object and no longer need to be retrieved separately when adding a new item
GetCustomFieldsList GET /fields/custom
AddChangeNotificationUser POST /defects/{id}/notifications
AddChangeNotificationCustomerContact POST /defects/{id}/notifications
AddChangeNotificationEmailAddress POST /defects/{id}/notifications
CastVote
EmailMessageService
SDK Method Call Type API Method Notes
GetEmailMessagesByItem GET /{item_type}/{id}/emails
GetByEmailMessageId GET /emails/{id}
AddEmailMessage POST /emails
UpdateEmailMessage email message cannot be updated
DeleteEmailMessage DELETE /emails/{id}
GetAllMailAccounts
SendEmail will no longer allow sending emails without adding them in Axosoft, use the add method
FeatureService
SDK Method Call Type API Method Notes
AddFeature POST /features
AddFeatureWithNotification will no longer allow overriding notification settings
UpdateFeature POST /features/{id}
UpdateFeatureWithLock POST /features/{id}
DeleteFeature DELETE /features/{id}
DeleteFeatureWithLock leave out for now, should be no need for locking item before delete
GetAllFeatures GET /features
GetFeaturesByProject GET /features
GetFeaturesByRelease GET /features
GetFeaturesByReleaseAndProject GET /features
GetFeaturesByCustomer GET /features
GetFeaturesByCustomerAndProject GET /features
GetFeaturesByCustomerContact GET /features
GetFeaturesByCustomerContactAndProject GET /features
GetFeaturesByUser GET /features
GetFeaturesByUserAndProject GET /features
GetByFeatureId GET /features/{id}
GetCustomFieldValuesList custom field values are returned in the object and no longer need to be retrieved separately when adding a new item
GetCustomFieldsList GET /fields/custom
AddChangeNotificationUser POST /features/{id}/notifications
AddChangeNotificationCustomerContact POST /features/{id}/notifications
AddChangeNotificationEmailAddress POST /features/{id}/notifications
CastVote
HistoryService
SDK Method Call Type API Method Notes
GetHistoryForDateRange not supported currently
IncidentService
SDK Method Call Type API Method Notes
AddIncident POST /incidents
AddIncidentWithNotification will no longer allow overriding notification settings
UpdateIncident POST /incidents/{id}
UpdateIncidentWithLock POST /incidents/{id}
DeleteIncident DELETE /incidents/{id}
DeleteIncidentWithLock leave out for now, should be no need for locking item before delete
GetAllIncidents GET /incidents
GetIncidentsByProject GET /incidents
GetIncidentsByRelease GET /incidents
GetIncidentsByReleaseAndProject GET /incidents
GetIncidentsByCustomer GET /incidents
GetIncidentsByCustomerAndProject GET /incidents
GetIncidentsByCustomerContact GET /incidents
GetIncidentsByCustomerContactAndProject GET /incidents
GetIncidentsByUser GET /incidents
GetIncidentsByUserAndProject GET /incidents
GetByIncidentId GET /incidents/{id}
GetCustomFieldValuesList custom field values are returned in the object and no longer need to be retrieved separately when adding a new item
GetCustomFieldsList GET /fields/custom
AddChangeNotificationUser POST /incidents/{id}/notifications
AddChangeNotificationCustomerContact POST /incidents/{id}/notifications
AddChangeNotificationEmailAddress POST /incidents/{id}/notifications
CastVote
ItemRelationService
SDK Method Call Type API Method Notes
GetItemRelationsByItem GET /{item_type}/{id}/item_relations
GetByItemRelationId GET /item_relations/{id}
AddItemRelation POST /item_relations
UpdateItemRelation POST /item_relations/{id}
DeleteItemRelation DELETE /item_relations/{id}
LockService
SDK Method Call Type API Method Notes
GetLockTimeout will be returned with the lock when lock is acquired
AcquireLock
RefreshLock
ReleaseLock
PickListService
SDK Method Call Type API Method Notes
GetByPickListId GET /picklists/custom/{id}
GetPickLists GET /picklists/custom
GetValuesByPickListId GET /picklists/custom/{id}
ProjectService
SDK Method Call Type API Method Notes
GetAllProjects GET /projects
GetByProjectId GET /projects/{id}
AddProject POST /projects
UpdateProject POST /projects/{id}
DeleteProject DELETE /projects/{id}
GetCustomerCustomFieldValuesList custom field values are returned in the object and no longer need to be retrieved separately when adding a new item
GetCustomFieldsList GET /fields/custom
ReleaseService
SDK Method Call Type API Method Notes
GetAllReleases GET /releases
GetByReleaseId GET /releases/{id}
AddRelease POST /releases
UpdateRelease POST /releases/{id}
DeleteRelease DELTE /releases/{id}
TaskService
SDK Method Call Type API Method Notes
AddTask POST /tasks
AddTaskWithNotification will no longer allow overriding notification settings
UpdateTask POST /tasks/{id}
UpdateTaskWithLock POST /tasks/{id}
DeleteTask DELETE /tasks/{id}
DeleteTaskWithLock leave out for now, should be no need for locking item before delete
GetAllPublicTasks GET /tasks
GetPublicTasksByProject GET /tasks
GetTasksByRelease GET /tasks
GetTasksByReleaseAndProject GET /tasks
GetPublicTasksByUser GET /tasks
GetPublicTasksByUserAndProject GET /tasks
GetByTaskId GET /tasks/{id}
GetCustomFieldValuesList custom field values are returned in the object and no longer need to be retrieved separately when adding a new item
GetCustomFieldsList GET /fields/custom
AddChangeNotificationUser POST /tasks/{id}/notifications
AddChangeNotificationCustomerContact POST /tasks/{id}/notifications
AddChangeNotificationEmailAddress POST /tasks/{id}/notifications
CastVote
TypeService
SDK Method Call Type API Method Notes
GetStatusTypes GET /picklists/status
GetSeverityTypes GET /picklists/severity
GetPriorityTypes GET /picklists/priority
GetCategoryTypes GET /picklists/category
GetCategoryTypesByOwner categories by user not supported anymore
GetTimeUnitTypes GET /picklists/time_units
GetItemRelationTypes GET /picklists/
GetWorkLogTypes GET /picklists/worklog_types
GetReleaseTypes GET /picklists/release_types
GetReleaseStatusTypes GET /picklists/release_status
GetReleaseStatusTypesByReleaseType use the release_status api to get all
UserService
SDK Method Call Type API Method Notes
GetUserNames GET /users
GetAllUsers GET /users
GetByUserId GET /users/{id}
AddUser POST /users
UpdateUser POST /users/{id}
DeleteUser DELETE /users/{id}
HashPassword password is passed in along with the user
VerifyPassword password is passed in along with the user
GetUserSecurityRoles GET /users/{id}
SetUserSecurityRoles POST /users/{id}
GetSecurityRoles GET /security_roles
WorkflowService
SDK Method Call Type API Method Notes
GetWorkflowsByType GET /workflows
GetByWorkflowId GET /workflows/{id}
GetStepsByWorkflowId GET /workflows/{id}
GetByWorkflowStepId GET /workflow_steps/{id}
WorkLogService
SDK Method Call Type API Method Notes
GetWorkLogsByItem GET /work_logs
GetByWorkLogId GET /work_logs/{id}
AddWorkLog POST /work_logs
UpdateWorkLog POST /work_logs/{id}
DeleteWorkLog DELETE /work_logs/{id}