Get a List of Project Schedule Sheets
![]()
Description
This method will return a list of Schedule Sheets within a project/shell.
Support
This method can only list Schedule Sheets from projects/shells.
Installation: ASP and Self host
| Level | Yes or No |
|---|---|
| Company Level | No |
| Project/Shell Level | Yes |
Prototype
public XMLObject getScheduleSheetList(String shortname, String authcode, String projectnumber, String options);
Parameters
| Parameter | Description |
|---|---|
| shortname | Identifier of the company, company's short name |
| authcode | Authentication code for the company, in text string |
| projectnumber | Identifier of a project/shell. |
| options |
This parameter allows the user to filter the list based on the following: <status>: select a status of Active or Inactive. If no status is provided, all sheets are returned. <main_sheet>: Set to true or false to specify whether the master sheet is to only be returned. Setting true will return only the master schedule. <filter_condition>: two filter conditions are available; name and sheet_lock. The name is the name of the sheet and sheet_lock can have a value of true or false to only return locked schedule sheets. |
Return Value
See Appendix B: Return Values. Message will return list of Schedule Sheets based on filter condition.
Sample Method
getScheduleSheetList("acme", "acme_authcode", "P-000001", status=Active);