Master Data Business Entities | Log
The Log represents a log entry originated from a process with specific information such as the occurence date and time, logging level, etc. RESERVED FOR INTERNAL USE.
Overview
| URL | api/{tenantKey}/{orgKey}/businessCore/logs |
| Methods Supported | GET, POST |
All Operations
This service includes the following operations:
- GET:
- POST:
All Resources
This service uses the following resources:
All Enumerations
This service uses the following enumerations:
GET Logs
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See LogResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Logs (paged)
Returns a page of the list of all the entity records available.
The following elements are optional:
| page | (int) The index of the page of the list that should be returned. This is a query string parameter. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). This is a query string parameter. |
Response:
| When successful, the response body contains the list of records available. See LogResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Log by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body contains the entity record. See LogResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
GET Log by key
Returns the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| number | (int) Increment number of the log. |
Response:
| When successful, the response body contains the entity record. See LogResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
GET Print Log by identifier
Prints the specified entity record.
The following elements are required:
| id | (string) The record identifier. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 404 | NotFound. The specified resord does not exist. |
Resource URL:
GET Print Log by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| number | (int) Increment number of the log. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
GET Original Print LogOriginal by identifier
Prints the specified entity record.
The following elements are required:
| id | (string) The record identifier. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 404 | NotFound. The specified resord does not exist. |
Resource URL:
GET Original Print Log by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| number | (int) Increment number of the log. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
POST Bulk Insert Logs
Custom operation 'BulkInsertLogs'.
The following elements are required:
| logs | (List |
Response:
| When successful, the response body is empty. |
Resource URL:
Resources
LogResource
The following elements are required:
| number | (int) Increment number of the log. |
| company | (string) The company of the log. |
| sourceSchemaEntity | (string) The schema entity id that originated the log creation. |
The following elements are optional:
| dateTime | (DateTimeOffset) The date and time when the log occurred. |
| logLevel | (enum LogLevel) The log level is state of the log (1 - information, 2 - Warning, 3 - Error).
See LogLevel. |
| title | (string) The title of the log. |
| message | (string) The message of the log. |
| sourceId | (Guid) The entity id that originated the log creation. |
| sourceKey | (string) The entity key that originated the log creation. |