Get Ucse Profile Feature For Other - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Get Ucse Profile Feature For Other","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/fc31da3e-c28f-36f4-997e-066dbe728245","info":{"title":"Feature Profiles - Others","description":"Feature profiles associated with UX 2.0 configuration\n\nIncludes API operations for the following:\n- Additional feature profiles\n- APIs not covered in other categories\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Ucse Profile feature for Other feature profile","operationId":"GetUcseProfileFeatureForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}","$$ref":"#/components/schemas/CommonCommonDefs_uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"type":"object","properties":{"name":{"type":"string","pattern":"^[^&\u003c\u003e! \"]+$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"bay":{"description":"Bay","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minimum":0,"maximum":2,"type":"integer","$$ref":"#/components/schemas/ProfileparcelSdwanOtherUcseCommonRequest_bayDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanOtherUcseCommonRequest_oneOfBayOptionsDef"},"slot":{"description":"Slot","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minimum":0,"maximum":3,"type":"integer","$$ref":"#/components/schemas/ProfileparcelSdwanOtherUcseCommonRequest_slotDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanOtherUcseCommonRequest_oneOfSlotOptionsDef"},"imc":{"type":"object","properties":{"access-port":{"type":"object","properties":{"dedicated":{"description":"Dedicated","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"boolean","$$ref":"#/components/schemas/CommonCommonDefs_booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"type":"boolean","enum":[true],"$$ref":"#/components/schemas/CommonCommonDefs_booleanTrueDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultTrueNoVariableOptionsDef"},"sharedLom":{"type":"object","properties":{"lomType":{"type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"enum":["ge1","ge2","ge3","te2","te3","console","failover"],"type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanOtherUcseCommonRequest_sharedLomTypeDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanOtherUcseCommonRequest_oneOfSharedLomOptionsDef"},"failOverType":{"type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"enum":["ge2","te2"],"type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanOtherUcseCommonRequest_sharedFailOverTypeDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanOtherUcseCommonRequest_oneOfSharedFailOverOptionsDef"}},"additionalProperties":false}}},"ip":{"type":"object","properties":{"address":{"description":"Assign IPv4 address","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","pattern":"^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$","$$ref":"#/components/schemas/CommonCommonDefs_ipv4PrefixDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"}],"$$ref":"#/components/schemas/CommonCommonDefs_oneOfIpv4PrefixOptionsDef"},"defaultGateway":{"description":"Assign default gateway","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","pattern":"^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}$","$$ref":"#/components/schemas/CommonCommonDefs_ipv4AddressDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"}},"required":["optionType"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanOtherUcseCommonRequest_oneOfDefaultGatewayOptionsDef"}},"required":["address","defaultGateway"],"additionalProperties":false},"vlan":{"type":"object","properties":{"vlanId":{"description":"Assign Vlan Id","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minimum":2,"maximum":4095,"type":"integer","$$ref":"#/components/schemas/ProfileparcelSdwanOtherUcseCommonRequest_vlanIdDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"}},"required":["optionType"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanOtherUcseCommonRequest_oneOfVlanIdOptionsDef"},"priority":{"description":"Assign priority","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minimum":0,"maximum":7,"type":"integer","$$ref":"#/components/schemas/ProfileparcelSdwanOtherUcseCommonRequest_priorityDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"}},"required":["optionType"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanOtherUcseCommonRequest_oneOfPriorityOptionsDef"}}}}},"interface":{"description":"Interface name: GigabitEthernet0/\u003c\u003e/\u003c\u003e when present","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"ifName":{"description":"Set Inteface name","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","pattern":"(ucse)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)","minLength":3,"maxLength":32,"$$ref":"#/components/schemas/ProfileparcelSdwanOtherUcseCommonRequest_ifNameDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"}},"required":["optionType"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanOtherUcseCommonRequest_oneOfInterfaceNameOptionsDef"},"l3":{"description":"L3","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"type":"boolean","enum":[true],"$$ref":"#/components/schemas/CommonCommonDefs_booleanTrueDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanOtherUcseCommonRequest_onel3DefaultOptionsDef"},"ucseInterfaceVpn":{"description":"UCSE Interface VPN","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minimum":1,"maximum":65527,"type":"integer","$$ref":"#/components/schemas/ProfileparcelSdwanOtherUcseCommonRequest_interfaceUcseInterfaceVpnDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"}},"required":["optionType"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanOtherUcseCommonRequest_oneOfInterfaceUcseInterfaceVpnOptionsDef"},"address":{"description":"Assign IPv4 address","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","pattern":"^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$","$$ref":"#/components/schemas/CommonCommonDefs_ipv4PrefixDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"}],"$$ref":"#/components/schemas/CommonCommonDefs_oneOfIpv4PrefixOptionsDef"}},"required":["ifName"],"additionalProperties":false}}},"required":["slot","bay"],"additionalProperties":false}},"required":["data"],"x-metadata":{"supportedDeviceTypes":["vedge-C8300-2N2S-4T2X","vedge-C8330-1N1S-4M2X","vedge-C8375-E-G2","vedge-C8330-6TM4SX","vedge-C8330-6TM4X","vedge-C8351-G2","vedge-C8330X-6TM4SX","vedge-C8330X-6TM4X","vedge-C8355-G2","vedge-C8300-1N1S-4T2X","vedge-C8230E-8TM2X","vedge-C8231-G2","vedge-C8230X-8M2X","vedge-C8235-G2","vedge-C8230-1N-2M2X","vedge-C8231-E-G2","vedge-C8230X-1N-2M2X","vedge-C8235-E-G2","vedge-C8300-2N2S-6T","vedge-ISR-4451-X","vedge-C8300-1N1S-6T","vedge-ISR-4461","vedge-ISR-4351","vedge-ISR-4431","vedge-ISR-4321","vedge-ISR-4331","vedge-ISR-4221","vedge-ISR-4221X"],"minVManageVersion":"20.16.1"},"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdwanOtherUcseCommonRequest_SchemaPayload"}}}}},"$$ref":"#/components/schemas/getListSdwanOtherUcsePayload"},"examples":{"get response example":{"value":{"header":{"generatedOn":1702438718825},"data":[{"parcelId":"09fc54fe-ff36-4640-ae57-c9e71a103902","parcelType":"ucse","createdBy":"admin","lastUpdatedBy":"admin","createdOn":1701866357838,"lastUpdatedOn":1701866357838,"payload":{"data":{"bay":{"optionType":"global","value":2},"slot":{"optionType":"global","value":0},"imc":{"access-port":{"dedicated":{"optionType":"global","value":true},"sharedLom":{"lomType":{"optionType":"global","value":"ge1"},"failOverType":{"optionType":"global","value":"ge2"}}},"ip":{"address":{"optionType":"global","value":"2.2.2.2/24"},"defaultGateway":{"optionType":"global","value":"2.2.2.2"}},"vlan":{"vlanId":{"optionType":"global","value":3},"priority":{"optionType":"global","value":3}}},"interface":[{"ifName":{"optionType":"global","value":"ucse2/0"},"l3":{"optionType":"default","value":true},"ucseInterfaceVpn":{"optionType":"global","value":2},"address":{"optionType":"global","value":"10.1.15.15/24"}}]}}}]},"$$ref":"#/components/examples/getListSdwanOtherUcseExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile \u003e Other \u003e UCSE-read","method":"get","path":"/v1/feature-profile/sdwan/other/{otherId}/ucse"}}