Bulk import of Ownership Vouchers - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Bulk import of Ownership Vouchers","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/d1c072e8-3151-3b90-a574-d773df736b16","info":{"title":"Crosswork ZTP Service API","description":"Crosswork ZTP Service API for devices, profiles, serial numbers, and static routes. These APIs permit users to add, update, delete, query, and perform bulk CSV import/export of devices and device onboarding operations using ZTP services.","version":"7.1.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/ztp-service-api-overview.md"}},"openapi":"3.0.1","servers":[{"url":"/crosswork/ztp/v1"}],"securitySchemes":{"bearerAuth":{"description":"Security definitions details.","in":"header","name":"Authorization","type":"apiKey"}}},"spec":{"operationId":"ImportOwnershipVouchers","requestBody":{"content":{"application/json":{"schema":{"description":"Serial Number import object.","properties":{"b64Content":{"description":"base64 enc string of csv/tar file containing serial-numbers/ownership-vouchers","type":"string"},"fileName":{"description":"file name of csv/tar file","type":"string"},"isOverwrite":{"description":"either \"true\" or \"false\"","type":"string"}},"type":"object","$$ref":"#/components/schemas/cwztpsvcZtpSerialNumberImport"},"example":{"b64Content":"eyJ2b3VjaGVrLXlucHV0Ijp7InNlcmlhAC1udW1iZXIiOiIxIiwicGlubmVklWRvbwFpbi1jZXk0IjoiTUlJr1VqQ0NlRHFnQXdJQkFnSVJBLzk2WGt3eHJ2eitGRUh2VU4rZW8wd3dEUVlKS29aSWh2Y05BUUVMQlFBd2FERUxNQWtHQTFVRUJoTUNWVk14Q3pBSkJnTlZCQWdUQWtOQk1SRXdEd1lEVlFRSEV3aFRZVzRnU205elpURWFNQmdHQTFVRUNoTVJRMGxUUTA4Z1UxbFRWRVZOVXlCSlRrTXhIVEFiQmdOVkJBTVRGRnBVVUNCSmJuUmxjbTVoYkNCU2IyOTBJRU5CTUI0WERUSXlNRFV6TVRBM05UTXpPVm9YRFRJM01EVXpNREEzTlRNek9Wb3dhREVMTUFrR0ExVUVCaE1DVlZNeEN6QUpCZ05WQkFnVEFrTkJNUkV3RHdZRFZRUUhFd2hUWVc0Z1NtOXpaVEVhTUJnR0ExVUVDaE1SUTBsVFEwOGdVMWxUVkVWTlV5QkpUa014SFRBYkJnTlZCQU1URkZwVVVDQkpiblJsY201aGJDQlNiMjkwSUVOQk1JSUNJakFOQmdrcWhraUc5dzBCQVFFRkFBT0NBZzhBTUlJQ0NnS0NBZ0VBNENaSm1tbTRpRm5sSVd2N0RGQWNvOURER0FrQXVrRm9PanBObXZVQ3F0eXVrTTBQLzNJNmNMQ1lZVXk3Z3dnZ0pHaUZZR29Fam1NTjdiUm1NT2VydlFqT0JGdlpieXBKUjZBenpEaU9mTnJhUFNSYUp4N3J3Rkh6Sjd4VXdOdjY2d1I3d0VTa0hoWk9oSWkxQVVINFhnVE41dGQyTWRRZm5yRG9IZFNPRUdQMWtaVXdUK2FvZURkOGRtTmxrWnJCcHgxVlBsTnlWdjZmSzFzWVVSakFMRlZqNzRXNWczeklnZk5uU3ZmM2JLMmg1L2U5OGVFd044aXRXejdVNm9JSFhKMFdrQ0dkWmY2U2ZjaWJMbEtreEhaeDNlSFhWbzg4a2Q0bUducldkeHVQOEVJVDNEZUVEcTl0T3lBZWlvK24yQXNTa2RxZTlBTDJsVzNENmxGWkcxejRCZ1pNanRiV2pEN3ZsMHlwcnNuVkk5ak92UWRyajAyaWJka3FIYk43Zk00akNLSDJMdEp6M05hdVdQK2gvU2xPN1JMa2krMm1qUjZEeW9hR3FxUDFGcUFhQmJQTmsvSFg2ZEtLQVpIdGhuYTNia1pZd21LcTNaSmp0SlNZR3NuR05WRDRKNnlIZWM5c1hGMDdLMXJscTVtN2dKUFZsM0RXRW04TjhEK3E2K0htcksvazJGbmRYRjFzSTV2amdzSU9sMXZ1VGFrUDYzRlo3Y0dQcjBmQ0ZkVFRYNUNVZUIwYjJwRzJXNFVMR0V6aUQxMDg2b09lQjI1Qy9Ia0NUNnhudXVOZ1VxRnE0OHJUQTJuMlpEYS95T2FtSy9yS01lblcwdkpFYnJUNmhGQ2dic3oxemMyTldlNUxPZnQ3QmIrckpLay9SZEFhcGVTMUV5aThSeWNDQXdFQUFhT0I5akNCOHpBT0JnTlZIUThCQWY4RUJBTUNBWVl3SFFZRFZSMGxCQll3RkFZSUt3WUJCUVVIQXdJR0NDc0dBUVVGQndNQk1BOEdBMVVkRXdFQi93UUZNQU1CQWY4d0hRWURWUjBPQkJZRUZEUlJpZmRtNEJHSVdieW5DS1YrZUR5dnZEVkFNSUdSQmdOVkhSRUVnWWt3Z1lhQ0NrMWhibUZuWlcxbGJuU0NCRVJoZEdHQ0ZGcFVVQ0JKYm5SbGNtNWhiQ0JTYjI5MElFTkJnaWxrYjJOclpYSXRjbVZuYVhOMGNua3VaR1ZtWVhWc2RDNXpkbU11WTJ4MWMzUmxjaTVzYjJOaGJJSVRZM2N0WTJ4MWMzUmxjaTF0WjIxMExYWnBjSWNFQ2s0ZlJvY0V3S2hrMDRjRUNrNGZSNGNFQ2s0ZlNJY0VDazRmU1RBTkJna3Foa2lHOXcwQkFRc0ZBQU9DQWdFQWphSTM0ckFPakExWTByY1R1U3BQckJKei9rN01hL3NUMnM4RDIvNGV5ZTVNeXowNnhqbGtxTGd4bkNSaW9ycTkyTjg0bVAxOUp6VUp3QmZYbHhLcm51MHZTQTd0YTMyaDdKSS9pZm9pR2RkU2xIS3JKVklIMXhPM01mMExMZUVSU0k4UW1TUDNJa1lwMVR1dTdiN0Z6OTFSQ29YeXMvTEhyZ1dlUGJIMktWaG9uWXg2ZjJySmZIdXBONWZnM01ZNU1xSGJMRjRxQlFhWUQ5QUl1Si8vT3pCZU1OWDZQRTZIZHpPUjVZd1NWM2tBOHpTdlpZOW9DQ056WVBZRmxVRmhsM0JCNHMyVUZzNGRSZUY4NXNJK1VUeWp6T3dEdlA3VzZkS0gzYjMzOW8zSkZVTGp4Sk1oeGsvWDR6TlB1T3cxaU04R3JpYjFEbFpsYVFkVXpldVM0K083bHBTdWMweEI1TmN1bXRxMUI1SDhkR1cwVUF5Zzg1WUtsMTFPaVJxb3hwVTRrUzNlRjZGa3ZuR1JhT3hEdXE0SFV4MTJUQVB5dDFLeDI2Y3dUZGhkUUwrbmpwVFBFQ0dVQVNvZTErMm4yUjZFbml2dTAyZ00yYjl0MnVRcS96Q3FxWUI4U3ozSjhjQkNyMm9tWVZsRmc5OU9iWkJpUWR0U0dXdWtBTUVzMUsxMkNoNVFnM3B0RSs1YnlZN1RSdUx4L1E4TzN2U1ZtVWVwN3cvd2JKeHdQOHFoQ3YzOVNEdGx5aHVqVjZ6bjFMY0lpaUV3bDRUOFZvdUxGRFZtUlFZTXE0enBkeWNhOWlmUmdnM1NvMFBTSjVvUlpsYlB0TWNxeGhXNWdreDl2Sk9za0p5b2JwWnFFY2U3czBvVW92YWVPaHVqbTM2dDVtYmNJUmFvWUZ3PSJ9fQ==","fileName":"abc_ov.tar","isOverwrite":"false"}}},"description":"The information used to import OwnershipVouchers/serialnumbers.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"description":"Serial Number import response object.","properties":{"code":{"description":"Response code. Indicates success/failure.","format":"int32","type":"integer"},"duplicateRecordCount":{"description":"Duplicate record count.","format":"int32","type":"integer"},"message":{"description":"Response message. Indicates success/failure reason.","type":"string"},"processedRecordCount":{"description":"Processed record count.","format":"int32","type":"integer"},"warningRecordCount":{"description":"Warning record count.","format":"int32","type":"integer"}},"type":"object","$$ref":"#/components/schemas/cwztpsvcZtpSerialNumberImportResponse"},"examples":{"Success Response":{"value":{"code":200,"message":"Ownership voucher successfully added","processedRecordCount":5000}},"Miscellaneous Persistent Warning":{"value":{"code":299,"message":"FileName: abc.tar, Msg: Serial number used in device. Can’t be edited.","duplicateRecordCount":0,"processedRecordCount":0,"warningRecordCount":1}},"Invalid Input":{"value":{"code":400,"message":"Serial Number cannot be blank."}},"Invalid Request Body":{"summary":"Invalid Request Body","value":{"code":422,"message":"invalid character '}' looking for beginning of value"},"$$ref":"#/components/examples/Invalid_Request_Body"},"Internal Server Error":{"value":{"code":500,"message":"Error while encrypting OV."}},"Service Unavailable":{"value":{"code":503,"message":"Sorry, ztp service is in maintenance mode. Only read operations are supported."}}}}},"description":"OK. The request was successful. The result is contained in the response body."},"401":{"description":"Unauthorized. The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden. The server recognizes the authentication credentials, but the client is not authorized to perform this request."},"404":{"description":"Not Found. The client made a request for a resource that does not exist."}},"summary":"Bulk import of Ownership Vouchers","description":"Allows users to bulk import Ownership Vouchers contained in a (GZIPped?) TAR file. Request Body: cwztpsvcZtpSerialNumberImport, contains the base64-encoded string content of the TAR file.","tags":["Voucher & Serial Number APIs"],"__originalOperationId":"ImportOwnershipVouchers","security":[{"bearerAuth":[]}],"method":"post","path":"/ovs/import"}}