Page instructions for embedded pages
You can use page instructions to specify whether an embedded page within the post data should be updated, replaced, or removed from your case.
The following page instructions are available:
UPDATE
REPLACE
DELETE
myEmbeddedPage
.Prop1 – “value1”
.Prop2 – “value2”
Update
You use UPDATE
to add a new field to an embedded page.
The following example is the post body when the UPDATE
page
instruction is added:
“pageInstructions” : [{
“instruction” : “UPDATE”,
“target” : “myEmbeddedPage”,
content : {
“Prop3” : “value3”,
}
}]
.Prop3 - "value3"
is added to the embedded page:
myEmbeddedPage
.Prop1 – “value1”
.Prop2 – “value2”
.Prop3 – “value3”
Replace
You use REPLACE
to replace an existing embedded page with a new
embedded page.
The following example is the post body when the REPLACE
page
instruction is added:
“pageInstructions” : [{
“instruction” : “REPLACE”,
“target” : “myEmbeddedPage”,
content : {
“Prop3” : “value3”,
}
}]
The .Prop1 – “value1”
and .Prop2 – “value2”
properties in your case are replaced with the “Prop3” : “value3”
property that you specified in the content section of the post body:
myEmbeddedPage
.Prop3 – “value3”
Delete
You use DELETE
to delete an embedded page.
The following example is the post body when the DELETE
page
instruction is added:
“pageInstructions” : [{
“instruction” : “DELETE”,
“target” : “myEmbeddedPage”
}]
myEmbeddedPage
is removed from the case.
Previous topic Page-related operation queuing with page instructions Next topic Page instructions for page groups