Create Planned Access Point for Floor - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Create Planned Access Point for Floor","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/a58b8872fdc3116cb1a0478252ee81e8011d37c2/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"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.1","servers":[{"url":"/"}]},"spec":{"operationId":"createPlannedAccessPointForFloor","tags":["Devices"],"deprecated":false,"summary":"Create Planned Access Point for Floor","description":"Allows creation of a new planned access point on an existing floor map including its planned radio and antenna details. Use the Get variant of this API to fetch any existing planned access points for the floor. The payload to create a planned access point is in the same format, albeit a single object instead of a list, of that API.","parameters":[{"name":"Content-Type","description":"Request body content type","required":true,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"floorId","description":"The instance UUID of the floor hierarchy element","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"}],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"object","properties":{"attributes":{"type":"object","properties":{"createDate":{"type":"number","description":"Created date of the planned access point"},"domain":{"type":"string","description":"Service domain to which the planned access point belongs"},"heirarchyName":{"type":"string","description":"Hierarchy name of the planned access point"},"id":{"type":"number","description":"Unique id of the planned access point"},"instanceUuid":{"type":"string","description":"Instance uuid of the planned access point"},"macAddress":{"type":"string","description":"MAC address of the planned access point"},"name":{"type":"string","description":"Display name of the planned access point"},"source":{"type":"string","enum":["EKAHAU,MANUAL,UNKNOWN"],"description":"Source of the data used to create the planned access point"},"typeString":{"type":"string","description":"Type string representation of the planned access point"}},"description":"Attributes of the planned access point"},"isSensor":{"type":"boolean","description":"Indicates that PAP is a sensor"},"location":{"type":"object","properties":{"altitude":{"type":"number","description":"Altitude of the planned access point's location"},"lattitude":{"type":"number","description":"Latitude of the planned access point's location"},"longtitude":{"type":"number","description":"Longitude of the planned access point's location"}},"description":"Location of the planned access point"},"position":{"type":"object","properties":{"x":{"type":"number","description":"x-coordinate of the planned access point on the map, 0,0 point being the top-left corner"},"y":{"type":"number","description":"y-coordinate of the planned access point on the map, 0,0 point being the top-left corner"},"z":{"type":"number","description":"z-coordinate, or height, of the planned access point on the map"}},"description":"Position of the planned access point"},"radioCount":{"type":"integer","description":"Number of radios of the planned access point"},"radios":{"type":"array","items":{"type":"object","properties":{"antenna":{"type":"object","properties":{"azimuthAngle":{"type":"number","description":"Azimuth angle of the antenna"},"elevationAngle":{"type":"number","description":"Elevation angle of the antenna"},"gain":{"type":"number","description":"Gain of the antenna"},"mode":{"type":"string","enum":["sector_a, sector_b, omni, unknown"],"description":"Mode of the antenna associated with this radio"},"name":{"type":"string","description":"Name of the antenna"},"type":{"type":"string","enum":[" internal, external, circular, linear, unknown"],"description":"Type of the antenna associated with this radio"}},"description":"Antenna of the radio "},"attributes":{"type":"object","properties":{"channel":{"type":"number","description":"Channel in which this radio operates"},"channelString":{"type":"string","description":"Channel string representation"},"id":{"type":"integer","description":"Id of the radio"},"ifMode":{"type":"string","enum":["A, B, ABGN, Monitor, Sniffer, XorMonitor, Xor24, Xor5, Xor6, XorUnknown, _6GHZ, XOR56GHZ, Unknown"],"description":"IF mode of the radio"},"ifTypeString":{"type":"string","description":"String representation of native band"},"ifTypeSubband":{"type":"string","enum":["A, B, ABGN, _6GHZ, _XOR_5_6GHZ, Unknown"],"description":"Sub band of the radio"},"instanceUuid":{"type":"string","description":"Instance Uuid of the radio"},"slotId":{"type":"number","description":"Slot number in which the radio resides in the parent access point"},"txPowerLevel":{"type":"number","description":"Tx Power at which this radio operates (in dBm)"}},"description":"Attributes of the radios"},"isSensor":{"type":"boolean","description":"Determines if it is sensor or not"}}},"description":"Radios of the planned access point"}},"description":"","$$ref":"#/components/schemas/CreatePlannedAccessPointForFloorRequest"}}},"required":true},"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string","description":"Response Version e.g. : 1.0"},"response":{"type":"object","properties":{"url":{"type":"string","description":"URL to get task details e.g. : /api/v1/task/3200a44a-9186-4caf-8c32-419cd1f3d3f5"},"taskId":{"type":"string","description":"Task Id in uuid format. e.g. : 3200a44a-9186-4caf-8c32-419cd1f3d3f5 "}},"description":"Response containing task id in uuid format."}},"description":"Task Id Result","$$ref":"#/components/schemas/CreatePlannedAccessPointForFloorResponse"}}}},"201":{"description":"The POST/PUT request was fulfilled and a new resource has been created. Information about the resource is in the response body.","content":{}},"202":{"description":"The request was accepted for processing, but the processing has not been completed.","content":{}},"204":{"description":"The request was successful, however no content was returned.","content":{}},"206":{"description":"The GET request included a Range Header, and the server responded with the partial content matching the range.","content":{}},"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":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"409":{"description":"The target resource is in a conflicted state (for example, an edit conflict where a resource is being edited by multiple users). Retrying the request later might succeed.","content":{}},"415":{"description":"The client sent a request body in a format that the server does not support (for example, XML to a server that only accepts JSON).","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":{}},"503":{"description":"The server is (temporarily) unavailable.","content":{}},"504":{"description":"The server did not respond inside time restrictions and timed-out.","content":{}}},"x-rapi-id":"7eaa-8b15-454a-8c1d","x-rapi-overview":"Allows creation of a new planned access point on an existing floor map including its planned radio and antenna details. Use the Get variant of this API to fetch any existing planned access points for the floor. The payload to create a planned access point is in the same format, albeit a single object instead of a list, of that API.","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Devices","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/dna-maps-service/floors/${floorId}/planned-access-points","x-rapi-publicPath":"/dna/intent/api/v1/floors/${floorId}/planned-access-points","x-rapi-registerInKONG":true,"x-rapi-banner":[],"__originalOperationId":"createPlannedAccessPointForFloor","method":"post","path":"/dna/intent/api/v1/floors/{floorId}/planned-access-points"}}