Learning Center

HTTP ​

The HTTP perform Data Factory task is in phase and is not yet available to users. 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 perform HTTP calls.

Examples ​

json
{
    "name": "protocol-http-perform",
    "taskReferenceName": "The business title of the task",
    "description": "The business description of the task",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "scheme": "HTTPS",
        "method": "GET",
        "domain": "api.product-live.com",
        "path": "/v1/items",
        "headers": {
            "X-Api-Key": "<REDACTED>",
            "Accept": "application/json"
        },
        "connectionTimeOutMilliseconds": 10000
    }
}
json
{
    "name": "protocol-http-perform",
    "taskReferenceName": "The business title of the task",
    "description": "The business description of the task",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "scheme": "HTTPS",
        "method": "GET",
        "domain": "api.product-live.com",
        "path": "/v1/items",
        "headers": {
            "X-Api-Key": "<REDACTED>",
            "Accept": "application/json"
        },
        "queryParameters": {
            "page": "0",
            "size": "10"
        },
        "connectionTimeOutMilliseconds": 10000
    }
}
json
{
    "name": "protocol-http-perform",
    "taskReferenceName": "The business title of the task",
    "description": "The business description of the task",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "scheme": "HTTPS",
        "method": "POST",
        "domain": "api.product-live.com",
        "path": "/v1/items/itemFind/table/3657/partition/11/level/3563",
        "headers": {
            "X-Api-Key": "<REDACTED>",
            "Accept": "application/json"
        },
        "connectionTimeOutMilliseconds": 10000,
        "body": {
            "type": "JSON",
            "json": [
                {
                    "keyName": "EAN",
                    "stringEquals": [ "3541361805066" ]
                }
            ]
        }
    }
}
json
{
    "name": "protocol-http-perform",
    "taskReferenceName": "The business title of the task",
    "description": "The business description of the task",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "scheme": "HTTPS",
        "method": "POST",
        "domain": "api.product-live.com",
        "path": "/v1/data_factory/files",
        "headers": {
            "X-Api-Key": "<REDACTED>",
            "Accept": "application/json"
        },
        "connectionTimeOutMilliseconds": 10000,
        "body": {
            "type": "MULTIPART_FORM",
            "form": [
                {
                    "name": "file",
                    "type": "FILE",
                    "contentType": "multipart/form-data",
                    "file": "file://assets/table-import-schema.xml",
                    "filename": "table-import-schema.xml"
                }
            ]
        }
    }
}

Definition ​

PropertyTypeRequiredDescription
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 ​

PropertyTypeDescription
: , The scheme of the service
Default: HTTPS

The complete domain of the service
No validation is performed on the domain name. The domain name must not contain the scheme, the port or the path
The domain must be at least 1 character long
example: api.product-live.com
The port of the service
Default if scheme = HTTP : 80, if scheme = HTTPS : 443
example: 8080
The path of the service
example: /v1/items
:





The method of the request
Default: GET
example: POST
A JSON object containing the headers of the request
Max number of headers is 100
Max length of a header name is 100 characters
Max length of a header value is 10 000 characters
example: {"X-Api-Key": "<REDACTED>"}
A JSON object containing the query parameters of the request
Max number of query parameters is 100
Max length of a query parameter name is 100 characters
Max length of a query parameter value is 10 000 characters
example: {"page": "1"}
The body of the request
: , The type of the body
Default: JSON
The body of the request in JSON format
example: {"name": "example"}
The body of the request in Form format
The name of the form data
example: name
: , The type of the form data
example: TEXT
The text value
example: text value
The file representation
example: {"object": "data_factory_file","id": "string","url": "string","filename": "string"}
The content type of the form data if the type is file. If not specified, the content type is deduced from the filename.
example: image/jpeg
The filename of the form data if the type is file. If not specified, the filename is deduced from the url.
example: file.txt
The connection timeout in milliseconds, if the value is 0 then no timeout is set
Default: 1000
example: 5000
The read timeout in milliseconds, if the value is 0 then no timeout is set
Default: 150
example: 1000

Outputs ​

PropertyTypeDescription
The status code of the response
example: 200
The reason phrase of the response
example: OK
The headers of the response
example: {"Content-Type": "application/json"}
The body of the response in JSON format
example: {"name": "example"}
The body of the response in File format
example: {"object": "data_factory_file","id": "string","url": "string","filename": "string"}
The curl command to reproduce the request
example: curl -X GET "https://api.product-live.com/v1/items" -H "X-Api-Key: <REDACTED>" -H "Accept: application/json"
The X-API-Key value is obfuscated for security reasons
The URL of the request
example: https://api.product-live.com/v1/items