TaskREST

Inputs

Outputs

Constants

Methods

Example

import flow_api
def handler(system: flow_api.System, this: flow_api.Execution):
    # create a REST task and run it
    task = this.task('REST', url='https://api.icndb.com/jokes/random')
    # access a field of the JSON response
    joke = task.get('output_value')['json']['value']['joke']
    # end with a joke
    return this.success(message=joke)

More

Specify parts of URL

Alternatively to specifying the full URL it is possible to specify different parts of the URL separately:

import flow_api
def handler(system: flow_api.System, this: flow_api.Execution):
    # the resulting URL will be
    # https://httpbin.org/anything/some/path?query=parameter
    task = this.task(
        'REST',
        hostname='httpbin.org',
        base_url='anything'
        url='some/path'
        params={
            'query': 'parameter',
        },
    )
    return this.success('all done')

Sending multipart POST requests

The Cloudomation REST connector can be used to upload files using a multipart POST request. Here are some usage examples:

Basic example

Specify a value in the part for a string payload, or specify a file in the part to upload a file from the Cloudomation files resource.

this.task(
    'REST',
    url='https://httpbin.org/post',
    method='POST',
    multipart={
        'parts': [
            {
                'name': 'string-field',
                'value': 'spam & eggs',
            },
            {
                'name': 'file',
                'file': 'report.txt',
            },
        ],
    },
)

The example above will generate the following request:

Content-Length: '991'
Content-Type: multipart/mixed; boundary=aec30e9afc384303b6cb67e44aaa0f9c
--aec30e9afc384303b6cb67e44aaa0f9c
Content-Type: text/plain; charset=utf-8
Content-Disposition: form-data; name="string-field"
Content-Length: 11
spam & eggs
--aec30e9afc384303b6cb67e44aaa0f9c
Content-Type: text/plain; charset=utf-8
Content-Disposition: form-data; name="file"; filename="report.txt"
Content-Length: 608
...content of the report.txt file...
--aec30e9afc384303b6cb67e44aaa0f9c--

Full example

It is possible to modifiy the request being generated.

• Specify a custom content-type or boundary in the multipart dictionary to override the default values.
• Specify a custom content-type, content-disposition, or content-length in the part dictionary to override the default values.
• Specify False for content-type, content-disposition, or content-length in the part dictionary to omit the field in the request.

this.task(
    'REST',
    url='https://httpbin.org/post',
    method='POST',
    multipart={
        'content-type': 'application/my-custom-content-type',
        'boundary': 'my-custom-boundary',
        'parts': [
            {
                'name': 'string-field',
                'value': '<pre>spam & eggs</pre>',
                'content-type': 'text/html',
                'content-disposition': False,
                'content-length': False,
            },
            {
                'name': 'file',
                'file': 'report.txt',
                'content-disposition': 'form-data; filename="report.txt"',
            },
        ],
    },
)

The example above will generate the following request:

Content-Length: '848'
Content-Type: application/my-custom-content-type; boundary=my-custom-boundary
--my-custom-boundary
Content-Type: text/html
<pre>spam & eggs</pre>
--my-custom-boundary
Content-Type: text/plain; charset=utf-8
Content-Disposition: form-data; filename="report.txt"
Content-Length: 608
...content of the report.txt file...
--my-custom-boundary--