Get Esim Cellular Profile Feature For Mobility - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Get Esim Cellular Profile Feature For Mobility","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/a724d7a2-d5be-3cd7-8f42-0d775cdd69b7","info":{"title":"Feature Profiles - Mobility and NFV","description":"Feature profiles associated with UX 2.0 configuration\n\nIncludes API operations for the following:\n- Feature Profiles in Mobility and NFV Solutions\n- Supporting mobility features and Network Function Virtualization (NFV) configurations.\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get EsimCellular Profile Features for Mobility Global Feature Profile","operationId":"GetEsimCellularProfileFeatureForMobility","parameters":[{"name":"profileId","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":"Set the eSim Cellular profile feature name"},"description":{"description":"Set the eSim Cellular profile feature description","type":"string"},"data":{"type":"object","properties":{"wanConfig":{"description":"Set wanConfig for cellular as Active/Standby","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","enum":["Active","Standby"],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_wanConfigDef"}},"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/ProfileparcelMobilityGlobalEsimcellularPostRequest_wanConfigOptionTypesDef"},"slotConfig":{"type":"object","description":"Set the slot specific eSim cellular configuration","properties":{"slot0Config":{"description":"Set the slot 0 eSim cellular configuration","type":"object","properties":{"accountInfo":{"type":"object","properties":{"accountId":{"type":"object","description":"Set provider account Id used for this configuration","properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","minLength":1}},"required":["optionType","value"],"additionalProperties":false},"commPlan":{"type":"object","description":"Set communication plan used for this configuration","properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","minLength":1}},"required":["optionType","value"],"additionalProperties":false},"ratePlan":{"type":"object","description":"Set rate plan used for this configuration","properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","minLength":1}},"required":["optionType","value"],"additionalProperties":false}},"required":["accountId","commPlan","ratePlan"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_eSimAccountInfoDef"},"attachProfileConfig":{"description":"Set attach profile eSim cellular configuration","type":"object","properties":{"apn":{"description":"Set access point name","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_apnDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfApnOptionsDef"},"authentication":{"oneOf":[{"type":"object","properties":{"noAuthentication":{"type":"object","description":"No Authentication","properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"type":"string","enum":["none"],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_defaultAuthenticationDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfDefaultAuthenticationOptionsDef"}},"required":["noAuthentication"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfNoAuthenticationOptionsDef"},{"type":"object","properties":{"needAuthentication":{"type":"object","properties":{"type":{"description":"Set authentication type","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"enum":["pap","chap","pap_chap"],"type":"string","$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_authenticationDef"}},"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/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfAuthenticationOptionsDef"},"username":{"description":"Set the username","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_usernameDef"}},"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/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfUsernameOptionsDef"},"password":{"description":"Set the password","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_passwordDef"}},"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/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfPasswordOptionsDef"}},"required":["type","username","password"],"additionalProperties":false}},"required":["needAuthentication"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfNeedAuthenticationOptionsDef"}]},"pdnType":{"description":"Set packet data network type","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"default":"IPv4","enum":["IPv4","IPv6","IPv4v6"],"type":"string","$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_pdnTypeDef"}},"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"},"value":{"type":"string","enum":["IPv4"],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_defaultPdnTypeDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfPdnTypeOptionsDef"}},"required":["apn"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_commonCellularProfileInfoDef"},"dataProfileConfig":{"description":"Set data profile eSim cellular configuration","type":"object","properties":{"apn":{"description":"Set access point name","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_apnDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfApnOptionsDef"},"authentication":{"oneOf":[{"type":"object","properties":{"noAuthentication":{"type":"object","description":"No Authentication","properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"type":"string","enum":["none"],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_defaultAuthenticationDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfDefaultAuthenticationOptionsDef"}},"required":["noAuthentication"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfNoAuthenticationOptionsDef"},{"type":"object","properties":{"needAuthentication":{"type":"object","properties":{"type":{"description":"Set authentication type","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"enum":["pap","chap","pap_chap"],"type":"string","$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_authenticationDef"}},"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/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfAuthenticationOptionsDef"},"username":{"description":"Set the username","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_usernameDef"}},"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/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfUsernameOptionsDef"},"password":{"description":"Set the password","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_passwordDef"}},"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/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfPasswordOptionsDef"}},"required":["type","username","password"],"additionalProperties":false}},"required":["needAuthentication"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfNeedAuthenticationOptionsDef"}]},"pdnType":{"description":"Set packet data network type","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"default":"IPv4","enum":["IPv4","IPv6","IPv4v6"],"type":"string","$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_pdnTypeDef"}},"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"},"value":{"type":"string","enum":["IPv4"],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_defaultPdnTypeDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfPdnTypeOptionsDef"}},"required":["apn"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_commonCellularProfileInfoDef"}},"required":["accountInfo","attachProfileConfig"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_eSimCellularSlotConfigDef"}},"required":["slot0Config"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_slotConfigDef"}},"required":["slotConfig"],"additionalProperties":false}},"required":["name","data"],"x-metadata":{"minVManageVersion":"20.15.1"},"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_SchemaPayload"}}}}},"$$ref":"#/components/schemas/getListMobilityGlobalEsimcellularPayload"},"examples":{"get response example":{"value":{"header":{"generatedOn":1702438718825},"data":[{"parcelId":"09fc54fe-ff36-4640-ae57-c9e71a103902","parcelType":"esimcellular","createdBy":"admin","lastUpdatedBy":"admin","createdOn":1701866357838,"lastUpdatedOn":1701866357838,"payload":{"data":{"slotConfig":{"slot0Config":{"accountInfo":{"accountId":{"optionType":"global","value":"accountId1"},"commPlan":{"optionType":"global","value":"comPlan1"},"ratePlan":{"optionType":"global","value":"ratePlan1"}},"attachProfileConfig":{"apn":{"optionType":"global","value":"apn1"},"authentication":{"noAuthentication":{"optionType":"default","value":"none"}},"pdnType":{"optionType":"default","value":"IPv4"}}}}}}}]},"$$ref":"#/components/examples/getListMobilityGlobalEsimcellularExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile \u003e Teleworker \u003e eSimCellular-read","method":"get","path":"/v1/feature-profile/mobility/global/{profileId}/esimcellular"}}