logo
Documentation Powered by ReDoc

Audit Log Management (2.08)

Download OpenAPI specification:Download

Audit Log Management Concepts

The AuditLogManagement API is a restful web service which allows end developers a way to integrate with IDI Billing Solutions and access audit/event log information that is generated by CostGuard Client as well as the CG Web APIs.

Authentication

SWT

Enter your token in the following format:

WRAP access_token="{mytoken}"
Security Scheme Type API Key
Header parameter name: Authorization

System Integrity

Resources related to system integrity.

Health Check

get /healthcheck
https://api.idibilling.com/AuditlogManagement/2x/{environment}/api/healthcheck

Use to check whether or not the AuditLogManagement service is up and running.

Authorizations:
SWT

Responses

200

Service is up and running.

Audit Log

Retrieve AuditLog

get /auditLog/{id}
https://api.idibilling.com/AuditlogManagement/2x/{environment}/api/auditLog/{id}

Retrieve a specific audit log record.

Authorizations:
SWT
path Parameters
id
required
number
Example: 1

Id of auditlog to retrieve.

header Parameters
Content-Type
required
string
Example: application/json

Responses

200
404

Unexpected error in API call. See HTTP response body for details.

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "application": "Customer WebService",
  • "auditLogID": 12345,
  • "description": "Customer 1234567890 Updated",
  • "entryDate": "1996-01-01T14:00:00.156Z",
  • "environment": "P_Prod",
  • "isRoot": true,
  • "logData": "Inserted New Record",
  • "logLevel": 1,
  • "nodeType": 1,
  • "objectID": 1234,
  • "objectKey": 1234567890,
  • "objectType": "Customer",
  • "operation": "ModifyCustomer",
  • "parentTreeNodeID": "Null:Null",
  • "treeID": "bf942102-60bf-49a6-8564-961199a8c82f",
  • "treeNodeID": "2018-07-30T04:00:00.000Z",
  • "username": "audit_user"
}

AuditLog Collection

get /auditLog
https://api.idibilling.com/AuditlogManagement/2x/{environment}/api/auditLog

Retrieve audit log information.

Note

Page Size

If no $top is specified, a default page size of 100 records per call will be used. The $top has a max page size of 500 records returned per call.

Filter Behavior

If $filter is not specified, only results within the last 24 hours will be returned.

If $filter does not contain an indexed field AND does not contain EntryDate, only results within the last 30 days will be returned.

Available Fields

The following is a list of important fields when filtering.

  • Indexed: ObjectId, (ObjectType & ObjectKey), TreeId, Username
  • Datetime: EntryDate
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
number
Example: $skip=10

Number of search results to skip.

$top
number
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
contentType
required
string
Example: application/json

Responses

200
404

Unexpected error in API call. See HTTP response body for details.

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "value":
    [
    ]
}

AuditLogOverview Collection

get /auditLogOverview
https://api.idibilling.com/AuditlogManagement/2x/{environment}/api/auditLogOverview

Retrieve audit log information along with additional records for related objects.

Note

Page Size

If no $top is specified, a default page size of 100 records per call will be used. The $top has a max page size of 500 records returned per call.

Filter Behavior

If $filter is not specified, only results within the last 24 hours will be returned.

If $filter does not contain an indexed field AND does not contain EntryDate, only results within the last 30 days will be returned.

Available Fields

The following is a list of important fields when filtering.

  • Indexed: ObjectId, (ObjectType & ObjectKey), TreeId, Username
  • Datetime: EntryDate
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
number
Example: $skip=10

Number of search results to skip.

$top
number
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
contentType
required
string
Example: application/json

Responses

200
404

Unexpected error in API call. See HTTP response body for details.

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "value":
    [
    ]
}

Object AuditLog Collection

get /object/{type}/{id}
https://api.idibilling.com/AuditlogManagement/2x/{environment}/api/object/{type}/{id}

Retrieve audit log records for a specific object.

Authorizations:
SWT
path Parameters
type
required
string
Example: 'Customer'

Type of object for which to retrieve audit log records.

id
required
number
Example: 1234

Id of the object.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
number
Example: $skip=10

Number of search results to skip.

$top
number
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
contentType
required
string
Example: application/json

Responses

200
404

Unexpected error in API call. See HTTP response body for details.

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "value":
    [
    ]
}

User AuditLog Collection

get /user/{username}
https://api.idibilling.com/AuditlogManagement/2x/{environment}/api/user/{username}

Retrieve audit log records for a specific user.

Authorizations:
SWT
path Parameters
username
required
string
Example: 'audit_user'

Username on the auditlog records to retrieve.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
number
Example: $skip=10

Number of search results to skip.

$top
number
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
contentType
required
string
Example: application/json

Responses

200
404

Unexpected error in API call. See HTTP response body for details.

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "value":
    [
    ]
}

Release Notes

Release Notes 2.08

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.07

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.06

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.05

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.04

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.03

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.02

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.01

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.00

  • Initial release of Audit Log Management API.