Get Cedge System Mrf Parcel Schema By Schema Type - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Get Cedge System Mrf Parcel Schema By Schema Type","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/ade8dfef-05e7-3191-b6ee-a5ffe6465bd7","info":{"title":"Feature Profiles - SD-WAN System","description":"Feature profiles associated with UX 2.0 configuration\n\nIncludes API operations for the following:\n- System Feature Profiles in the SD-WAN Solution\n- Managing core system configurations, device management, and platform-level settings\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 a Cedge System Mrf Parcel Schema by Schema Type","operationId":"GetCedgeSystemMrfParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"type":"object","properties":{"name":{"type":"string","pattern":"^[^&\u003c\u003e! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"secondaryRegion":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minimum":1,"maximum":63,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]}},"required":["optionType"],"additionalProperties":false}]},"role":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["edge-router","border-router"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]}},"required":["optionType"],"additionalProperties":false}]},"enableMrfMigration":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["enabled","enabled-from-bgp-core"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]}},"required":["optionType"],"additionalProperties":false}]},"migrationBgpCommunity":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minimum":1,"maximum":4294967295,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]}},"required":["optionType"],"additionalProperties":false}]},"enableManagementRegion":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"boolean","enum":[false]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"managementRegion":{"description":"Management Region","type":"object","properties":{"vrfId":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minimum":1,"maximum":65531,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]}},"required":["optionType"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"gatewayPreference":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"items":{"minimum":1,"maximum":63,"type":"integer"},"minItems":1,"maxItems":8,"uniqueItems":true,"type":"array"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]}},"required":["optionType"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"managementGateway":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"boolean","enum":[false]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":[],"additionalProperties":false}},"required":[],"additionalProperties":false}},"required":["name","data"],"x-metadata":{"minVManageVersion":"20.15.1"},"additionalProperties":false},"$$ref":"#/components/examples/ProfileparcelSdwanSystemMrfCommonRequest_ResolvedSchema"},"put":{"value":{"type":"object","properties":{"name":{"type":"string","pattern":"^[^&\u003c\u003e! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"secondaryRegion":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minimum":1,"maximum":63,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]}},"required":["optionType"],"additionalProperties":false}]},"role":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["edge-router","border-router"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]}},"required":["optionType"],"additionalProperties":false}]},"enableMrfMigration":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["enabled","enabled-from-bgp-core"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]}},"required":["optionType"],"additionalProperties":false}]},"migrationBgpCommunity":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minimum":1,"maximum":4294967295,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]}},"required":["optionType"],"additionalProperties":false}]},"enableManagementRegion":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"boolean","enum":[false]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"managementRegion":{"description":"Management Region","type":"object","properties":{"vrfId":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minimum":1,"maximum":65531,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]}},"required":["optionType"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"gatewayPreference":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"items":{"minimum":1,"maximum":63,"type":"integer"},"minItems":1,"maxItems":8,"uniqueItems":true,"type":"array"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]}},"required":["optionType"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"managementGateway":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"boolean","enum":[false]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":[],"additionalProperties":false}},"required":[],"additionalProperties":false}},"required":["name","data"],"x-metadata":{"minVManageVersion":"20.15.1"},"additionalProperties":false},"$$ref":"#/components/examples/ProfileparcelSdwanSystemMrfCommonRequest_ResolvedSchema"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile \u003e System \u003e Mrf-read","method":"get","path":"/v1/feature-profile/sdwan/system/mrf/schema"}}