FogBugz XML API: Creating

Overview:

Creating elements with the FogBugz API is very simple and powerful. Just follow the next steps to create any of the available elements.

Audience:

Customer Facing Information.

Step-By-Step Guide:

1. To create a new Project, send cmd=newProject. The following arguments are available:

• sProject
  • The title of the new project
• ixPersonPrimaryContact
• fAllowPublicSubmit
• fInbox – default 0
• Returns:
  • ixProject of the new project  

2. To create a new Area, send cmd=newArea. The following arguments are available:

• ixProject, sArea
  • The title of the new area
• ixPersonPrimaryContact
  • Use -1 for Project’s Primary Contact
• Returns:
  • ixProject of the new project

3. To create a new Person, send cmd=newPerson. The following arguments are available:

•  sEmail – required
• sFullname – required
• nType – default 0
  • Set to 0 for a normal user, 1 for an administrator, 2 for a community user, and 3 for a virtual user
• fActive – default 1
  • Use only when creating new person
• sPassword – default = random
• sLocale – optional
• sLanguage – optional
• sTimeZoneKey – optional
• sSnippetKey – optional
• fNotify – optional
• sPhone – optional
• sHomepage – optional
• fDeleted – optional
  • Set fDeleted to True to mark a user as Inactive (does not delete the user, or their history)
• Returns:
  • ixPerson of the new person  

4. To create a new Milestone, send cmd=newFixFor. The following arguments are available:

• ixProject – required
  • Set ixProject to -1 to create a global milestone
• sFixFor – required
  • The title of the new milestone
• dtRelease – optional
• dtStart – optional
• sStartNote – optional
• fAssignable – optional
• Returns:
  • ixFixFor of the new Milestone  

See also the full XML API documentation.