| .. |
| .. Copyright 2015 Comcast Cable Communications Management, LLC |
| .. |
| .. Licensed under the Apache License, Version 2.0 (the "License"); |
| .. you may not use this file except in compliance with the License. |
| .. You may obtain a copy of the License at |
| .. |
| .. http://www.apache.org/licenses/LICENSE-2.0 |
| .. |
| .. Unless required by applicable law or agreed to in writing, software |
| .. distributed under the License is distributed on an "AS IS" BASIS, |
| .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| .. See the License for the specific language governing permissions and |
| .. limitations under the License. |
| .. |
| |
| |
| .. _to-api-change-logs: |
| |
| Change Logs |
| =========== |
| |
| **GET /api/1.1/logs.json** |
| |
| **Response Properties** |
| |
| +-----------------+--------+--------------------------------------------------------------------------+ |
| | Parameter | Type | Description | |
| +=================+========+==========================================================================+ |
| | ``ticketNum`` | string | Optional field to cross reference with any bug tracking systems | |
| +-----------------+--------+--------------------------------------------------------------------------+ |
| | ``level`` | string | Log categories for each entry, examples: 'UICHANGE', 'OPER', 'APICHANGE'.| |
| +-----------------+--------+--------------------------------------------------------------------------+ |
| | ``lastUpdated`` | string | Local unique identifier for the Log | |
| +-----------------+--------+--------------------------------------------------------------------------+ |
| | ``user`` | string | Current user who made the change that was logged | |
| +-----------------+--------+--------------------------------------------------------------------------+ |
| | ``id`` | string | Local unique identifier for the Log entry | |
| +-----------------+--------+--------------------------------------------------------------------------+ |
| | ``message`` | string | Log detail about what occurred | |
| +-----------------+--------+--------------------------------------------------------------------------+ |
| |
| **Response Example** :: |
| |
| { |
| "response": [ |
| { |
| "ticketNum": null, |
| "level": "OPER", |
| "lastUpdated": "2015-02-04 22:59:13", |
| "user": "mtorlu9137e", |
| "id": "22661", |
| "message": "Snapshot CRConfig created." |
| }, |
| { |
| "ticketNum": null, |
| "level": "APICHANGE", |
| "lastUpdated": "2015-02-03 17:04:20", |
| "user": "admin", |
| "id": "22658", |
| "message": "Update server odol-atsec-nyc-23.kbaletown.net status=REPORTED" |
| }, |
| ], |
| "version": "1.1" |
| } |
| |
| | |
| |
| **GET /api/1.1/logs/:days/days.json** |
| |
| **Request Route Parameters** |
| |
| +----------+----------+-----------------+ |
| | Name | Required | Description | |
| +==========+==========+=================+ |
| | ``days`` | yes | Number of days. | |
| +----------+----------+-----------------+ |
| |
| **Response Properties** |
| |
| +----------------------+--------+------------------------------------------------+ |
| | Parameter | Type | Description | |
| +======================+========+================================================+ |
| |``ticketNum`` | string | | |
| +----------------------+--------+------------------------------------------------+ |
| |``level`` | string | | |
| +----------------------+--------+------------------------------------------------+ |
| |``lastUpdated`` | string | | |
| +----------------------+--------+------------------------------------------------+ |
| |``user`` | string | | |
| +----------------------+--------+------------------------------------------------+ |
| |``id`` | string | | |
| +----------------------+--------+------------------------------------------------+ |
| |``message`` | string | | |
| +----------------------+--------+------------------------------------------------+ |
| |
| **Response Example** :: |
| |
| { |
| "response": [ |
| { |
| "ticketNum": null, |
| "level": "OPER", |
| "lastUpdated": "2015-02-04 22:59:13", |
| "user": "mtorlu9137e", |
| "id": "22661", |
| "message": "Snapshot CRConfig created." |
| }, |
| { |
| "ticketNum": null, |
| "level": "APICHANGE", |
| "lastUpdated": "2015-02-03 17:04:20", |
| "user": "admin", |
| "id": "22658", |
| "message": "Update server odol-atsec-nyc-23.kabletown.net status=REPORTED" |
| } |
| ], |
| "version": "1.1" |
| } |
| |
| | |
| |
| **GET /api/1.1/logs/newcount.json** |
| |
| **Response Properties** |
| |
| +----------------------+--------+------------------------------------------------+ |
| | Parameter | Type | Description | |
| +======================+========+================================================+ |
| |``newLogcount`` | string | | |
| +----------------------+--------+------------------------------------------------+ |
| |
| |
| **Response Example** :: |
| |
| { |
| "response": { |
| "newLogcount": 0 |
| }, |
| "version": "1.1" |
| } |
| |