Get Ignition Profile Parcel By Parcel Id For System Configuration Feature Profile Sd Routing 7003 - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Get Ignition Profile Parcel By Parcel Id For System Configuration Feature Profile Sd Routing 7003","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/f75de7c3-5553-375b-b45f-644916a52d4b","info":{"title":"Feature Profiles - SD-Routing","description":"Feature profiles associated with UX 2.0 configuration\n\nIncludes API operations for the following:\n- Feature Profiles in SD-Routing Solution\n- Supporting software-defined routing features and autonomous router management\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get Ignition Profile feature by parcelId for System feature profile","operationId":"GetIgnitionProfileParcelByParcelIdForSystem_ConfigurationFeatureProfileSdRouting_7003","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ignitionId","in":"path","description":"Profile feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"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":{"powerManagement":{"description":"Enable/disable power management","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":["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":"boolean","enum":[false],"$$ref":"#/components/schemas/CommonCommonDefs_booleanFalseDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfPowerManagementOptionsDef"},"sense":{"description":"Enable/disable sense","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":["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":"boolean","enum":[true],"$$ref":"#/components/schemas/CommonCommonDefs_booleanTrueDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfSenseVoltageOptionsDef"},"batteryType":{"description":"Battery type","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","enum":["12v","24v"],"default":"12v","$$ref":"#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_batteryTypeDef"}},"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":["12v"],"$$ref":"#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_defaultBatteryTypeDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfBatteryTypeOptionsDef"},"shutdownTimer":{"description":"Shutdown timer","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"integer","minimum":120,"maximum":32400,"default":300,"$$ref":"#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_shutdownTimerDef"}},"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":"integer","minimum":300,"maximum":300,"default":300,"$$ref":"#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_defaultShutdownTimerDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfShutdownTimerOptionsDef"},"underVoltageThreshold":{"description":"UnderVoltage threshold","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"number","multipleOf":0.001,"minimum":9,"maximum":24,"default":9,"$$ref":"#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_underVoltageThresholdDef"}},"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":"number","multipleOf":0.001,"minimum":9,"maximum":9,"default":9,"$$ref":"#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_defaultUnderVoltageThresholdDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfUnderVoltageThresholdOptionsDef"},"senseVoltageThreshold":{"description":"SenseVoltage threshold","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"number","multipleOf":0.001,"minimum":9,"maximum":36,"default":11.5,"$$ref":"#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_senseVoltageThresholdDef"}},"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":"number","multipleOf":0.001,"default":11.5,"$$ref":"#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_defaultSenseVoltageThresholdDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfSenseVoltageThresholdOptionsDef"}},"required":["powerManagement"],"additionalProperties":false}},"required":["data"],"x-metadata":{"supportedDeviceTypes":["vedge-IR-1821","vedge-IR-1831","vedge-IR-1833","vedge-IR-1835","vedge-IR-1821-SD-ROUTING","vedge-IR-1831-SD-ROUTING","vedge-IR-1833-SD-ROUTING","vedge-IR-1835-SD-ROUTING"],"minVManageVersion":"20.18.1"},"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_SchemaPayload"}},"$$ref":"#/components/schemas/getSingleSdRoutingSystemIgnitionPayload"},"examples":{"get response example":{"value":{"parcelId":"ffbb5ae2-f25a-476c-873d-ebce496421f4","parcelType":"ignition","createdBy":"admin","lastUpdatedBy":"admin","createdOn":1702440277747,"lastUpdatedOn":1702440277747,"payload":{"data":{"powerManagement":{"optionType":"global","value":true},"sense":{"optionType":"global","value":true},"batteryType":{"optionType":"global","value":"24v"},"shutdownTimer":{"optionType":"global","value":300},"underVoltageThreshold":{"optionType":"global","value":12.345},"senseVoltageThreshold":{"optionType":"global","value":23.456}}}},"$$ref":"#/components/examples/getSingleSdRoutingSystemIgnitionExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile \u003e System \u003e Ignition-read,Feature Profile \u003e System \u003e Ignition-write","method":"get","path":"/v1/feature-profile/sd-routing/system/{systemId}/ignition/{ignitionId}"}}