JSON Object - Delete from

Declaration

<AMJSON ACTIVITY="delete_from" JSONOBJECT="text" PATH="text" DELETEBY="text (options)" INDEX="number" />

Related Topics    

Description

Deletes one or all values from an existing array inside a Automate JSON Object.

Practical Usage

JSON is primarily used to transmit data between a server and web application, as an alternative to XML. Use this activity to delete one or all values from an existing array inside an Automate JSON Object.

Parameters

General

Property Type Required Default Markup Description
JSON Object name Text Yes (Empty) JSONOBJECT="donuts" The name of the JSON Object containing the array to delete from.
Array to delete from Text Yes (Empty) PATH="type" The name of the array to delete one or all values from. To select an array, click Select array, and then from the dialog that appears, choose the desired array by clicking its hyperlink.
What to delete Text (options) Yes By index
  • DELETEBY="index"
  • DELETEBY="all"
 Specifies which value(s) to delete from the array. The available options are:
  • By index - Deletes a value from the array, based on its index number.
  • All children - Deletes all available values in the array.
Index to delete Text Yes (Empty) INDEX="3" Specifies the index number of the value to delete from the array. This parameter becomes available and is required when What to delete is set to By index.

Description

Error Causes

On Error

Example

NOTE:
  • The sample AML code below can be copied and pasted directly into the Steps Panel of the Task Builder.
  • Parameters containing user credentials, files, file paths, and/or other information specific to the task must be customized before the sample code can run successfully.

Description

This sample task deletes a value by its index number from an array inside an Automate JSON Object.

Copy 
<AMJSON JSONOBJECT="donuts" JSONSTRING="{&#xD;&#xA;    &quot;id&quot;: &quot;0001&quot;,&#xD;&#xA;    &quot;type&quot;: &quot;donut&quot;,&#xD;&#xA;    &quot;name&quot;: &quot;Cake&quot;,&#xD;&#xA;    &quot;ppu&quot;: 0.55,&#xD;&#xA;    &quot;batters&quot;:&#xD;&#xA;        {&#xD;&#xA;            &quot;batter&quot;:&#xD;&#xA;                [&#xD;&#xA;                    { &quot;id&quot;: &quot;1001&quot;, &quot;type&quot;: &quot;Regular&quot; },&#xD;&#xA;                    { &quot;id&quot;: &quot;1002&quot;, &quot;type&quot;: &quot;Chocolate&quot; },&#xD;&#xA;                    { &quot;id&quot;: &quot;1003&quot;, &quot;type&quot;: &quot;Blueberry&quot; },&#xD;&#xA;                    { &quot;id&quot;: &quot;1004&quot;, &quot;type&quot;: &quot;Devil's Food&quot; }&#xD;&#xA;                ]&#xD;&#xA;        },&#xD;&#xA;    &quot;topping&quot;:&#xD;&#xA;        [&#xD;&#xA;            { &quot;id&quot;: &quot;5001&quot;, &quot;type&quot;: &quot;None&quot; },&#xD;&#xA;            { &quot;id&quot;: &quot;5002&quot;, &quot;type&quot;: &quot;Glazed&quot; },&#xD;&#xA;            { &quot;id&quot;: &quot;5005&quot;, &quot;type&quot;: &quot;Sugar&quot; },&#xD;&#xA;            { &quot;id&quot;: &quot;5007&quot;, &quot;type&quot;: &quot;Powdered Sugar&quot; },&#xD;&#xA;            { &quot;id&quot;: &quot;5006&quot;, &quot;type&quot;: &quot;Chocolate with Sprinkles&quot; },&#xD;&#xA;            { &quot;id&quot;: &quot;5003&quot;, &quot;type&quot;: &quot;Chocolate&quot; },&#xD;&#xA;            { &quot;id&quot;: &quot;5004&quot;, &quot;type&quot;: &quot;Maple&quot; }&#xD;&#xA;        ]&#xD;&#xA;}" />
<AMJSON ACTIVITY="delete_from" JSONOBJECT="donuts" PATH="batters.batter" DELETEBY="index" INDEX="1" />