http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/5521f214/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.rst.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.rst.txt deleted file mode 100644 index 67359e5..0000000 --- a/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.rst.txt +++ /dev/null @@ -1,456 +0,0 @@ -.. -.. -.. 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-v12-phys-loc: - -Physical Location -================= - -.. _to-api-v12-phys-loc-route: - -/api/1.2/phys_locations -+++++++++++++++++++++++ - -**GET /api/1.2/phys_locations** - - Authentication Required: Yes - - Role(s) Required: None - - **Request Query Parameters** - - +--------------+----------+---------------------------------------------+ - | Name | Required | Description | - +==============+==========+=============================================+ - | ``region`` | no | Filter by Region ID. | - +--------------+----------+---------------------------------------------+ - - **Response Properties** - - +----------------------+--------+------------------------------------------------+ - | Parameter | Type | Description | - +======================+========+================================================+ - |``address`` | string | | - +----------------------+--------+------------------------------------------------+ - |``city`` | string | | - +----------------------+--------+------------------------------------------------+ - |``comments`` | string | | - +----------------------+--------+------------------------------------------------+ - |``email`` | string | | - +----------------------+--------+------------------------------------------------+ - |``id`` | string | | - +----------------------+--------+------------------------------------------------+ - |``lastUpdated`` | string | | - +----------------------+--------+------------------------------------------------+ - |``name`` | string | | - +----------------------+--------+------------------------------------------------+ - |``phone`` | string | | - +----------------------+--------+------------------------------------------------+ - |``poc`` | string | | - +----------------------+--------+------------------------------------------------+ - |``region`` | string | | - +----------------------+--------+------------------------------------------------+ - |``regionId`` | string | | - +----------------------+--------+------------------------------------------------+ - |``shortName`` | string | | - +----------------------+--------+------------------------------------------------+ - |``state`` | string | | - +----------------------+--------+------------------------------------------------+ - |``zip`` | string | | - +----------------------+--------+------------------------------------------------+ - - **Response Example** :: - - { - "response": [ - { - "region": "Mile High", - "region": "4", - "poc": "Jane Doe", - "lastUpdated": "2014-10-02 08:22:43", - "name": "Albuquerque", - "comments": "Albuquerque", - "phone": "(123) 555-1111", - "state": "NM", - "email": "jane....@email.com", - "city": "Albuquerque", - "zip": "87107", - "id": "2", - "address": "123 East 3rd St", - "shortName": "Albuquerque" - }, - { - "region": "Mile High", - "region": "4", - "poc": "Jane Doe", - "lastUpdated": "2014-10-02 08:22:43", - "name": "Albuquerque", - "comments": "Albuquerque", - "phone": "(123) 555-1111", - "state": "NM", - "email": "jane....@email.com", - "city": "Albuquerque", - "zip": "87107", - "id": "2", - "address": "123 East 3rd St", - "shortName": "Albuquerque" - } - ] - } - -| - -**GET /api/1.2/phys_locations/trimmed.json** - - Authentication Required: Yes - - Role(s) Required: None - - **Response Properties** - - +----------------------+---------+------------------------------------------------+ - | Parameter | Type | Description | - +======================+=========+================================================+ - |``name`` | string | | - +----------------------+---------+------------------------------------------------+ - - **Response Example** :: - - { - "response": [ - { - "name": "Albuquerque" - }, - { - "name": "Ashburn" - } - ] - } - -| - - -**GET /api/1.2/phys_locations/:id** - - Authentication Required: Yes - - Role(s) Required: None - - **Request Route Parameters** - - +-----------+----------+---------------------------------------------+ - | Name | Required | Description | - +===========+==========+=============================================+ - | ``id`` | yes | Physical location ID. | - +-----------+----------+---------------------------------------------+ - - **Response Properties** - - +----------------------+--------+------------------------------------------------+ - | Parameter | Type | Description | - +======================+========+================================================+ - |``address`` | string | | - +----------------------+--------+------------------------------------------------+ - |``city`` | string | | - +----------------------+--------+------------------------------------------------+ - |``comments`` | string | | - +----------------------+--------+------------------------------------------------+ - |``email`` | string | | - +----------------------+--------+------------------------------------------------+ - |``id`` | string | | - +----------------------+--------+------------------------------------------------+ - |``lastUpdated`` | string | | - +----------------------+--------+------------------------------------------------+ - |``name`` | string | | - +----------------------+--------+------------------------------------------------+ - |``phone`` | string | | - +----------------------+--------+------------------------------------------------+ - |``poc`` | string | | - +----------------------+--------+------------------------------------------------+ - |``region`` | string | | - +----------------------+--------+------------------------------------------------+ - |``regionId`` | string | | - +----------------------+--------+------------------------------------------------+ - |``shortName`` | string | | - +----------------------+--------+------------------------------------------------+ - |``state`` | string | | - +----------------------+--------+------------------------------------------------+ - |``zip`` | string | | - +----------------------+--------+------------------------------------------------+ - - **Response Example** :: - - { - "response": [ - { - "region": "Mile High", - "region": "4", - "poc": "Jane Doe", - "lastUpdated": "2014-10-02 08:22:43", - "name": "Albuquerque", - "comments": "Albuquerque", - "phone": "(123) 555-1111", - "state": "NM", - "email": "jane....@email.com", - "city": "Albuquerque", - "zip": "87107", - "id": "2", - "address": "123 East 3rd St", - "shortName": "Albuquerque" - } - ] - } - -| - -**PUT /api/1.2/phys_locations/:id** - Update a physical location - - Authentication Required: Yes - - Role(s) Required: admin or oper - - **Request Route Parameters** - - +-------------------+----------+------------------------------------------------+ - | Name | Type | Description | - +===================+==========+================================================+ - | ``id`` | int | Physical location id. | - +-------------------+----------+------------------------------------------------+ - - **Request Properties** - - +-------------------+----------+------------------------------------------------+ - | Parameter | Required | Description | - +===================+==========+================================================+ - | ``address`` | yes | Physical location address. | - +-------------------+----------+------------------------------------------------+ - | ``city`` | yes | Physical location city. | - +-------------------+----------+------------------------------------------------+ - | ``comments`` | no | Physical location comments. | - +-------------------+----------+------------------------------------------------+ - | ``email`` | no | Physical location email. | - +-------------------+----------+------------------------------------------------+ - | ``name`` | yes | Physical location name. | - +-------------------+----------+------------------------------------------------+ - | ``phone`` | no | Physical location phone. | - +-------------------+----------+------------------------------------------------+ - | ``poc`` | no | Physical location point of contact. | - +-------------------+----------+------------------------------------------------+ - | ``regionId`` | no | Physical location region ID. | - +-------------------+----------+------------------------------------------------+ - | ``shortName`` | yes | Physical location short name. | - +-------------------+----------+------------------------------------------------+ - | ``state`` | yes | Physical location state. | - +-------------------+----------+------------------------------------------------+ - | ``zip`` | yes | Physical location zip. | - +-------------------+----------+------------------------------------------------+ - - **Request Example** :: - - { - "regionId": "1", - "poc": "Jane Doesssss", - "name": "Albuquerque", - "comments": "Albuquerque", - "phone": "(123) 555-1111", - "state": "NM", - "email": "jane....@email.com", - "city": "Albuquerque", - "zip": "87107", - "address": "123 East 9rd St", - "shortName": "Albuquerque" - } - -| - - - **Response Properties** - - +----------------------+--------+------------------------------------------------+ - | Parameter | Type | Description | - +======================+========+================================================+ - |``address`` | string | | - +----------------------+--------+------------------------------------------------+ - |``city`` | string | | - +----------------------+--------+------------------------------------------------+ - |``comments`` | string | | - +----------------------+--------+------------------------------------------------+ - |``email`` | string | | - +----------------------+--------+------------------------------------------------+ - |``id`` | string | | - +----------------------+--------+------------------------------------------------+ - |``lastUpdated`` | string | | - +----------------------+--------+------------------------------------------------+ - |``name`` | string | | - +----------------------+--------+------------------------------------------------+ - |``phone`` | string | | - +----------------------+--------+------------------------------------------------+ - |``poc`` | string | | - +----------------------+--------+------------------------------------------------+ - |``region`` | string | | - +----------------------+--------+------------------------------------------------+ - |``regionId`` | string | | - +----------------------+--------+------------------------------------------------+ - |``shortName`` | string | | - +----------------------+--------+------------------------------------------------+ - |``state`` | string | | - +----------------------+--------+------------------------------------------------+ - |``zip`` | string | | - +----------------------+--------+------------------------------------------------+ - - - **Response Example** :: - - { - "alerts": [ - { - "level": "success", - "text": "Physical location update was successful." - } - ], - "response": [ - { - "region": "Mile High", - "region": "4", - "poc": "Jane Doe", - "lastUpdated": "2014-10-02 08:22:43", - "name": "Albuquerque", - "comments": "Albuquerque", - "phone": "(123) 555-1111", - "state": "NM", - "email": "jane....@email.com", - "city": "Albuquerque", - "zip": "87107", - "id": "2", - "address": "123 East 3rd St", - "shortName": "Albuquerque" - } - ] - } - -| - - -**POST /api/1.2/regions/:region_name/phys_locations** - Create physical location. - - Authentication Required: Yes - - Role(s) Required: admin or oper - - region_name: the name of the region to create physical location into. - - **Request Route Parameters** - - +-----------------+----------+-----------------------------------+ - | Name | Required | Description | - +=================+==========+===================================+ - | ``region_name`` | yes | The name of the physical location | - +-----------------+----------+-----------------------------------+ - - **Request Properties** - - +-----------------+----------+---------------------------------------------------+ - | Parameter | Required | Description | - +=================+==========+===================================================+ - | ``name`` | yes | The name of the location | - +-----------------+----------+---------------------------------------------------+ - | ``shortName`` | yes | The short name of the location | - +-----------------+----------+---------------------------------------------------+ - | ``address`` | yes | | - +-----------------+----------+---------------------------------------------------+ - | ``city`` | yes | | - +-----------------+----------+---------------------------------------------------+ - | ``state`` | yes | | - +-----------------+----------+---------------------------------------------------+ - | ``zip`` | yes | | - +-----------------+----------+---------------------------------------------------+ - | ``phone`` | no | | - +-----------------+----------+---------------------------------------------------+ - | ``poc`` | no | Point of contact | - +-----------------+----------+---------------------------------------------------+ - | ``email`` | no | | - +-----------------+----------+---------------------------------------------------+ - | ``comments`` | no | | - +-----------------+----------+---------------------------------------------------+ - - **Request Example** :: - - { - "name" : "my physical location1", - "shortName" : "myphylocation1", - "address" : "", - "city" : "Shanghai", - "state": "SH", - "zip": "200000", - "comments": "this is physical location1" - } - -| - - **Response Properties** - - +-----------------+--------+---------------------------------------------------+ - | Parameter | Type | Description | - +=================+========+===================================================+ - | ``id`` | string | The id of the physical location created. | - +-----------------+--------+---------------------------------------------------+ - | ``name`` | string | The name of the location | - +-----------------+--------+---------------------------------------------------+ - | ``shortName`` | string | The short name of the location | - +-----------------+--------+---------------------------------------------------+ - | ``regionName`` | string | The region name the physical location belongs to. | - +-----------------+--------+---------------------------------------------------+ - | ``regionId`` | string | | - +-----------------+--------+---------------------------------------------------+ - | ``address`` | string | | - +-----------------+--------+---------------------------------------------------+ - | ``city`` | string | | - +-----------------+--------+---------------------------------------------------+ - | ``state`` | string | | - +-----------------+--------+---------------------------------------------------+ - | ``zip`` | string | | - +-----------------+--------+---------------------------------------------------+ - | ``phone`` | string | | - +-----------------+--------+---------------------------------------------------+ - | ``poc`` | string | Point of contact | - +-----------------+--------+---------------------------------------------------+ - | ``email`` | string | | - +-----------------+--------+---------------------------------------------------+ - | ``comments`` | string | | - +-----------------+--------+---------------------------------------------------+ - - **Response Example** :: - - { - "response": { - 'shortName': 'myphylocati', - 'regionName': 'myregion1', - 'name': 'my physical location1', - 'poc': '', - 'phone': '', - 'comments': 'this is physical location1', - 'state': 'SH', - 'email': '', - 'zip': '20000', - 'region_id': '20', - 'city': 'Shanghai', - 'address': '', - 'id': '200' - } - } - -|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/5521f214/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.txt b/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.txt new file mode 100644 index 0000000..67359e5 --- /dev/null +++ b/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.txt @@ -0,0 +1,456 @@ +.. +.. +.. 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-v12-phys-loc: + +Physical Location +================= + +.. _to-api-v12-phys-loc-route: + +/api/1.2/phys_locations ++++++++++++++++++++++++ + +**GET /api/1.2/phys_locations** + + Authentication Required: Yes + + Role(s) Required: None + + **Request Query Parameters** + + +--------------+----------+---------------------------------------------+ + | Name | Required | Description | + +==============+==========+=============================================+ + | ``region`` | no | Filter by Region ID. | + +--------------+----------+---------------------------------------------+ + + **Response Properties** + + +----------------------+--------+------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+================================================+ + |``address`` | string | | + +----------------------+--------+------------------------------------------------+ + |``city`` | string | | + +----------------------+--------+------------------------------------------------+ + |``comments`` | string | | + +----------------------+--------+------------------------------------------------+ + |``email`` | string | | + +----------------------+--------+------------------------------------------------+ + |``id`` | string | | + +----------------------+--------+------------------------------------------------+ + |``lastUpdated`` | string | | + +----------------------+--------+------------------------------------------------+ + |``name`` | string | | + +----------------------+--------+------------------------------------------------+ + |``phone`` | string | | + +----------------------+--------+------------------------------------------------+ + |``poc`` | string | | + +----------------------+--------+------------------------------------------------+ + |``region`` | string | | + +----------------------+--------+------------------------------------------------+ + |``regionId`` | string | | + +----------------------+--------+------------------------------------------------+ + |``shortName`` | string | | + +----------------------+--------+------------------------------------------------+ + |``state`` | string | | + +----------------------+--------+------------------------------------------------+ + |``zip`` | string | | + +----------------------+--------+------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "region": "Mile High", + "region": "4", + "poc": "Jane Doe", + "lastUpdated": "2014-10-02 08:22:43", + "name": "Albuquerque", + "comments": "Albuquerque", + "phone": "(123) 555-1111", + "state": "NM", + "email": "jane....@email.com", + "city": "Albuquerque", + "zip": "87107", + "id": "2", + "address": "123 East 3rd St", + "shortName": "Albuquerque" + }, + { + "region": "Mile High", + "region": "4", + "poc": "Jane Doe", + "lastUpdated": "2014-10-02 08:22:43", + "name": "Albuquerque", + "comments": "Albuquerque", + "phone": "(123) 555-1111", + "state": "NM", + "email": "jane....@email.com", + "city": "Albuquerque", + "zip": "87107", + "id": "2", + "address": "123 East 3rd St", + "shortName": "Albuquerque" + } + ] + } + +| + +**GET /api/1.2/phys_locations/trimmed.json** + + Authentication Required: Yes + + Role(s) Required: None + + **Response Properties** + + +----------------------+---------+------------------------------------------------+ + | Parameter | Type | Description | + +======================+=========+================================================+ + |``name`` | string | | + +----------------------+---------+------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "name": "Albuquerque" + }, + { + "name": "Ashburn" + } + ] + } + +| + + +**GET /api/1.2/phys_locations/:id** + + Authentication Required: Yes + + Role(s) Required: None + + **Request Route Parameters** + + +-----------+----------+---------------------------------------------+ + | Name | Required | Description | + +===========+==========+=============================================+ + | ``id`` | yes | Physical location ID. | + +-----------+----------+---------------------------------------------+ + + **Response Properties** + + +----------------------+--------+------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+================================================+ + |``address`` | string | | + +----------------------+--------+------------------------------------------------+ + |``city`` | string | | + +----------------------+--------+------------------------------------------------+ + |``comments`` | string | | + +----------------------+--------+------------------------------------------------+ + |``email`` | string | | + +----------------------+--------+------------------------------------------------+ + |``id`` | string | | + +----------------------+--------+------------------------------------------------+ + |``lastUpdated`` | string | | + +----------------------+--------+------------------------------------------------+ + |``name`` | string | | + +----------------------+--------+------------------------------------------------+ + |``phone`` | string | | + +----------------------+--------+------------------------------------------------+ + |``poc`` | string | | + +----------------------+--------+------------------------------------------------+ + |``region`` | string | | + +----------------------+--------+------------------------------------------------+ + |``regionId`` | string | | + +----------------------+--------+------------------------------------------------+ + |``shortName`` | string | | + +----------------------+--------+------------------------------------------------+ + |``state`` | string | | + +----------------------+--------+------------------------------------------------+ + |``zip`` | string | | + +----------------------+--------+------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "region": "Mile High", + "region": "4", + "poc": "Jane Doe", + "lastUpdated": "2014-10-02 08:22:43", + "name": "Albuquerque", + "comments": "Albuquerque", + "phone": "(123) 555-1111", + "state": "NM", + "email": "jane....@email.com", + "city": "Albuquerque", + "zip": "87107", + "id": "2", + "address": "123 East 3rd St", + "shortName": "Albuquerque" + } + ] + } + +| + +**PUT /api/1.2/phys_locations/:id** + Update a physical location + + Authentication Required: Yes + + Role(s) Required: admin or oper + + **Request Route Parameters** + + +-------------------+----------+------------------------------------------------+ + | Name | Type | Description | + +===================+==========+================================================+ + | ``id`` | int | Physical location id. | + +-------------------+----------+------------------------------------------------+ + + **Request Properties** + + +-------------------+----------+------------------------------------------------+ + | Parameter | Required | Description | + +===================+==========+================================================+ + | ``address`` | yes | Physical location address. | + +-------------------+----------+------------------------------------------------+ + | ``city`` | yes | Physical location city. | + +-------------------+----------+------------------------------------------------+ + | ``comments`` | no | Physical location comments. | + +-------------------+----------+------------------------------------------------+ + | ``email`` | no | Physical location email. | + +-------------------+----------+------------------------------------------------+ + | ``name`` | yes | Physical location name. | + +-------------------+----------+------------------------------------------------+ + | ``phone`` | no | Physical location phone. | + +-------------------+----------+------------------------------------------------+ + | ``poc`` | no | Physical location point of contact. | + +-------------------+----------+------------------------------------------------+ + | ``regionId`` | no | Physical location region ID. | + +-------------------+----------+------------------------------------------------+ + | ``shortName`` | yes | Physical location short name. | + +-------------------+----------+------------------------------------------------+ + | ``state`` | yes | Physical location state. | + +-------------------+----------+------------------------------------------------+ + | ``zip`` | yes | Physical location zip. | + +-------------------+----------+------------------------------------------------+ + + **Request Example** :: + + { + "regionId": "1", + "poc": "Jane Doesssss", + "name": "Albuquerque", + "comments": "Albuquerque", + "phone": "(123) 555-1111", + "state": "NM", + "email": "jane....@email.com", + "city": "Albuquerque", + "zip": "87107", + "address": "123 East 9rd St", + "shortName": "Albuquerque" + } + +| + + + **Response Properties** + + +----------------------+--------+------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+================================================+ + |``address`` | string | | + +----------------------+--------+------------------------------------------------+ + |``city`` | string | | + +----------------------+--------+------------------------------------------------+ + |``comments`` | string | | + +----------------------+--------+------------------------------------------------+ + |``email`` | string | | + +----------------------+--------+------------------------------------------------+ + |``id`` | string | | + +----------------------+--------+------------------------------------------------+ + |``lastUpdated`` | string | | + +----------------------+--------+------------------------------------------------+ + |``name`` | string | | + +----------------------+--------+------------------------------------------------+ + |``phone`` | string | | + +----------------------+--------+------------------------------------------------+ + |``poc`` | string | | + +----------------------+--------+------------------------------------------------+ + |``region`` | string | | + +----------------------+--------+------------------------------------------------+ + |``regionId`` | string | | + +----------------------+--------+------------------------------------------------+ + |``shortName`` | string | | + +----------------------+--------+------------------------------------------------+ + |``state`` | string | | + +----------------------+--------+------------------------------------------------+ + |``zip`` | string | | + +----------------------+--------+------------------------------------------------+ + + + **Response Example** :: + + { + "alerts": [ + { + "level": "success", + "text": "Physical location update was successful." + } + ], + "response": [ + { + "region": "Mile High", + "region": "4", + "poc": "Jane Doe", + "lastUpdated": "2014-10-02 08:22:43", + "name": "Albuquerque", + "comments": "Albuquerque", + "phone": "(123) 555-1111", + "state": "NM", + "email": "jane....@email.com", + "city": "Albuquerque", + "zip": "87107", + "id": "2", + "address": "123 East 3rd St", + "shortName": "Albuquerque" + } + ] + } + +| + + +**POST /api/1.2/regions/:region_name/phys_locations** + Create physical location. + + Authentication Required: Yes + + Role(s) Required: admin or oper + + region_name: the name of the region to create physical location into. + + **Request Route Parameters** + + +-----------------+----------+-----------------------------------+ + | Name | Required | Description | + +=================+==========+===================================+ + | ``region_name`` | yes | The name of the physical location | + +-----------------+----------+-----------------------------------+ + + **Request Properties** + + +-----------------+----------+---------------------------------------------------+ + | Parameter | Required | Description | + +=================+==========+===================================================+ + | ``name`` | yes | The name of the location | + +-----------------+----------+---------------------------------------------------+ + | ``shortName`` | yes | The short name of the location | + +-----------------+----------+---------------------------------------------------+ + | ``address`` | yes | | + +-----------------+----------+---------------------------------------------------+ + | ``city`` | yes | | + +-----------------+----------+---------------------------------------------------+ + | ``state`` | yes | | + +-----------------+----------+---------------------------------------------------+ + | ``zip`` | yes | | + +-----------------+----------+---------------------------------------------------+ + | ``phone`` | no | | + +-----------------+----------+---------------------------------------------------+ + | ``poc`` | no | Point of contact | + +-----------------+----------+---------------------------------------------------+ + | ``email`` | no | | + +-----------------+----------+---------------------------------------------------+ + | ``comments`` | no | | + +-----------------+----------+---------------------------------------------------+ + + **Request Example** :: + + { + "name" : "my physical location1", + "shortName" : "myphylocation1", + "address" : "", + "city" : "Shanghai", + "state": "SH", + "zip": "200000", + "comments": "this is physical location1" + } + +| + + **Response Properties** + + +-----------------+--------+---------------------------------------------------+ + | Parameter | Type | Description | + +=================+========+===================================================+ + | ``id`` | string | The id of the physical location created. | + +-----------------+--------+---------------------------------------------------+ + | ``name`` | string | The name of the location | + +-----------------+--------+---------------------------------------------------+ + | ``shortName`` | string | The short name of the location | + +-----------------+--------+---------------------------------------------------+ + | ``regionName`` | string | The region name the physical location belongs to. | + +-----------------+--------+---------------------------------------------------+ + | ``regionId`` | string | | + +-----------------+--------+---------------------------------------------------+ + | ``address`` | string | | + +-----------------+--------+---------------------------------------------------+ + | ``city`` | string | | + +-----------------+--------+---------------------------------------------------+ + | ``state`` | string | | + +-----------------+--------+---------------------------------------------------+ + | ``zip`` | string | | + +-----------------+--------+---------------------------------------------------+ + | ``phone`` | string | | + +-----------------+--------+---------------------------------------------------+ + | ``poc`` | string | Point of contact | + +-----------------+--------+---------------------------------------------------+ + | ``email`` | string | | + +-----------------+--------+---------------------------------------------------+ + | ``comments`` | string | | + +-----------------+--------+---------------------------------------------------+ + + **Response Example** :: + + { + "response": { + 'shortName': 'myphylocati', + 'regionName': 'myregion1', + 'name': 'my physical location1', + 'poc': '', + 'phone': '', + 'comments': 'this is physical location1', + 'state': 'SH', + 'email': '', + 'zip': '20000', + 'region_id': '20', + 'city': 'Shanghai', + 'address': '', + 'id': '200' + } + } + +| http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/5521f214/docs/latest/_sources/development/traffic_ops_api/v12/profile.rst.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/profile.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/profile.rst.txt deleted file mode 100644 index bec8f9f..0000000 --- a/docs/latest/_sources/development/traffic_ops_api/v12/profile.rst.txt +++ /dev/null @@ -1,357 +0,0 @@ -.. -.. -.. 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-v12-profile: - - -Profiles -======== - -.. _to-api-v12-profiles-route: - -/api/1.2/profiles -+++++++++++++++++ - -**GET /api/1.2/profiles** - - Authentication Required: Yes - - Role(s) Required: None - - **Request Query Parameters** - - +---------------+----------+----------------------------------------------------+ - | Name | Required | Description | - +===============+==========+====================================================+ - | ``param`` | no | Used to filter profiles by parameter. | - +---------------+----------+----------------------------------------------------+ - - **Response Properties** - - +-----------------+--------+----------------------------------------------------+ - | Parameter | Type | Description | - +=================+========+====================================================+ - | ``lastUpdated`` | array | The Time / Date this server entry was last updated | - +-----------------+--------+----------------------------------------------------+ - | ``name`` | string | The name for the profile | - +-----------------+--------+----------------------------------------------------+ - | ``id`` | string | Primary key | - +-----------------+--------+----------------------------------------------------+ - | ``description`` | string | The description for the profile | - +-----------------+--------+----------------------------------------------------+ - - **Response Example** :: - - { - "response": [ - { - "lastUpdated": "2012-10-08 19:34:45", - "name": "CCR_TOP", - "id": "8", - "description": "Content Router for top.foobar.net" - } - ] - } - -| - -**GET /api/1.2/profiles/trimmed** - - Authentication Required: Yes - - Role(s) Required: None - - **Response Properties** - - +-----------------+--------+----------------------------------------------------+ - | Parameter | Type | Description | - +=================+========+====================================================+ - | ``name`` | string | The name for the profile | - +-----------------+--------+----------------------------------------------------+ - - **Response Example** :: - - { - "response": [ - { - "name": "CCR_TOP" - } - ] - } - -| - -**GET /api/1.2/profiles/:id** - - Authentication Required: Yes - - Role(s) Required: None - - **Request Route Parameters** - - +-----------------+------------+------------------------------------------------+ - | Parameter | Required | Description | - +=================+============+================================================+ - | ``id`` | yes | The ID of the profile. | - +-----------------+------------+------------------------------------------------+ - - **Response Properties** - - +-----------------+--------+----------------------------------------------------+ - | Parameter | Type | Description | - +=================+========+====================================================+ - | ``lastUpdated`` | array | The Time / Date this server entry was last updated | - +-----------------+--------+----------------------------------------------------+ - | ``name`` | string | The name for the profile | - +-----------------+--------+----------------------------------------------------+ - | ``id`` | string | Primary key | - +-----------------+--------+----------------------------------------------------+ - | ``description`` | string | The description for the profile | - +-----------------+--------+----------------------------------------------------+ - - **Response Example** :: - - { - "response": [ - { - "lastUpdated": "2012-10-08 19:34:45", - "name": "CCR_TOP", - "id": "8", - "description": "Content Router for top.foobar.net" - } - ] - } - -| - - -**POST /api/1.2/profiles** - Create a new empty profile. - - Authentication Required: Yes - - Role(s) Required: admin or oper - - **Request Properties** - - +-----------------------+--------+----------------------------------------------------+ - | Parameter | Type | Description | - +=======================+========+====================================================+ - | ``name`` | string | The name of the new profile | - +-----------------------+--------+----------------------------------------------------+ - | ``description`` | string | new profile description | - +-----------------------+--------+----------------------------------------------------+ - - **Request Example** :: - - { - "name": "CCR_COPY", - "description": "CCR_COPY description", - } - -| - - **Response Properties** - - +-----------------------+--------+----------------------------------------------------+ - | Parameter | Type | Description | - +=======================+========+====================================================+ - | ``id`` | string | Id of the new profile | - +-----------------------+--------+----------------------------------------------------+ - | ``name`` | string | The name of the new profile | - +-----------------------+--------+----------------------------------------------------+ - | ``description`` | string | new profile description | - +-----------------------+--------+----------------------------------------------------+ - - **Response Example** :: - - { - "response": [ - { - "id": "66", - "name": "CCR_COPY", - "description": "CCR_COPY description", - } - ] - } - -| - -**POST /api/1.2/profiles/name/:profile_name/copy/:profile_copy_from** - Copy profile to a new profile. The new profile name must not exist. - - Authentication Required: Yes - - Role(s) Required: admin or oper - - **Request Route Parameters** - - +-----------------------+----------+-------------------------------+ - | Name | Required | Description | - +=======================+==========+===============================+ - | ``profile_name`` | yes | The name of profile to copy | - +-----------------------+----------+-------------------------------+ - | ``profile_copy_from`` | yes | The name of profile copy from | - +-----------------------+----------+-------------------------------+ - - - **Response Properties** - - +-----------------------+--------+----------------------------------------------------+ - | Parameter | Type | Description | - +=======================+========+====================================================+ - | ``id`` | string | Id of the new profile | - +-----------------------+--------+----------------------------------------------------+ - | ``name`` | string | The name of the new profile | - +-----------------------+--------+----------------------------------------------------+ - | ``profileCopyFrom`` | string | The name of profile to copy | - +-----------------------+--------+----------------------------------------------------+ - | ``idCopyFrom`` | string | The id of profile to copy | - +-----------------------+--------+----------------------------------------------------+ - | ``description`` | string | new profile's description (copied) | - +-----------------------+--------+----------------------------------------------------+ - - **Response Example** :: - - { - "response": [ - { - "id": "66", - "name": "CCR_COPY", - "profileCopyFrom": "CCR1", - "description": "CCR_COPY description", - "idCopyFrom": "3" - } - ] - } - -| - -**PUT /api/1.2/profiles/{:id}** - - Allows user to edit a profile. - - Authentication Required: Yes - - Role(s) Required: admin or oper - - **Request Route Parameters** - - +-----------------+----------+---------------------------------------------------+ - | Name | Required | Description | - +=================+==========+===================================================+ - | ``id`` | yes | profile id. | - +-----------------+----------+---------------------------------------------------+ - - **Request Properties** - - +-----------------+----------+---------------------------------------------------+ - | Parameter | Required | Description | - +=================+==========+===================================================+ - | ``name`` | yes | The new name for the profile. | - +-----------------+----------+---------------------------------------------------+ - | ``description`` | yes | The new description for the profile. | - +-----------------+----------+---------------------------------------------------+ - - **Request Example** :: - - { - "name": "CCR_UPDATE", - "description": "CCR_UPDATE description" - } - - **Response Properties** - - +------------------+--------+----------------------------------+ - | Parameter | Type | Description | - +==================+========+==================================+ - | ``response`` | | The updated profile info. | - +------------------+--------+----------------------------------+ - | ``>id`` | string | Profile id. | - +------------------+--------+----------------------------------+ - | ``>name`` | string | Profile name. | - +------------------+--------+----------------------------------+ - | ``>description`` | string | Profile description. | - +------------------+--------+----------------------------------+ - | ``alerts`` | array | A collection of alert messages. | - +------------------+--------+----------------------------------+ - | ``>level`` | string | success, info, warning or error. | - +------------------+--------+----------------------------------+ - | ``>text`` | string | Alert message. | - +------------------+--------+----------------------------------+ - | ``version`` | string | | - +------------------+--------+----------------------------------+ - - **Response Example** :: - - { - "response":{ - "id": "219", - "name": "CCR_UPDATE", - "description": "CCR_UPDATE description" - } - "alerts":[ - { - "level": "success", - "text": "Profile was updated: 219" - } - ] - } - -| - -**DELETE /api/1.2/profiles/{:id}** - - Allows user to delete a profile. - - Authentication Required: Yes - - Role(s) Required: admin or oper - - **Request Route Parameters** - - +-----------------+----------+----------------------------+ - | Name | Required | Description | - +=================+==========+============================+ - | ``id`` | yes | profile id. | - +-----------------+----------+----------------------------+ - - **Response Properties** - - +-------------+--------+----------------------------------+ - | Parameter | Type | Description | - +=============+========+==================================+ - | ``alerts`` | array | A collection of alert messages. | - +-------------+--------+----------------------------------+ - | ``>level`` | string | success, info, warning or error. | - +-------------+--------+----------------------------------+ - | ``>text`` | string | Alert message. | - +-------------+--------+----------------------------------+ - | ``version`` | string | | - +-------------+--------+----------------------------------+ - - **Response Example** :: - - { - "alerts": [ - { - "level": "success", - "text": "Profile was deleted." - } - ] - } - -| - http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/5521f214/docs/latest/_sources/development/traffic_ops_api/v12/profile.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/profile.txt b/docs/latest/_sources/development/traffic_ops_api/v12/profile.txt new file mode 100644 index 0000000..ae9fcda --- /dev/null +++ b/docs/latest/_sources/development/traffic_ops_api/v12/profile.txt @@ -0,0 +1,393 @@ +.. +.. +.. 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-v12-profile: + + +Profiles +======== + +.. _to-api-v12-profiles-route: + +/api/1.2/profiles ++++++++++++++++++ + +**GET /api/1.2/profiles** + + Authentication Required: Yes + + Role(s) Required: None + + **Request Query Parameters** + + +---------------+----------+----------------------------------------------------+ + | Name | Required | Description | + +===============+==========+====================================================+ + | ``param`` | no | Used to filter profiles by parameter ID. | + +---------------+----------+----------------------------------------------------+ + | ``cdn`` | no | Used to filter profiles by CDN ID. | + +---------------+----------+----------------------------------------------------+ + + **Response Properties** + + +-----------------+--------+----------------------------------------------------+ + | Parameter | Type | Description | + +=================+========+====================================================+ + | ``id`` | string | Primary key | + +-----------------+--------+----------------------------------------------------+ + | ``name`` | string | The name for the profile | + +-----------------+--------+----------------------------------------------------+ + | ``description`` | string | The description for the profile | + +-----------------+--------+----------------------------------------------------+ + | ``cdn`` | int | The CDN ID | + +-----------------+--------+----------------------------------------------------+ + | ``cdnName`` | string | The CDN name | + +-----------------+--------+----------------------------------------------------+ + | ``type`` | string | Profile type | + +-----------------+--------+----------------------------------------------------+ + | ``lastUpdated`` | array | The Time / Date this server entry was last updated | + +-----------------+--------+----------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "id": "8", + "name": "EDGE_27_PROFILE", + "description": "A profile with all the Foo parameters" + "cdn": 1 + "cdnName": "cdn1" + "type": "ATS_PROFILE" + "lastUpdated": "2012-10-08 19:34:45", + } + ] + } + +| + +**GET /api/1.2/profiles/trimmed** + + Authentication Required: Yes + + Role(s) Required: None + + **Response Properties** + + +-----------------+--------+----------------------------------------------------+ + | Parameter | Type | Description | + +=================+========+====================================================+ + | ``name`` | string | The name for the profile | + +-----------------+--------+----------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "name": "EDGE_27_PROFILE" + } + ] + } + +| + +**GET /api/1.2/profiles/:id** + + Authentication Required: Yes + + Role(s) Required: None + + **Request Route Parameters** + + +-----------------+------------+------------------------------------------------+ + | Parameter | Required | Description | + +=================+============+================================================+ + | ``id`` | yes | The ID of the profile. | + +-----------------+------------+------------------------------------------------+ + + **Response Properties** + + +-----------------+--------+----------------------------------------------------+ + | Parameter | Type | Description | + +=================+========+====================================================+ + | ``id`` | string | Primary key | + +-----------------+--------+----------------------------------------------------+ + | ``name`` | string | The name for the profile | + +-----------------+--------+----------------------------------------------------+ + | ``description`` | string | The description for the profile | + +-----------------+--------+----------------------------------------------------+ + | ``cdn`` | int | The CDN ID | + +-----------------+--------+----------------------------------------------------+ + | ``cdnName`` | string | The CDN name | + +-----------------+--------+----------------------------------------------------+ + | ``type`` | string | Profile type | + +-----------------+--------+----------------------------------------------------+ + | ``lastUpdated`` | array | The Time / Date this server entry was last updated | + +-----------------+--------+----------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "id": "8", + "name": "EDGE_27_PROFILE", + "description": "A profile with all the Foo parameters" + "cdn": 1 + "cdnName": "cdn1" + "type": "ATS_PROFILE" + "lastUpdated": "2012-10-08 19:34:45", + } + ] + } + +| + + +**POST /api/1.2/profiles** + Create a new empty profile. + + Authentication Required: Yes + + Role(s) Required: admin or oper + + **Request Properties** + + +-----------------------+--------+----------+-----------------------------------------+ + | Parameter | Type | Required | Description | + +=======================+========+==========+=========================================+ + | ``name`` | string | yes | Profile name | + +-----------------------+--------+----------+-----------------------------------------+ + | ``description`` | string | yes | Profile description | + +-----------------------+--------+----------+-----------------------------------------+ + | ``cdn`` | int | no | CDN ID | + +-----------------------+--------+----------+-----------------------------------------+ + | ``type`` | string | yes | Profile type | + +-----------------------+--------+----------+-----------------------------------------+ + + + **Request Example** :: + + { + "name": "EDGE_28_PROFILE", + "description": "EDGE_28_PROFILE description", + "cdn": 1, + "type": "ATS_PROFILE" + } + +| + + **Response Properties** + + +-----------------------+--------+----------------------------------------------------+ + | Parameter | Type | Description | + +=======================+========+====================================================+ + | ``id`` | string | Profile ID | + +-----------------------+--------+----------------------------------------------------+ + | ``name`` | string | Profile name | + +-----------------------+--------+----------------------------------------------------+ + | ``description`` | string | Profile description | + +-----------------------+--------+----------------------------------------------------+ + | ``cdn`` | int | CDN ID | + +-----------------------+--------+----------------------------------------------------+ + | ``type`` | string | Profile type | + +-----------------------+--------+----------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "id": "66", + "name": "EDGE_28_PROFILE", + "description": "EDGE_28_PROFILE description", + "cdn": 1, + "type": "ATS_PROFILE" + } + ] + } + +| + +**POST /api/1.2/profiles/name/:profile_name/copy/:profile_copy_from** + Copy profile to a new profile. The new profile name must not exist. + + Authentication Required: Yes + + Role(s) Required: admin or oper + + **Request Route Parameters** + + +-----------------------+----------+-------------------------------+ + | Name | Required | Description | + +=======================+==========+===============================+ + | ``profile_name`` | yes | The name of profile to copy | + +-----------------------+----------+-------------------------------+ + | ``profile_copy_from`` | yes | The name of profile copy from | + +-----------------------+----------+-------------------------------+ + + + **Response Properties** + + +-----------------------+--------+----------------------------------------------------+ + | Parameter | Type | Description | + +=======================+========+====================================================+ + | ``id`` | string | Id of the new profile | + +-----------------------+--------+----------------------------------------------------+ + | ``name`` | string | The name of the new profile | + +-----------------------+--------+----------------------------------------------------+ + | ``profileCopyFrom`` | string | The name of profile to copy | + +-----------------------+--------+----------------------------------------------------+ + | ``idCopyFrom`` | string | The id of profile to copy | + +-----------------------+--------+----------------------------------------------------+ + | ``description`` | string | new profile's description (copied) | + +-----------------------+--------+----------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "id": "66", + "name": "CCR_COPY", + "profileCopyFrom": "CCR1", + "description": "CCR_COPY description", + "idCopyFrom": "3" + } + ] + } + +| + +**PUT /api/1.2/profiles/{:id}** + + Allows user to edit a profile. + + Authentication Required: Yes + + Role(s) Required: admin or oper + + **Request Route Parameters** + + +-----------------+----------+---------------------------------------------------+ + | Name | Required | Description | + +=================+==========+===================================================+ + | ``id`` | yes | profile id. | + +-----------------+----------+---------------------------------------------------+ + + **Request Properties** + + +-----------------------+--------+----------+-----------------------------------------+ + | Parameter | Type | Required | Description | + +=======================+========+==========+=========================================+ + | ``name`` | string | yes | Profile name | + +-----------------------+--------+----------+-----------------------------------------+ + | ``description`` | string | yes | Profile description | + +-----------------------+--------+----------+-----------------------------------------+ + | ``cdn`` | int | no | CDN ID - must use the same ID as any | + | | | | servers assigned to the profile. | + +-----------------------+--------+----------+-----------------------------------------+ + | ``type`` | string | yes | Profile type | + +-----------------------+--------+----------+-----------------------------------------+ + + **Request Example** :: + + { + "name": "EDGE_28_PROFILE", + "description": "EDGE_28_PROFILE description", + "cdn": 1, + "type": "ATS_PROFILE" + } + + **Response Properties** + + +-----------------------+--------+----------------------------------------------------+ + | Parameter | Type | Description | + +=======================+========+====================================================+ + | ``id`` | string | Profile ID | + +-----------------------+--------+----------------------------------------------------+ + | ``name`` | string | Profile name | + +-----------------------+--------+----------------------------------------------------+ + | ``description`` | string | Profile description | + +-----------------------+--------+----------------------------------------------------+ + | ``cdn`` | int | CDN ID | + +-----------------------+--------+----------------------------------------------------+ + | ``type`` | string | Profile type | + +-----------------------+--------+----------------------------------------------------+ + + **Response Example** :: + + { + "response":{ + "id": "219", + "name": "EDGE_28_PROFILE", + "description": "EDGE_28_PROFILE description" + "cdn": 1 + "type": "ATS_PROFILE" + } + "alerts":[ + { + "level": "success", + "text": "Profile was updated: 219" + } + ] + } + +| + +**DELETE /api/1.2/profiles/{:id}** + + Allows user to delete a profile. + + Authentication Required: Yes + + Role(s) Required: admin or oper + + **Request Route Parameters** + + +-----------------+----------+----------------------------+ + | Name | Required | Description | + +=================+==========+============================+ + | ``id`` | yes | profile id. | + +-----------------+----------+----------------------------+ + + **Response Properties** + + +-------------+--------+----------------------------------+ + | Parameter | Type | Description | + +=============+========+==================================+ + | ``alerts`` | array | A collection of alert messages. | + +-------------+--------+----------------------------------+ + | ``>level`` | string | success, info, warning or error. | + +-------------+--------+----------------------------------+ + | ``>text`` | string | Alert message. | + +-------------+--------+----------------------------------+ + | ``version`` | string | | + +-------------+--------+----------------------------------+ + + **Response Example** :: + + { + "alerts": [ + { + "level": "success", + "text": "Profile was deleted." + } + ] + } + +| +
