Common API Parameters
- Enterprise IT
Owned by Enterprise IT
May 29, 2024
Loading data...
All SummitAI API Requests contain the following common parameters:
For API Key Based Authentication
Common Parameters
Parameter Name | Type | Description | Notes |
---|---|---|---|
AuthType | STRING | Type of Authentication. | Value should be APIKey. |
APIKey | STRING | APIKey that is generated that is described in API Authentication and Authorization section. | |
ProxyID | INTEGER | Unique Identification number of the proxy. | The value should be 0. |
ReturnType | STRING | Type of the request return. | For Example: Json, XML, YAML, etc. |
OrgID | INTEGER | Unique Identification of the Organization. | The value should be 1. |
TokenID | STRING | Number of the token whose details should come in Response. | The value should be empty. |
For Username and Password Based Authentication
Common Parameters
Parameter Name | Type | Description | Notes |
---|---|---|---|
UserName | STRING | Login name of the User. | |
Password | STRING | Login password of the User. | |
ProxyID | INTEGER | Unique Identification number of the proxy. | The value should be 0. |
ReturnType | STRING | Type of the request return. | For Example: Json, XML, YAML, etc. |
OrgID | INTEGER | Unique Identification of the Organization. | The value should be 1. |
TokenID | STRING | Number of the token whose details should come in Response. | The value should be empty. |
Confluence Cloud Migration Alert: Please refer to known issues you may encounter in Confluence Cloud: https://eitdocs.atlassian.net/wiki/x/wDGwAQ