Network device image update validation results - Cisco Catalyst Center API 3.1.3

{"type":"api","title":"Network device image update validation results","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-3-1-3/9b7bce247bccb0311419e593770ef07f9552d9e1/d41c7da7-f399-330a-bd19-886309e55849","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 3.1.3","version":"3.1.3"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.3","servers":[{"url":"/"}]},"spec":{"operationId":"networkDeviceImageUpdateValidationResults","tags":["Software Image Management (SWIM)"],"summary":"Network device image update validation results","deprecated":false,"description":"This API provides a comprehensive overview of the outcomes from various tests and assessments defined by system and custom validations related to network device images. These results are essential for identifying potential issues, verifying configurations, and ensuring that the network meets the requirement for image update.","parameters":[{"name":"networkDeviceId","description":"Network device identifier.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"id","description":"Unique identifier of network device validation task.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"operationType","description":"The operation type, as part of which this validation will get triggered. Available values : DISTRIBUTION, ACTIVATION, READINESS_CHECK.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"status","description":"Status of the validation result. SUCCESS, FAILED, IN_PROGRESS, WARNING.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"type","description":"Type of the validation. Available values : PRE_VALIDATION, POST_VALIDATION.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"sortBy","description":"A property within the response to sort by.","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"order","description":"Whether ascending or descending order should be used to sort the response. Available values : asc, desc","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"limit","description":"The number of records to show for this page. The minimum and maximum values are 1 and 500, respectively.","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"offset","description":"The first record to show for this page; the first record is numbered 1. The minimum value is 1.","schema":{"type":"number","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Network validation result identifier."},"parentId":{"type":"string","description":"Parent identifier for the network validation results."},"name":{"type":"string","description":"Network device validation name."},"operationType":{"type":"string","enum":["DISTRIBUTION","ACTIVATION","READINESS_CHECK"],"description":"The operation type, as part of which this validation got triggered."},"type":{"type":"string","enum":["PRE_VALIDATION","POST_VALIDATION"],"description":"The type of network device validation determines whether this validation runs before or after the operation."},"networkDeviceId":{"type":"string","description":"Network device identifier."},"startTime":{"type":"number","description":"A date and time represented as milliseconds since the Unix epoch."},"endTime":{"type":"number","description":"A date and time represented as milliseconds since the Unix epoch."},"status":{"type":"string","enum":["SUCCESS","FAILED","STARTED","PARTIAL_SUCCESS","PENDING","WARNING","SKIPPED","ABORTED"],"description":"Status of the network device validation result."},"resultDetails":{"type":"object","properties":{"key":{"type":"string","enum":["EXPECTED","ACTUAL","ACTION","STATUS","DESCRIPTION"],"description":""},"value":{"type":"string","description":"Holds the information for each `key`."}},"description":"Network validation result details."}}},"description":""},"version":{"type":"string","description":"The version of the response."}},"description":"","$$ref":"#/components/schemas/networkDeviceImageUpdateValidationResultsResponse"}}}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"401":{"description":"The client's authentication credentials included with the request are missing or invalid.","content":{}},"403":{"description":"The server recognizes the authentication credentials, but the client is not authorized to perform this request.","content":{}},"500":{"description":"The server could not fulfill the request.","content":{}},"501":{"description":"The server has not implemented the functionality required to fulfill the request.","content":{}},"502":{"description":"The server is (temporarily) unavailable.","content":{}},"503":{"description":"The server is (temporarily) unavailable.","content":{}},"504":{"description":"The server did not respond inside time restrictions and timed-out.","content":{}},"1XX":{"description":"Informational Responses - The server received the request and sent an informational response.","content":{}},"2XX":{"description":"Successful Responses - The server received the client request, understood it, and accepted it.","content":{}},"3XX":{"description":"Redirection Messages - The client must take additional action to complete the request.","content":{}},"4XX":{"description":"Client Error Responses - The client request caused the error.","content":{}},"5XX":{"description":"Server Error Responses - The server failed to fulfill the request.","content":{}}},"x-rapi-id":"e3b5-0967-4a5a-bf31","x-rapi-overview":"This API provides a comprehensive overview of the outcomes from various tests and assessments defined by system and custom validations related to network device images. These results are essential for identifying potential issues, verifying configurations, and ensuring that the network meets the requirement for image update.","x-rapi-domain":"Site Management","x-rapi-subdomain":"Software Image Management (SWIM)","x-rapi-version":"1.0.0","x-rapi-internalPath":"/intent/api/v1/networkDeviceImages/validationResults","x-rapi-publicPath":"/dna/intent/api/v1/networkDeviceImages/validationResults","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-deprecationMessage":"","x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"networkDeviceImageUpdateValidationResults","method":"get","path":"/dna/intent/api/v1/networkDeviceImages/validationResults"}}