{"type":"api","title":"Get Reports","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/6caa8081-e6ba-312b-ae5a-89988569dbc0","info":{"title":"Crosswork Workflow Manager Solutions - Fleetupgrade","description":"Software Conformance in the Fleetupgrade application helps users identify network devices that don't meet required software image policies. Users can create image policy from the Image repository to suit device functions or locations. These policy act as benchmarks for verifying software compliance, ensuring devices run the appropriate software. Verification can be done once or regularly, and non-compliant devices can be upgraded to meet the policy standards.\nFleetupgrade SoftwareUpdate facilitates automated upgrade installations, allowing you to choose the Method of Procedure (MOP) for your installation. Additionally, you can customize execution variables such as the job name and execution schedule. CWMS Fleetupgrade offers prebuilt MOPs to efficiently carry out all upgrade tasks.","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"},"version":"7.1.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/CWM-SOLUTIONS/fleetupgrade-api.overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://crosswork-ip:30603/crosswork/cwms/fleetupgrade/v1"}],"securitySchemes":{"Bearer":{"type":"apiKey","description":"Type \"Bearer\" followed by a space and JWT token.","name":"Authorization","in":"header"}}},"spec":{"tags":["Conformance Report"],"summary":"Get Reports","description":"API to display a list of conformance reports.","operationId":"GetReports","parameters":[{"name":"pageNumber","in":"query","description":"pageNumber value","required":true,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"pageSize value","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"Data contains the list of reports responses.","items":{"type":"object","properties":{"degraded":{"type":"boolean","description":"Degraded indicates if the report is degraded."},"deviceGrp":{"type":"string","description":"DeviceGrp is the device group associated with the report."},"deviceVersion":{"type":"string","description":"DeviceVersion is the device version associated with the report."},"imagePolicy":{"type":"string","description":"ImagePolicy is the image policy associated with the report."},"key":{"type":"integer","description":"ID is the unique identifier for the report."},"latestRun":{"type":"integer","description":"LatestRun is the latest run time for the report."},"message":{"type":"string","description":"Message contains any additional information about the report."},"nextRun":{"type":"string","description":"NextRun is the next scheduled run time for the report."},"nonConformantCount":{"type":"integer","description":"NonConformantCount is the count of non-conformant devices in the report."},"productSeries":{"type":"string","description":"ProductSeries is the product series associated with the report."},"region":{"type":"string","description":"Region is the region associated with the report."},"reportName":{"type":"string","description":"ReportName is the name of the conformance report."},"role":{"type":"string","description":"Role is the role associated with the report."},"status":{"type":"string","description":"Status is the current status of the report."},"user":{"type":"string","description":"User is the user who created the report."}},"description":"ListReportsResponse represents the response for a list of conformance reports. This struct is used to define the details of each conformance report in the list.","$$ref":"#/components/schemas/service.ListReportsResponse"}},"pagination":{"type":"object","properties":{"pageNumber":{"type":"integer","description":"PageNumber is the current page number."},"pageSize":{"type":"integer","description":"PageSize is the number of items per page."},"total":{"type":"integer","description":"Total is the total number of items."}},"description":"Pagination contains the pagination details for the list of reports.","$$ref":"#/components/schemas/models.Pagination"}},"description":"ConformanceReportsList represents a list of conformance reports. This struct is used to define the details of the conformance reports list.","$$ref":"#/components/schemas/service.ConformanceReportsList"}}}},"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Code is the HTTP status code of the response.","example":400},"key":{"type":"integer","description":"ID is an optional key associated with the response.","example":1},"message":{"type":"string","description":"Message provides additional information about the response.","example":"Bad request"},"status":{"type":"string","description":"Status indicates the status of the response.","example":"Failed"}},"description":"Response400 represents a failed response with status code 400.","$$ref":"#/components/schemas/models.Response400"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Code is the HTTP status code of the response.","example":401},"key":{"type":"integer","description":"ID is an optional key associated with the response.","example":1},"message":{"type":"string","description":"Message provides additional information about the response.","example":"Unauthorized"},"status":{"type":"string","description":"Status indicates the status of the response.","example":"Failed"}},"description":"Response401 represents a failed response with status code 401.","$$ref":"#/components/schemas/models.Response401"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Code is the HTTP status code of the response.","example":404},"key":{"type":"integer","description":"ID is an optional key associated with the response.","example":1},"message":{"type":"string","description":"Message provides additional information about the response.","example":"Resource not found"},"status":{"type":"string","description":"Status indicates the status of the response.","example":"Failed"}},"description":"Response404 represents a failed response with status code 404.","$$ref":"#/components/schemas/models.Response404"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Code is the HTTP status code of the response.","example":406},"key":{"type":"integer","description":"ID is an optional key associated with the response.","example":1},"message":{"type":"string","description":"Message provides additional information about the response.","example":"Not Acceptable"},"status":{"type":"string","description":"Status indicates the status of the response.","example":"Failed"}},"description":"Response406 represents a failed response with status code 406.","$$ref":"#/components/schemas/models.Response406"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Code is the HTTP status code of the response.","example":500},"key":{"type":"integer","description":"ID is an optional key associated with the response.","example":1},"message":{"type":"string","description":"Message provides additional information about the response.","example":"Internal server error"},"status":{"type":"string","description":"Status indicates the status of the response.","example":"Failed"}},"description":"Response500 represents a failed response with status code 500.","$$ref":"#/components/schemas/models.Response500"}}}}},"__originalOperationId":"GetReports","method":"get","path":"/conformance/reports"}}