4 Copyright © 2017 AT&T Intellectual Property. All rights reserved.
6 Licensed under the Creative Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except in compliance with the License.
8 You may obtain a copy of the License at
10 (https://creativecommons.org/licenses/by/4.0/)
12 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.
14 ECOMP and OpenECOMP are trademarks and service marks of AT&T Intellectual Property.
16 This document is best viewed with Firefox or Chrome. Nodes can be found by appending /#/definitions/node-type-to-find to the path to this document. Edge definitions can be found with the node definitions.
18 title: Active and Available Inventory Bulk REST APIs
21 url: http://www.apache.org/licenses/LICENSE-2.0.html
35 summary: Bulk add interface for multiple PUT operations in a single call with potentially multiple transactions
45 description: Response codes found in [response codes].
47 description: Below is the response for three sucessful transactions, each operation performed gets a status code
52 - uri: /network/pnfs/pnf/CGCIL21CRS-wr148d
56 - uri: /network/pnfs/pnf/CHCGILCLW6013000707--wr148d
60 - uri: /network/pnfs/pnf/CGCIL21CRS-wr148d/p-interfaces/p-interface/0-04-0-0-wr148d
63 - uri: /network/pnfs/pnf/CHCGILCLW6013000707--wr148d/p-interfaces/p-interface/9-2-7-1-wr148d
66 - uri: /network/pnfs/pnf/CHCGILCLW6013000707--wr148d/p-interfaces/p-interface/02-03-01-wr148d
69 - uri: /network/logical-links/logical-link/3001-S100EL-CHCGILCL08WCHCGILCLW60-wr148d
73 description: Below is the response for a single put transaction with two operations that failed, each operation gets its own status code and error message
78 - uri: /network/pnfs/pnf/CGCIL21CRS
80 '412': '{"requestError":{"serviceException":{"messageId":"SVC3000","text":"Invalid input performing %1 on %2 (msg=%3) (ec=%4)","variables":["PUT","/network/pnfs/pnf/CGCIL21CRS","Precondition Required:resource-version not passed for update of /network/pnfs/pnf/CGCIL21CRS","ERR.5.4.6130"]}}}'
81 - uri: /network/pnfs/pnf/CHCGILCLW6013000707-
83 '412': '{"requestError":{"serviceException":{"messageId":"SVC3000","text":"Invalid input performing %1 on %2 (msg=%3) (ec=%4)","variables":["PUT","/network/pnfs/pnf/CHCGILCLW6013000707-","Precondition Required:resource-version not passed for update of /network/pnfs/pnf/CHCGILCLW6013000707-","ERR.5.4.6130"]}}}'
86 description: Below is the response for when too many operations were attempted according to our limit
92 text: Invalid input performing %1 on %2 (msg=%3) (ec=%4)
96 - 'Payload Limit Reached, reduce payload:Payload limit of 30 reached, please reduce payload.'
101 description: an array of multiple "put" operations that include the associated A&AI URI for the put operation and corresponding body payload. Multiple PUT operations can be done within a single transaction or can be split into multiple transactions. A transaction's changes will not be committed to the database unless all operations within a single transaction succeed. Each transaction must include a "put" array including at least one set of "uri" and "body" parameters. The "uri" parameter designates the endpoint of the A&AI (C)RUD operation that will add the node/relationship, the "body" designates the payload that URI accepts to do so.
109 - uri: "/network/pnfs/pnf/CGCIL21CRS"
111 pnf-name: "CGCIL21CRS"
112 pnf-name2: "CHCGILCL08W13010309-"
113 equip-model: "CISCO_CRS1_C"
114 frame-id: "130103.09"
116 - uri: "/network/pnfs/pnf/CHCGILCLW6013000707-"
118 pnf-name: "CHCGILCLW6013000707-"
119 equip-model: "NSN_HIT7300_ROADM_C"
120 frame-id: "130007.07"
123 - uri: "/cloud-infrastructure/pservers/pserver/pserver-9876543210-111-wr148d"
125 hostname: "pserver-9876543210-111-wr148d"
126 fqdn: "pserver-9876543210-111-wr148d-fqdn"
127 - uri: "/cloud-infrastructure/pservers/pserver/pserver-9876543210-112-wr148d"
129 hostname: "pserver-9876543210-112-wr148d"
130 fqdn: "pserver-9876543210-112-wr148d-fqdn"
135 summary: Bulk process interface for multiple PUT, PATCH, and DELETE operations in a single call with potentially multiple transactions ( you cannot delete a node put or patched in the same request )
136 operationId: bulkProcess
145 description: Response codes found in [response codes]
147 description: Below is the response for three different transactions, a put transaction that had two operations within it, a patch transaction with two operations in it, and a delete transaction with two operations within it, all of these operation were successfully completed, each operation get a status code
152 - uri: /cloud-infrastructure/pservers/pserver/pserver5
155 - uri: /cloud-infrastructure/pservers/pserver/pserver6
159 - uri: /cloud-infrastructure/pservers/pserver/pserver6
162 - uri: /cloud-infrastructure/pservers/pserver/pserver5
166 - uri: /cloud-infrastructure/pservers/pserver/pserver3
169 - uri: /cloud-infrastructure/pservers/pserver/pserver4
173 description: Below is the response for a three different transactions, a put transaction that failed because the nodes were already there and no resource version was passed, patch succeeded for the two operations, delete failed as the nodes were already deleted so they couldn't be found. Each operation gets its own status code.
178 - uri: /cloud-infrastructure/pservers/pserver/pserver5
180 '412': '{"requestError":{"serviceException":{"messageId":"SVC3000","text":"Invalid inputperforming %1 on %2 (msg=%3) (ec=%4)","variables":["PUT","/cloud-infrastructure/pserver/pserver/pserver5","Precondition Required:resource-version not passed for update of/cloud-infrastructure/pservers/pserver/pserver5","ERR.5.4.6130"]}}}'
181 - uri: /cloud-infrastructure/pservers/pserver/pserver6
183 '412': '{"requestError":{"serviceException":{"messageId":"SVC3000","text":"Invalid inputperforming %1 on %2 (msg=%3) (ec=%4)","variables":["PUT","/cloud-infrastructure/pserver/pserver/pserver6","Precondition Required:resource-version not passed for update of/cloud-infrastructure/pservers/pserver/pserver6","ERR.5.4.6130"]}}}'
185 - uri: /cloud-infrastructure/pservers/pserver/pserver6
188 - uri: /cloud-infrastructure/pservers/pserver/pserver5
192 - uri: /cloud-infrastructure/pservers/pserver/pserver3
194 '404': '{"requestError":{"serviceException":{"messageId":"SVC3001","text":"Resource notfound for %1 using id %2 (msg=%3) (ec=%4)","variables":["DELETE","/cloud-infrastructur/pservers/pserver/pserver3","Node Not Found:No Node of type pserver found at: /clou-infrastructure/pservers/pserver/pserver3","ERR.5.4.6114"]}}}'
195 - uri: /cloud-infrastructure/pservers/pserver/pserver4
197 '404': '{"requestError":{"serviceException":{"messageId":"SVC3001","text":"Resource notfound for %1 using id %2 (msg=%3) (ec=%4)","variables":["DELETE","/cloud-infrastructur/pservers/pserver/pserver4","Node Not Found:No Node of type pserver found at: /clou-infrastructure/pservers/pserver/pserver4","ERR.5.4.6114"]}}}'
200 description: Below is the response for when too many operations were attempted according to our limit
206 text: Invalid input performing %1 on %2 (msg=%3) (ec=%4)
210 - 'Payload Limit Reached, reduce payload:Payload limit of 30 reached, please reduce payload.'
215 description: an array of multiple "put", "delete", and "patch" operations that include the associated A&AI URI for the operations and corresponding body payload. Multiple operations can be done within a single transaction or can be split into multiple transactions. A transaction's changes will not be committed to the database unless all operations within a single transaction succeed. Each transaction must include a "put", "patch", or "delete" array including at least one set of "uri" and "body" parameters. The "uri" parameter designates the endpoint of the A&AI CRUD operation that will update/delete the node/relationship, the "body" designates the payload that URI accepts to do so.
223 - uri: /cloud-infrastructure/pservers/pserver/pserver5
226 - uri: /cloud-infrastructure/pservers/pserver/pserver6
231 - uri: /cloud-infrastructure/pservers/pserver/pserver6
235 - uri: /cloud-infrastructure/pservers/pserver/pserver5
240 - uri: /cloud-infrastructure/pservers/pserver/pserver3?resource-version=1510168241235
242 - uri: /cloud-infrastructure/pservers/pserver/pserver4?resource-version=1510168252491