im types
displays a list of issue types
Synopsis
im types [--fields=field1[:width1],field2[:width2]...] [--fieldsDelim=value] [--height=value] [--width=value] [-x value] [-y value] [--user=name] [--hostname=server] [--password=password] [--port=number] [(-?|--usage)] [(-F file|--selectionFile=file)] [(-N|--no)] [(-Y|--yes)] [--[no]batch] [--cwd=directory] [--forceConfirm=[yes|no]] [(-F file|--selectionFile=file)] [--[no]asAdmin] [-g|--gui] [--settingsUI=[gui|default]] [--quiet] [--status=[none|gui|default]] type...
Description
im types displays a list of issue types. By default, all types are displayed.
Options
This command takes the universal options available to all
im commands, as well as some general options. See the
options reference page for descriptions.
• --fields=field1[:width1],field2[:width2]...
where fieldn can be any of the following:
◦ name
displays the name of the type. By default, only the name is shown.
◦ id
displays the database ID of the type. This is for PTC Technical Support only.
◦ description
displays a description of the type.
◦ defaultReferenceMode
displays the default reference mode if a document was branched. Reuse points to the same shared item until the original node changes and a new shared item is created.Share points to the same shared item as the original branched node. Editability is not allowed on shared fields; this mode only allows observation of the changes made on the other item.
displays the additional fields by type that, when edited, result in an update to the content revision.
◦ associatedType
displays the associated type for segments and nodes. If the document class is Segment, the associated type is a node. If it is node, the type is a shared item.
◦ image
displays whether or not there is an image for the type.
◦ fieldRelationships
displays the relationships between fields (CLI only).
◦ groupDocument
displays whether the segment item type can be used to group content.
◦ addLabel
displays whether or not users can add labels on the type.
◦ allowAttachments
displays whether or not to allow attachments for the type.
◦ allowChangePackages
displays whether or not the type allows change packages.
◦ backsProject
displays that this type backs a project.
◦ branch
displays whether branches exist for the type.
◦ branchEnabled
displays whether branching is allowed on the type for specific users or groups.
◦ canRelateToTestResult
displays whether the item type can be related to test results.
◦ copyTree
displays whether items of this type have had their trees copied (CLI only).
◦ copyTreeEnabled
displays whether issue trees can be copied for this type.
◦ copyFields
displays the list of fields to be copied by default for items of this type. Users can override these default fields by adding and removing any fields that they can view and edit.
◦ labelEnabled
displays whether labelling is allowed on the type for specific users or groups.
◦ deleteLabel
displays whether labels can be deleted for this type by specific users or groups.
◦ issueEditability
displays the issue editability for the type.
◦ mandatoryFields
displays the mandatory fields for the type (CLI only).
◦ modifyTestResultPolicy
displays the users or groups allowed to modify test results for the test session item type.
◦ versionEditFields
displays the fields that are configured as editable for document versions.
◦ visibleFields
displays the fields that are visible for the type (CLI only).
◦ stateTransitions
displays state transitions for this type (CLI only).
◦ systemManagedFields
displays fields with system managed visibility.
◦ testCaseResultFields
displays the fields on the test case item type that display in the test results.
◦ testRole
displays the test role for the type.
◦ testStepsEnabled
displays whether test steps are enabled for this type.
◦ typeClass
displays whether the associated types are a part of a document domain. Available type classes are segment, node, and shared item.
◦ createCPPolicy
displays the change package creation policy (CLI only).
◦ editPresentation
displays the presentation template name for editing an issue of this type (CLI only).
◦ notificationFields
displays a list of the fields to send on notification (CLI only).
◦ permittedAdministrators
displays the Type Administrators for this type (CLI only).
◦ permittedGroups
displays the groups that are permitted access to issues of this type (CLI only).
◦ phaseField
displays the names of the phase fields in the type's workflow.
◦ position
displays the sequential position of the type in the list of types.
◦ printPresentation
displays the presentation template for printing an issue of this type (CLI only).
◦ showHistory
displays whether or not the type shows the History tab in the Edit Issue view and Issue Detail view.
◦ showWorkflow
displays whether or not the type displays the Workflow tab in the Create Issue view, Edit Issue view, and Issue Detail view.
◦ timeTrackingEnabled
displays whether or not the type allows time entries.
◦ viewPresentation
displays the presentation template for viewing an issue of this type (CLI only).
◦ references
displays a list of object references.
◦ properties
displays properties defined for the type.
|
|
Fields or states containing overrides display regardless of whether the fields are visible or the states are included in the workflow.
|
◦ deleteItemEnabled
displays whether or not the type can be deleted by specific users or groups identified in the delete item rule.
◦ deleteItem
displays the delete item rule for the type.
◦ additionalContentLockFields
displays the list of additional content fields under the control of document locking.
◦ additionalLockFieldsRule
displays the rule that determines when additional fields (if allowed) are affected by locking.
◦ additionalSegmentLockFields
displays the list of additional segment fields under the control of document locking.
◦ allowAdditionalLockFields
displays whether or not document locking affect additional fields beyond the type's significant fields.
◦ allowDocumentLocks
displays whether or not document locking is enabled for the type.
◦ documentLockPolicy
displays the document locking policy for the type.
◦ documentUnlockGroup
displays the lock administration group for the type.
◦ lockingRequired
displays whether or not a document of this type must be locked before the fields affected by locking can be edited.
◦ lockingRequiredRule
displays the rule that determines when a document of this type must be locked before the appropriate fields can be edited.
◦ majorRevisionRule
displays the rule that controls when a user can increment the major revision for the item type.
◦ minorRevisionRule
displays the rule that controls when a user can increment the minor revision for the item type.
◦ defaultFieldsForWebUI
displays the list of default fields available for Document Workspace.
• --[no]asAdmin
allows non-admin access to types. This option is used specifically for third party integrations using the Windchill RV&S API. The default setting is --asAdmin which requires ViewAdmin permissions. Specifying --noasAdmin prevents user access to types. If a user attempts to view a type but does not have the applicable permissions they will receive a corresponding error message. Specifying im types --fields'', visibleFieldsForMe for a type displays permitted fields by user.
To learn more about the API, see your Windchill RV&S Integrations Builder Guide.
• --fieldsDelim=value
specifies the string to be used as a delimiter between fields displayed in the CLI.
• type...
specifies names of the types to display.
See Also
