Data / Apply all suggestion fields

Task in alpha phase

This Data Factory task is in phase. You can contact the Product-Live team at contact@product-live.com if you want more details and get an early access.

This task allows to apply all fields from a suggestion, including any deleted fields. Unlike data-suggestion-apply, this task ensures that the target item exactly matches the suggestion by also removing any fields that were deleted in the suggestion.

Task name:

Examples

JSON input

{
    "name": "data-suggestion-apply-all",
    "taskReferenceName": "apply_all_suggestion",
    "description": "Apply all fields from suggestion including deletions",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "request": {
            "method": "INLINE",
            "contentType": "application/json",
            "model": "default",
            "json": {
                "operations": [
                    {
                        "key": "a",
                        "context": {
                            "suggestionId": "45678"
                        },
                        "element": {
                            "isAcknowledged": true
                        }
                    }
                ]
            }
        }
    }
}

XML input

{
    "name": "data-suggestion-apply-all",
    "taskReferenceName": "apply_all_suggestion",
    "description": "Apply all fields from suggestion",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "request": {
            "method": "ATTACHMENT",
            "contentType": "application/xml",
            "model": "default",
            "file": "@my-request.xml"
        }
    }
}

Definition

Property	Type	Required	Description
			The name (or type) of the task
			The unique name of the task in your job. It is used to reference this task in the workflow.
			The functional description of this task in your job.
			The type of the task. It must be SUB_WORKFLOW.
	:		true: the job continues if there is an error on this task. false: the job fails.
			Input parameters of the task. See below

Inputs Parameters

Property	Type	Required	Description
			The Product-Live API key. If not provided, an automaticaly generated API key will be used to perform the request on behalf of the current user. If provided, the given API key will be used to perform the request.
			See below
			To day, application/json and application/xml are supported.
			INLINE: The request body is provided inline in the request object. ATTACHMENT: The request body is provided as an attachment in the request object.
			The request body as a JSON object.
			See below
			A unique key to identify the element in the batch. This key will be associated to the element in the output.
			The element to create or update. See examples below
			Some element may require additional context to be created or updated.
			The request body as a file.
			The outputs of the request. Default: [{"mediaType": "application/json", "outputMode": "INLINE", "outputKey": "json"}].
			The media type of the output. To day, application/json and application/xml are supported.
			INLINE: The output is provided inline in the output object. ATTACHMENT: The output is provided as an attachment in the output object. INLINE is only supported for mediaType=application/json
			The key of the output. Either json or xml
			Default: DEFAULT. The model/format used in the output. To day, only 'DEFAULT' is supported.

contentType=application/json

• The expected elements are the entities described in the Product-Live API.
• See examples below for more details.

One element

{
    "operations": [
        {
            "key": "a",
            "element": {
                "...": "..."
            }
        }
    ]
}

Multiple elements

{
    "operations": [
        {
            "key": "a",
            "element": {
                  "...": "..."
            }
        }, {
            "key": "b",
            "element": {
              "...": "..."
            }
        }
    ]
}

Context requirements

Property	Type	Required	Description
			The ID of the suggestion to apply

Suggestion apply-all element properties

Property	Type	Required	Description
			Set to true to apply the suggestion

contentType=application/xml

• This XML representation follow the one used by the JSON query language of the Product-Live API.
• The expected elements are the entities described in the Product-Live API.
• See examples below for more details.

One element

<?xml version="1.0" encoding="UTF-8"?>
<map xmlns="http://www.w3.org/2005/xpath-functions">
  <array key="operations">
    <map>
      <string key="key">a</string>
      <map key="context"></map>
      <map key="element">
        <string key="...">...</string>
      </map>
    </map>
  </array>
</map>

Outputs

Property	Type	Description
		An object containing the outputs of the task. Each output key is the key of the output defined in the outputs[][outputKey] input parameter.

Example

If your input parameters is as follows:

{
    "...": "...",
    "outputs": [
        {
            "mediaType": "application/json", 
            "outputMode": "INLINE", 
            "outputKey": "json_inline"
        },        
        {
            "mediaType": "application/xml", 
            "outputMode": "ATTACHMENT", 
            "outputKey": "xml_attachment"
        }
    ]
}

The output will be as follows:

{
    "outputs": {
        "json_inline": {
            "...": "...",
            "...": "..."
        },
        "xml_attachment": {
            "url": "..."
        }
    }
}

Json output - outputs[].outputMode=INLINE and outputs[].mediaType=application/json

• output.json is an array of objects as defined in the suggestions API.
• json is the default output key but may be changed by setting the outputKey property.

Example output:

[
    {
        "key": "a",
        "response": {
            "object": "suggestion",
            "id": "45678",
            "updatedAt": "2024-05-17T11:00:00.000Z",
            "isAcknowledged": true
        }
    }
]

Limits and additional notes

• When the outputMode=INLINE is selected, the maximum number of elements returned by this task is limited to 1000. If more elements are to be returned, the task ends with an error. To export up to the maximum of elements, use the limit input parameter to limit the number of elements return.

• The creation and update of suggestions is limited to 50 suggestions per minute.

TIP

Use data-suggestion-apply-all when you want to fully synchronize the target item with the suggested values, including the removal of fields that were deleted in the suggestion. Use data-suggestion-apply when you only want to add/update specific fields without removing any.

Additional examples

Apply all suggestion fields with XML input

job.json

{
    "name": "data-suggestion-apply-all",
    "taskReferenceName": "apply_all_suggestion",
    "description": "Apply all suggestion fields with XML",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "request": {
            "method": "ATTACHMENT",
            "contentType": "application/xml",
            "model": "default",
            "file": "@my-request.xml"
        }
    }
}

my-request.xml

<?xml version="1.1" encoding="UTF-8"?>
<map xmlns="http://www.w3.org/2005/xpath-functions">
    <array key="operations">
        <map>
            <string key="key">a</string>
            <map key="context">
                <string key="suggestionId">45678</string>
            </map>
            <map key="element">
                <boolean key="isAcknowledged">true</boolean>
            </map>
        </map>
    </array>
</map>

Apply all fields from many suggestions

job.json

{
    "name": "data-suggestion-apply-all",
    "taskReferenceName": "apply_all_suggestions",
    "description": "Apply all fields from many suggestions",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "failOnError": true,
        "request": {
            "method": "INLINE",
            "contentType": "application/json",
            "model": "default",
            "json": {
                "operations": [
                    {
                        "key": "a",
                        "context": {
                            "suggestionId": "45678"
                        },
                        "element": {
                            "isAcknowledged": true
                        }
                    },
                    {
                        "key": "b",
                        "context": {
                            "suggestionId": "45679"
                        },
                        "element": {
                            "isAcknowledged": true
                        }
                    }
                ]
            }
        }
    }
}