{"type":"api","title":"Get a list of config attributes","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":"GetDynamicConfigs","requestBody":{"content":{"application/json":{"schema":{"description":"Dynamic config request object.","properties":{"configId":{"description":"Unique id. used to identify this dynamic config.","type":"string"},"profileName":{"description":"Profile name","type":"string"}},"type":"object","$$ref":"#/components/schemas/cwztpsvcdynamicConfigRequest"},"example":{"configId":"e97fa6aa-6db8-4825-bac6-5eeeb31a45db","profileName":"test-profile"}}},"description":"The information used to retrieve list of config attributes.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"description":"Dynamic config response object.","properties":{"code":{"description":"Response code. Indicates success/failure.","format":"int32","type":"integer"},"configAttributes":{"description":"List of attributes and values, formatted as string.","items":{"type":"string"},"type":"array"},"configId":{"description":"Unique id. used to identify this dynamic config.","type":"string"},"message":{"description":"Response message. Indicates success/failure reason.","type":"string"},"profileName":{"description":"Profile name","type":"string"}},"type":"object","$$ref":"#/components/schemas/cwztpsvcdynamicConfigResponse"},"examples":{"Success Response":{"value":{"profileName":"profile1","configId":"58a32450-3c9c-4a49-9ab1-38729eb31d69","configAttributes":["attr1","attr2"],"code":200}},"Invalid Input":{"value":{"code":400,"message":"Config Id associated with profile-1 is 1e5c7e5c-7ccd-4316-ae15-7fe45ef87047 doesn't match with e97fa6aa-6db8-4825-bac6-5eeeb31a45db."}},"Profile Not Found":{"value":{"code":404,"message":"Profile with name profile-1 does not exist"}},"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 a list of config attributes","description":"This API retrieves a list of config attributes. It takes the value of the dynamicConfigRequest parameter as input, in which the user can specify either one or both of the configId and profileName as filters. The Response Body will be contained in dynamicConfigResponse.","tags":["Device APIs"],"__originalOperationId":"GetDynamicConfigs","security":[{"bearerAuth":[]}],"method":"post","path":"/query/config"}}