About the API log
Overview
The API log provides a detailed record of API requests and responses, helping you keep of track important actions that have been performed on Blueprint data.
The log is provided as a comma-separate file that lists each new entry on a new line. Here's an example of a single log entry:
Error, 02/10/2014 10:46:46, 191.161.21.31, admin, http://localhost:80/projects/83907/artifacts, POST, 401.1722, 500, Processing of the HTTP request resulted in an exception., System.Web.Http.HttpResponseException
Important: Depending on whether the log entry category is applicable to the action that occurred, the log entry field either contains data or is blank.
Here's an explanation of the data contained in each log entry, outlined in the order the columns appear:
| Log Entry Data | Description | Example |
|---|---|---|
| TypeOfEntry |
Indicates the type of action that occurred. Possible actions include:
|
Error |
| Date |
Indicates the date that the action was logged. |
05/23/2013 14:40:45 |
| SourceIp | Indicates the IP address of the user performing the request. | 191.161.21.31 |
| Username |
Indicates the user name of the user that performed the request. |
jsmith |
| UriRequest |
Indicates the URI that was used in the request. |
http://localhost:80/projects/83907/artifacts |
| HttpMethod |
Identifies the HTTP method that was performed. |
POST |
| ElapsedTime |
Indicates the amount of time (in milliseconds) that elapsed between the request and the response. |
401.1722 |
| Status Code |
Indicates the status code that appeared in response to the request. |
500 |
| Message | If a message appeared, this data indicates the response message that appeared. | Processing of the HTTP request resulted in an exception. |
| Exception |
If an exception occurred, this data indicates the type of exception that occurred. |
System.Web.Http.HttpResponseException |
Tasks
Downloading the Blueprint log zip file
