Parameters
|
Required
|
Interdependent
|
Optional
|
|
|
|
|
|
CONTAINER_REF
|
|
|
|
|
|
|
|
|
|
|
|
|
GROUP_IN
|
|
|
GROUP_OUT
|
|
|
|
|
|
|
|
OBJECT_REF
|
|
|
|
|
|
|
|
|
STAGING_AREA
|
|
|
TYPE
|
|
|
WHERE
|
|
|
|
|
|
|
If a parameter is listed in the table but is not defined below, then it has a common parameter definition. For descriptions of those parameters, see Common Webject Parameters. |
CONTAINER_REF
A Windchill context to apply the webject against. This parameter accepts the following types of input:
• The UFID of a Windchill context. Multiple UFIDs can be specified for this parameter.
• MEMBERSHIP—The query finds only those contexts of which the user is a member.
When this parameter is specified, the scope of queries executed against the TYPE and WHERE parameters are restricted to the associated context.
GROUP_IN
The name of an input group containing one UFID per element (OBID attribute). This parameter is optional.
The output group of Query-Objects webject, querying some content holder objects, can be used as this input group.
GROUP_OUT
The name of the output group containing the results. If this parameter is omitted, then the name of the output group is constructed by appending the string “-Output” to the webject name. This parameter is optional.
OBJECT_REF
The Unique Federation Identifier (UFID) of the Windchill object from which to list contents.
Multiple values can be specified for this parameter. This parameter can be used instead of or in combination with WHERE and GROUP_IN. If neither WHERE nor GROUP_IN is specified, OBJECT_REF must be specified. Otherwise, you can also use STAGING_AREA.
STAGING_AREA
Specifies a relative path to a file directory located on a server where content items that have been previously staged are now located.
Use this parameter to return a list of previously staged content items rather than returning a list of content items associated with a specific content holder object. This parameter is mutually exclusive with the OBJECT_REF, TYPE, GROUP_IN, and WHERE parameters
If neither WHERE nor TYPE (or, alternatively, OBJECT_REF) are specified, then you can use STAGING_AREA to identify a directory to which content items have been previously uploaded using the Add-ContentItems webject. As a result, List-ContentItems returns an output group containing elements that provide identifiers for the previously staged content items.
Each element includes a source attribute specifying the name of the source file, and a staged_file_id attribute providing an identifier for the staged content item. You can later use this identifier in the STAGED_FILE_ID parameter of the Add-ContentItems webject to select staged items to transfer into the database, as well as in the Delete-ContentItems and Get-ContentItems webjects.
The STAGING_AREA parameter is enabled only when an administrator has defined the wt.adapter.stagingAreaRoot property, which identifies the root file directory path of the staging area. The value specified for the STAGING_AREA parameter is appended to this property to create an absolute file path to the directory in which staged content items are stored. The wt.adapter.stagingAreaRoot property can be set in the wt.properties file
The absolute path for the staged files is:
stagingAreaRoot/STAGING_AREA/username
• stagingAreaRoot is the value defined for the wt.adapter.stagingAreaRoot property.
• STAGING_AREA is the value specified for this parameter.
• username is the user name of the current user.
If the current user has one or more alternate user names, you cannot predict or control which alternate name is used to build the staging area directory path.
TYPE
The object type name. If WHERE is specified, TYPE must also be specified. For more information, see
Specifying the TYPE and WHERE Parameters.
WHERE
Aquery expression identifying the objects to be queried. This parameter can be used instead of or in combination with OBJECT_REF and GROUP_IN. If neither OBJECT_REF nor GROUP_IN is specified, WHERE must be specified. If WHERE is specified, then TYPE must also be specified. For additional information, see
Specifying the TYPE and WHERE Parameters.
