Data Types
platform.extensions.data-types
A data type describes a business object, such as a purchase order, and how the assistant finds the right one when a user mentions it: by looking it up through an action, or from a fixed list of options.
To learn what data types do, see Data Types in the Tool Studio docs.
- Endpoint:
/platform/extensions/data-types| Methods: GET, PATCH, POST - Request shape: fields go at the top level of the JSON body, with no
resourcewrapper. The item’sidgoes in the URL for reads and updates, not in the body. - Updates: a JSON merge-patch with
version: {num, change_description}from your last read. Lists of objects merge row by row, so read first and send the whole list when you remove or reorder rows. See Tool Studio. - References: Slots and arguments use the type by its
name(for example{"custom": "u_PurchaseOrder"}), not itsid. Adynamic_lookupresolver calls an HTTP action by the action’sid.
Endpoints
All paths are relative to https://api.moveworks.ai/configurations/v1alpha1. Each endpoint page lists the request and response schema, an example, and the errors it can return.
Rules the API checks
- The server sets
namefromfriendly_name(“Purchase Order” becomesu_PurchaseOrder). Don’t send it, and it can’t be changed. friendly_nameis 3–64 characters anddescriptionis 3–256 characters.resolution_strategy.namecan’t be changed after creation. On update,resolver_methodsis replaced whole.- Set
system_usage_config.mentionable_fieldsandidentifiable_fieldsso the assistant can cite and identify records of this type.