cdp.audit.trail.list

The cdp.audit.trail.list command is used to acquire and return the audit trail history for changes made to a connection.

TR50 Request

{
  "cmd" : {
    "command": "cdp.audit.trail.list",
    "params": {
      "connectionId": "5b4c7c74000c48005914e01b",
      "limit": 20,
      "offset": 0,
      "sort": "+status"
    }
  }
}

Request Parameters

Name Type Required Description
connectionId String Yes The identifier of the connection.
limit Integer Limits the number of results returned. Defaults to the maximum configured size.
offset Integer The starting list offset, used for pagination. Defaults to 2000.
sort String sort is an optional parameter that defines the sort order of the result set. It allows to arrange the list in either ascending(+) or descending(-) order. It is possible to sort cdp.audit.trail.list in the following categories:
  • effectiveDate (default)
  • id
  • configId
  • priorValue
  • field
  • effectiveDate
  • status
  • userName

TR50 Response

If the command is sent successfully a success message and the data usage history is returned. Otherwise, an error and error message will be returned.

{
  "cmd": {
    "success": true,
    "params": {
      "count": 1,
      "records": {
        "id": "5e00c48b400001b5914c7c74",
        "configId": "5e00c4001b58b400914c7c74",
        "connectionId": "55914c7c74e00c48b400001b",
        "field": "IMEI Tech Type",
        "priorValue": "2G",
        "value": "2G",
        "effectiveDate": "2015-06-24T19:58:28.312Z",
        "status": "Executed",
        "userName": "batchUser"
      }
    }
  }
}

Response Parameters

Name Type Description
count Integer The total number of matching records.
records Array The array of records

Records Array Object

Name Type Description
id String The identifier of the record.
configId String The identifier of the cdp configuration.
connectionId String The identifier of the connection.
field String The field that was affected.
priorValue String The previous value of that field
value String The affected value of that field.
effectiveDate Timestamp The date of the field's effect.
status String The status of the effect.
userName String The username associated with the effect.
delegatedUser String The delegated user associated with the effect.