Data / Create comment thread replies

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 create comment thread replies.

Task name:

Examples

Add a reply to a comment thread

{
    "name": "data-comment-thread-create-reply",
    "taskReferenceName": "create_reply",
    "description": "Add a reply to a comment thread",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "request": {
            "method": "INLINE",
            "contentType": "application/json",
            "model": "default",
            "json": {
                "operations": [
                    {
                        "key": "a",
                        "context": {
                            "commentThreadId": "12345"
                        },
                        "element": {
                            "message": "This is a reply to the comment thread"
                        }
                    }
                ]
            }
        }
    }
}

Add replies to multiple comment threads

{
    "name": "data-comment-thread-create-reply",
    "taskReferenceName": "create_replies",
    "description": "Add replies to multiple comment threads",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "request": {
            "method": "INLINE",
            "contentType": "application/json",
            "model": "default",
            "json": {
                "operations": [
                    {
                        "key": "a",
                        "context": {
                            "commentThreadId": "12345"
                        },
                        "element": {
                            "message": "Reply to first thread"
                        }
                    },
                    {
                        "key": "b",
                        "context": {
                            "commentThreadId": "12346"
                        },
                        "element": {
                            "message": "Reply to second thread"
                        }
                    }
                ]
            }
        }
    }
}

TIP

See below for more examples using JSON and XML inputs.

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 properties

Property	Type	Required	Description
			The ID of the comment thread to reply to

Reply element properties

Property	Type	Required	Description
			The content of the reply message

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 comment threads API.
• json is the default output key but may be changed by setting the outputKey property.

XML output - outputs[].outputMode=ATTACHMENT and outputs[].mediaType=application/xml

Additional examples

Create a single comment thread reply - XML input & output

job.json

{
    "name": "data-comment-thread-create-reply",
    "taskReferenceName": "create_comment_thread_reply",
    "description": "Create a single comment thread reply",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "request": {
            "method": "ATTACHMENT",
            "contentType": "application/xml",
            "model": "default",
            "file": "@my-request.xml"
        },
        "outputs": [
            {
                "mediaType": "application/xml",
                "outputMode": "ATTACHMENT",
                "outputKey": "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="commentThreadId">1</string>
            </map>
            <map key="element">
                <string key="message">This is a reply to the comment thread</string>
            </map>
        </map>
    </array>
</map>

Create many comment thread replies - XML input & output

job.json

{
    "name": "data-comment-thread-create-reply",
    "taskReferenceName": "create_comment_thread_replies",
    "description": "Create many comment thread replies",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "request": {
            "method": "ATTACHMENT",
            "contentType": "application/xml",
            "model": "default",
            "file": "@my-request.xml"
        },
        "outputs": [
            {
                "mediaType": "application/xml",
                "outputMode": "ATTACHMENT",
                "outputKey": "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="commentThreadId">1</string>
            </map>
            <map key="element">
                <string key="message">This is a reply to the comment thread</string>
            </map>
        </map>
        <map>
            <string key="key">b</string>
            <map key="context">
                <string key="commentThreadId">2</string>
            </map>
            <map key="element">
                <string key="message">This is another reply</string>
            </map>
        </map>
    </array>
</map>

Create a single comment thread reply - JSON input & output

job.json

{
    "name": "data-comment-thread-create-reply",
    "taskReferenceName": "create_comment_thread_reply",
    "description": "Create a single comment thread reply",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "request": {
            "method": "ATTACHMENT",
            "contentType": "application/json",
            "model": "default",
            "file": "@my-request.json"
        },
        "outputs": [
            {
                "mediaType": "application/json",
                "outputMode": "ATTACHMENT",
                "outputKey": "json"
            }
        ]
    }
}

my-request.json

{
    "operations": [
        {
            "key": "a",
            "context": {
                "commentThreadId": "1"
            },
            "element": {
                "message": "This is a reply to the comment thread"
            }
        }
    ]
}

Create many comment thread replies - JSON input & output

job.json

{
    "name": "data-comment-thread-create-reply",
    "taskReferenceName": "create_comment_thread_replies",
    "description": "Create many comment thread replies",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "request": {
            "method": "ATTACHMENT",
            "contentType": "application/json",
            "model": "default",
            "file": "@my-request.json"
        },
        "outputs": [
            {
                "mediaType": "application/json",
                "outputMode": "ATTACHMENT",
                "outputKey": "json"
            }
        ]
    }
}

my-request.json

{
    "operations": [
        {
            "key": "a",
            "context": {
                "commentThreadId": "1"
            },
            "element": {
                "message": "This is a reply to the comment thread"
            }
        },
        {
            "key": "b",
            "context": {
                "commentThreadId": "2"
            },
            "element": {
                "message": "This is another reply"
            }
        }
    ]
}