We’re excited to announce the general availability of two powerful new enhancements to the Parameters API — custom Enumerations and Specs! These additions empower developers to build their own Specs based on the customized Enumerations.
What’s New
This enhancement includes 2 new sets of APIs:
-
Create and Manage Enumerations — define your own enumerated value sets (e.g., material categories, status lists), which can be used to create your own specifications.
- GET v1/enumerations - List all the Enums from the ACC account.
- POST v1/enumerations:batch-create - Batch creates new enumeration definitions, 50 maximum per request.
- PATCH v1/enumerations:batch-update - Batch updates the definition of the enumerations, 50 maximum per request.
- PATCH v1/enumerations/{enumerationId} - Updates an enumeration definition.
-
Create and Manage Specs — define your own specifications based on the customized enumerations above.
- GET v1/specs - This endpoint is enhanced, by default it lists all system specs, but if accountId is provided in the query string parameters, it will list the user defined specs.
- POST v1/specs:batch-create - Batch creates customized specs, 50 maximum per request.
- PUT v1/specs:batch-update - Batch updates the customized specs to use the latest version of enumeration.
- PUT v1/specs/{specId} - Updates the specified spec to use the latest version of enumeration.
Tips/Limitations:
- The Enumerations and Specs are all version based, but the current API only retrieve the latest version. If you have a request to work with old versions, please provide your feedback to us.
- Whenever an update to the enumeration, a new version of enumeration will automatically generated, refer semantic versioning rule here. And you can simply update the corresponding Spec to make it pointing to the latest version of enumeration.
Documentation
- Field Guide: This page enhanced with the new terminology of Enumeration and Spec, it support user defined spec which is based on the customized enumeration.
- API Reference: This section lists 2 sets of endpoints for operating Enumerations and Specs.
- Step-by-Step Tutorials: The new tutorial demonstrates workflow to create Enumerations, and also create your customized Specs based on the enumerations, finally, create the parameter using the new customized spec.
If you have any questions or feedback, please don't hesitate to contact us through our APS support channel.