Get-all-the-supported-families, for a platform - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Get-all-the-supported-families, for a platform","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/27d6c440-9d60-38a9-ae4f-017212b48575","info":{"title":"Crosswork ZTP Image Service API","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"},"description":"This document explains the Crosswork REST APIs that you can use to manage software image files for Zero Touch Provisioning (ZTP) devices."},"security":[{"bearerAuth":[]}],"tags":[{"name":"Device Platform APIs","description":"List of Device Platform APIs."},{"name":"Image APIs","description":"List of Image APIs."}],"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/ztp-image-service-api-overview.md"}},"openapi":"3.0.1","servers":[{"url":"/crosswork/ztpimage/v1"}],"securitySchemes":{"bearerAuth":{"description":"Security definition details.","in":"header","name":"Authorization","type":"apiKey"}}},"spec":{"parameters":[{"description":"OS platform","in":"path","name":"platform","required":true,"schema":{"type":"string"}},{"description":"Retrieve all the custom configured device families based on OS platform.","in":"query","name":"fetchCustomData","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Vendor","in":"query","name":"vendor","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"content":{"description":"Platform data.","items":{"type":"string"},"type":"array"},"pageNumber":{"description":"Indicates the page number in the list of records, paginated by \"pageSize\".","format":"int32","type":"integer"},"pageSize":{"description":"Number of records to be returned in a single response.","format":"int32","type":"integer"}},"description":"ResponseDtoOfStringList","type":"object","$$ref":"#/components/schemas/StringList"},{"properties":{"content":{"description":"Image data.","items":{"properties":{"createdBy":{"description":"Created by user id.","type":"string"},"createdTime":{"description":"Creation time. Time since Unix epoch, in milliseconds.","type":"integer"},"deviceFamily":{"description":"Device family.","type":"string"},"downloadURL":{"description":"Image download URL string.","type":"string"},"id":{"description":"Unique image id.","type":"string"},"imageFileName":{"description":"Image file name.","type":"string"},"imagePlatform":{"description":"Image platform.","type":"string"},"imageSource":{"description":"Image source path.","type":"string"},"imageTitle":{"description":"Image title.","type":"string"},"imageType":{"description":"Image type","type":"string"},"imageVersion":{"description":"Image version","type":"string"},"modifiedBy":{"description":"Id of the user who last updated the image.","type":"string"},"modifiedTime":{"description":"Modification time. Time since Unix epoch, in milliseconds.","type":"integer"},"vendor":{"description":"Device vendor.","type":"string"}},"description":"ImageDto object","type":"object","$$ref":"#/components/schemas/ImageDto"},"type":"array"},"pageNumber":{"description":"Indicates the page number in the list of records, paginated by \"pageSize\".","format":"int32","type":"integer"},"pageSize":{"description":"Number of records to be returned in a single response.","format":"int32","type":"integer"}},"description":"ResponseDtoOfImageDto","type":"object","$$ref":"#/components/schemas/ResponseDtoOfImageDto"}]},"example":{"content":["CISCO ASR9000","CISCO NCS5500","CISCO 8800"],"pageNumber":1,"pageSize":3}}},"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."}},"tags":["Device Platform APIs"],"operationId":"getFamiliesByPlatformUsingGET","summary":"Get-all-the-supported-families, for a platform","description":"This API retrieves all the supported families for the input platform.","__originalOperationId":"getFamiliesByPlatformUsingGET","security":[{"bearerAuth":[]}],"method":"get","path":"/platform/{platform}/family"}}