Share this page
ALM Site Administration API Type Library
Project Overview
Description
This is a COM type library containing the API for interacting with the ALM site data. It provides interfaces for performing in code many of the tasks that can be performed in the Site Administration user interface.
In this reference, the term coclass and the term object are the same. The usage depends on the programming language. Object is used by Visual Basic. Most other languages use the term coclass.
Classes
| Class Module | Description |
|---|---|
| SAapi | Application Lifecycle Management Site Administration Client |
Public Enumerations
| Enumeration | Description |
|---|---|
| ALM_LOGGING_LEVEL | Logging level types |
| ENUM_ALM_LOGGING_LEVEL | Logging level types |
| ENUM_SA_BOOLEANS | True/False constants. |
| ENUM_SA_COPY_OPTIONS | Flags for project copy options. |
| ENUM_SA_DB_TYPE_OPTIONS | Specifiers for database types. |
| ENUM_SA_DOMAIN_PROPERTY_OPTIONS | Specifiers for domain property fields. |
| ENUM_SA_PROJECT_CREATION_OPTIONS | Flags for project creation options. |
| ENUM_SA_PROJECT_PROPERTY_OPTIONS | Specifiers for project property fields. |
| ENUM_SA_PROJECT_UPGRADE_OPTIONS | Flags for project upgrade options. |
| ENUM_SA_SET_USER_PROPERTY_OPTIONS | Specifiers for user property fields. |
| SA_BOOLEANS | True/False constants. |
| SA_COPY_PROJECT_OPTIONS | Flags for project copy options. |
| SA_DB_TYPE_OPTIONS | Specifiers for database types. |
| SA_DOMAIN_PROPERTY_OPTIONS | Specifiers for domain property fields. |
| SA_PROJECT_CREATION_OPTIONS | Flags for project creation options. |
| SA_PROJECT_PROPERTY_OPTIONS | Specifiers for project property fields. |
| SA_PROJECT_UPGRADE_OPTIONS | Flags for project upgrade options. |
| SA_USER_PROPERTY_OPTIONS | Specifiers for user property fields. |
Remarks
The methods in this interface return COM errors. For details of the COM error structure, refer to the Microsoft documentation, Structure of COM Error Codes. The CODE segment of the structure contains the application-specific errors.
The following codes are returned in the CODE segment by the methods in this interface:
| Code | Error Description |
| 1001 | General Error |
| 1002 | No connection to domain server |
| 1003 | Error reading from XML |
| 1004 | The user name argument is empty |
| 1005 | The specified user is not defined in this site |
| 1006 | The site configuration parameter does not exist |
| 1007 | The property does not exist |
| 1008 | The action cannot be performed because the source project is active |
| 1009 | The action cannot be performed because the project is active |
| 1010 | The specified project is not defined in this site |
| 1011 | The action cannot be performed because the project version control status is already set |
| 1012 | The database property is not valid for this database type |
| 1013 | The logged on user is not authorized to perform this action |
| 1014 | This method is not implemented |
| 1015 | Missing an argument to the method |
| 1016 | Obsolete. Was: The project repository is not stored in the database |
