Describe Schema: describe

Use the describe command to provide a description of the schema of the specified type.

Syntax

The syntax for this command is:

stcmd{Ex} describe {type}{.property} {-s "server specifier"} 
Parameter
Description
type
Specifies the StarTeam item type by name. Types are mutually exclusive.
type.property
The name of an enumerated property on the specified type. For example: Story.Tag. If type is specified without {.property} then all properties of the type are listed. When type.property is specified, and property is an enumerated property, then all the enumerated values of that enumerated property are listed.
-s

Identifies the StarTeam Server. The full syntax is: -s "userName:password@host:portNumber"

For example: -s "JMarsh:password@orion:49201"

If the user name is omitted, the current user name is used. The user name in the example is “JMarsh”.

If the password is omitted, the user is prompted to enter the password. The password in the example is “password”. If the host name is omitted, the default is localhost. The host name in the example is “orion”.

The port number is required. The default port number, 49201, is used in the example.

Example

The following example obtains a description of the Change Request schema for the specified address.

describe may be used in the context of a connect/disconnect, or the connection details may be specified in-line using -s.

stcmd connect user:password@host:port
stcmd describe ChangeRequest
stcmd disconnect
or
stcmd{Ex} describe ChangeRequest –s “user:password@host:port”