Get a List of Schedule Sheet Data Mappings
![]()
Description
This method will return a list of Data Mappings configured for a Schedule Sheet within a project/shell.
Support
This method can only list Data Mappings from Schedule Sheets within projects/shells.
Installation: ASP and Self host
| Level | Yes or No |
|---|---|
| Company Level | No |
| Project/Shell Level | Yes |
Prototype
public XMLObject getScheduleSheetDataMaps(String shortname, String authcode, String projectnumber, String sheetname, 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. |
| sheetname | Identifier of the schedule sheet within the project/shell. |
| options |
This parameter allows the user to filter the list based on the following: <datamap_name>: The name of a specific data mapping to be retrieved. <filter_condition>: one filter conditions is available; isdefault. If set to true only the data mapping flagged as the default will be returned. |
Return Value
See Appendix B: Return Values. Message will return list of Schedule Sheets based on filter condition.
Sample Method
getScheduleSheetDataMaps ("acme", "acme_authcode", "P-00001", "Master Schedule", isdefault=true);