Get list of ZTP static routes - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Get list of ZTP static routes","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/6c38d1fe-54c3-3c7d-9226-ba8b795939ba","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-deprecated-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":"GetStaticRouteList","deprecated":true,"requestBody":{"content":{"application/json":{"schema":{"description":"Static Route query request object.","properties":{"criteria":{"description":"Response filter criteria like sort field, page number, number of records, case matching and sort order. Overrides these parameters specified in \"filterData\".","type":"string"},"filter":{"description":"Static Route object.","properties":{"mask":{"description":"Mask for static routes","type":"string"},"message":{"description":"Message on successful add or delete of static route","type":"string"},"modifiedDate":{"format":"int64","description":"Last modified date in UNIX time format","type":"integer"},"status":{"description":"Status of the subnet and mask for add or delete operation","type":"string"},"subnet":{"description":"Subnet for static routes","type":"string"},"uuid":{"description":"Unique UUID for the route's subnet mask","type":"string"}},"type":"object","$$ref":"#/components/schemas/cwztpsvcZtpStaticRoute"},"filterData":{"description":"Used to filter results, paginationin device and other APIs.","properties":{"Criteria":{"description":"Response filter criteria. Not used.","type":"string"},"Descending":{"description":"Order response in ascending/descending order. Default value: \"false\"","format":"boolean","type":"boolean"},"MatchCase":{"description":"Do case matching. Not used.","format":"boolean","type":"boolean"},"PageNum":{"description":"Page number in the list of generated records, paginated by \"PageSize\". Starts with 0.","format":"int64","type":"integer"},"PageSize":{"description":"Number of records to be returned in a response.","format":"int64","type":"integer"},"SortBy":{"description":"Field to be used for sorting responses.","type":"string"},"TotalCount":{"description":"Total number of records matching the query criteria.","format":"int64","type":"integer"}},"type":"object","$$ref":"#/components/schemas/cwztpsvcZtpFilterData"}},"type":"object","$$ref":"#/components/schemas/cwztpsvcZtpStaticRouteGetRequest"},"example":{"filter":{"subnet":"10.3.2.0"},"filterData":{"PageSize":30,"PageNum":0}}}},"description":"The information used to get the static route","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"description":"Static Route query response object.","properties":{"code":{"description":"Response code. Indicates success/failure.","format":"int32","type":"integer"},"message":{"description":"Response message. Indicates success/failure reason.","type":"string"},"paginationDetails":{"description":"Used to filter results, paginationin device and other APIs.","properties":{"Criteria":{"description":"Response filter criteria. Not used.","type":"string"},"Descending":{"description":"Order response in ascending/descending order. Default value: \"false\"","format":"boolean","type":"boolean"},"MatchCase":{"description":"Do case matching. Not used.","format":"boolean","type":"boolean"},"PageNum":{"description":"Page number in the list of generated records, paginated by \"PageSize\". Starts with 0.","format":"int64","type":"integer"},"PageSize":{"description":"Number of records to be returned in a response.","format":"int64","type":"integer"},"SortBy":{"description":"Field to be used for sorting responses.","type":"string"},"TotalCount":{"description":"Total number of records matching the query criteria.","format":"int64","type":"integer"}},"type":"object","$$ref":"#/components/schemas/cwztpsvcZtpFilterData"},"ztpStaticRoutes":{"description":"List of Static Route objects.","items":{"description":"Static Route object.","properties":{"mask":{"description":"Mask for static routes","type":"string"},"message":{"description":"Message on successful add or delete of static route","type":"string"},"modifiedDate":{"format":"int64","description":"Last modified date in UNIX time format","type":"integer"},"status":{"description":"Status of the subnet and mask for add or delete operation","type":"string"},"subnet":{"description":"Subnet for static routes","type":"string"},"uuid":{"description":"Unique UUID for the route's subnet mask","type":"string"}},"type":"object","$$ref":"#/components/schemas/cwztpsvcZtpStaticRoute"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/cwztpsvcZtpStaticRouteQueryResponse"},"examples":{"Success Response":{"value":{"ztpStaticRoutes":[{"uuid":"b44f254a-fb70-40a3-a5b4-d654312538ba","subnet":"55.1.1.0","mask":"24","status":"add-inprogress","modifiedDate":1685727386825}],"code":200,"paginationDetails":{"PageSize":30,"TotalCount":1}}},"Invalid Input":{"value":{"code":400,"message":"Filter not provided."}},"Invalid Request Body":{"summary":"Invalid Request Body","value":{"code":422,"message":"invalid character '}' looking for beginning of value"},"$$ref":"#/components/examples/Invalid_Request_Body"}}}},"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":"Get list of ZTP static routes","description":"This API gets a list of ZTP static routes. Request Body: ZtpStaticRouteRequest. Response Body is ZtpStaticRouteResponse.","tags":["Static Route APIs"],"__originalOperationId":"GetStaticRouteList","security":[{"bearerAuth":[]}],"method":"post","path":"/staticroutes/query"}}