Tool Studio
The Tool Studio entities live under /platform/extensions. They are the same objects you build in Tool Studio, so you can create and update them from code instead of the Tool Studio UI.
Each collection supports list, create, get and update. There is no delete.
Build in order
A resource has to exist before anything that refers to it. Create them in this order, and keep the id from each response:
Send writes one at a time. Writes aren’t transactional: if a later step fails, the resources you already created stay, so reuse them or clean them up in Tool Studio.
id or name?
Most references take the other resource’s id. Two take a name:
A 400 with REFERENCE_VALIDATION_FAILED usually means a name was sent where an id belongs, or the other way around.
How updates work
PATCH /platform/extensions/<collection>/{id} takes a JSON merge-patch:
- A field you leave out keeps its stored value, and
nullclears it. - Nested objects merge field by field.
- Lists of objects merge row by row instead of being replaced. To remove or reorder rows, read the document and send the whole list back.
- Lists of strings, Data Mapper expressions (
*_bender,input_mapper,output_mapper), JSON schemas,workflow_stepsandresolver_methodsare replaced whole. - Fields that are alternatives to each other, such as
allow_allandallow_emails, switch when you send the other one. Sending both is rejected. - Send
version.numfrom your last read with achange_description. If the document changed since then, the update returns409; read it again and retry.
Data Mapper fields in these collections take the short form, for example {"po_number": "data.po_number"}. Rules such as condition, skip_execution_condition and allowlist_rule are DSL. See MWDSL & Bender.
Reading
- Reads return every field. Unset fields come back as empty values:
"",0,false,[]ornull. - Secrets come back redacted and can’t be read back.
- To copy a resource, remove
id,updated_time,updated_byandversion.numfrom the read body before you send it as a create.
There is no endpoint that runs an action or a plugin. After you create one, test it in Tool Studio, or try the plugin in chat as someone on its allow list.