Agile Central - Portfolio Items: Custom Type Naming Best Practice

Document ID : KB000113749
Last Modified Date : 01/10/2018
Show Technical Document Details
Question:
Which portfolio item names should we avoid when creating a customer portfolio item type?
Answer:
Ideally, any name that corresponds to an existing WSAPI endpoint should be avoided.  When you create a new portfolio item type, it generates a new endpoint for the REST API which can cause conflicts with existing endpoints.

The following names and their plural variations (i.e.: Program and Programs) should be avoided:
  •   AllowedAttributeValue
  •   AllowedQueryOperator
  •   Artifact
  •   ArtifactNotification
  •   Attachment
  •   AttachmentContent
  •   AttributeDefinition
  •   Blocker
  •   Build
  •   BuildDefinition
  •   Change
  •   Changeset
  •   Connection
  •   ConversationPost
  •   CumulativeFlowData
  •   Defect
  •   DefectSuite
  •   DeliveryGroup
  •   DomainObject
  •   Expertise
  •   ExpertiseCapacity
  •   ExpertiseDemand
  •   Feature (ex. FeatureGroup, GroupFeature)
  •   FlowState
  •   HierarchicalRequirement
  •   Investment
  •   Iteration
  •   IterationCumulativeFlowData
  •   Milestone
  •   PersistableObject
  •   PortfolioItem
  •   PortfolioItem/Desk
  •   PortfolioItem/Feature
  •   PortfolioItem/Initiative
  •   PortfolioItem/Project
  •   PortfolioItemPredecessorRelationship
  •   PPMConnection
  •   Preference
  •   PreliminaryEstimate
  •   ProfileImage
  •   Program
  •   Project
  •   ProjectPermission
  •   PullRequest
  •   RankableArtifact
  •   RecycleBinEntry
  •   Release
  •   ReleaseCumulativeFlowData
  •   Requirement
  •   Revision
  •   RevisionHistory
  •   Risk
  •   SchedulableArtifact
  •   SCMRepository
  •   Scope
  •   ScopedAttributeDefinition
  •   Slice
  •   State
  •   Subscription
  •   Tag
  •   Task
  •   TestCase
  •   TestCaseResult
  •   TestCaseStep
  •   TestFolder
  •   TestSet
  •   TimeEntryItem
  •   TimeEntryValue
  •   TypeDefinition
  •   User
  •   UserIterationCapacity
  •   UserPermission
  •   UserProfile
  •   WebLinkDefinition
  •   Workspace
  •   WorkspaceConfiguration
  •   WorkspaceDomainObject
  •   WorkspacePermission
Additional Information:
Please be aware this list may not be exhaustive and the API is constantly evolving so new endpoints are occasionally created; additional names may be added later

See related KB Article: Excel Add-In - version: 2.4.4 and lower - Error importing Portfolio Items