Summary
Starting with Nexus 3, CMiC will verify that a non-empty, non-null value VUuid value that's submitted matches the new standard dashed hexadecimal format.
What's Changing
Beginning with Nexus 3, CMiC will verify that any third-party-supplied UUID-type field value matches the standard dashed hexadecimal format below:
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
- 32 hexadecimal characters (0-9, a-f)
- 5 groups separated by 4 hyphens
- Group lengths of 8-4-4-4-12
- 36 characters total, including hyphens
Example of a valid VUuid submitted value:
f47ac10b-58cc-4372-a567-0e02b2c3d479
Example of the old Oracle GUID format value:
DAFEB6731BC32EA2E0530100007F3979
If the VUuid field is omitted from the payload, CMiC will auto-generate a value in the dashed hexadecimal format described above.
NOTE: Due to legacy code, CMiC will support the auto-generation of both Oracle’s GUID and hexadecimal VUuid formats until Nexus 3. After that Values that do not match this pattern (including, one with non-hexadecimal characters, missing hyphens, or incorrect group lengths) will cause the request to fail.
Why This Change Is Being Made
This policy improves data integrity across integrations by ensuring VUuid values across all POST request payloads are consistently formatted and safely comparable at the database level, reducing downstream errors caused by malformed identifiers.
What Integrators Need to Do
You have two options for any request that includes a VUuid field:
- Send a properly formatted value. If your integration already generates or stores UUIDs, ensure the value passed conforms to the dashed format described above.
- Omit the field. If your system cannot guarantee a value in the accepted format, do not include the UUID-type field in the payload. CMiC will automatically generate a valid value natively for the record.
NOTE: Sending a malformed or partially-formed VUuid value (rather than omitting it) will result in a rejected request. When in doubt, omit the field.
Action Required
- Review any integration workflows that currently populate VUuid fields.
- Confirm that generated values match the required format or update your integration to omit the field where compliant generation isn't feasible.