To add a new Text element on an Experiment and write content to it via API, use 【POST】/entities/{eid}/children/{filename}.
Example using Swagger:
- Open the Experiment where you want to add a Text element and obtain the eid from the URL*1
- Using an administrator account, navigate to "App Launcher > Signals Configuration > System Settings > API Key"
- Click "Open External API Document"
- Expand "Entities"
- Expand "POST /entities/{eid}/children/{filename}"
- Click "Try it out"
- Enter the following parameters:
- eid: The eid obtained in Step 1
- Filename: Title of the Text element
- Force: true*2
- Set Request body to "text/plain" and enter the text string to be written in the Text element
- Click "Execute"
Notes:
*1 When opening an Experiment, the URL will look like this: "<tenant URL>/elements/entity/experiment:.....?focus=…"
The eid is the portion from "experiment:" up to just before the "?"
Example: If the URL shows "...entity/experiment:036f7f67-c82e-44d8-8041-09da9b2f2217?focus=...", then "experiment:036f7f67-c82e-44d8-8041-09da9b2f2217" is the eid
*2 When setting a digest, do not set Force to True; instead, enter a value in the digest field.
* The administrator account used to open Swagger in Step 2 must have Write or Full Control permissions for the Experiment opened in Step 1.
Comments
0 comments
Article is closed for comments.