Procedures

Automation procedures in the HTTP book.

The following documentation is for HTTP v1.6.18 (BDK).

Ensure that you have installed or connected the HTTP book and created a new playground before using these automation procedures.

to delete a url

Make a DELETE request to the specified url.

Input Concepts

Concept	Description	Type	Required	Default Value
url	The URL to make the DELETE request to.	text	Yes	(no default)
headers	The headers to include in the request. For example {"Authorization": "Bearer "}. Note: If connect is set, "Authorization" header will be added automatically to the request and manually set "Authorization" header will be ignored.	json	No	(no default)

Output Concepts

Concept	Description	Type
answer	The response from the DELETE request.	`` or file or list of or text

Examples

Delete a post with the following details

delete "https://jsonplaceholder.typicode.com/posts/1"

Delete a post with Authentication header

create a json
use the above as the headers input
set the headers input's "Authentication" to "Bearer <token>"
delete "https://jsonplaceholder.typicode.com/posts/1"
... the headers is the headers input

to head a url

Make a HEAD request to the specified url.

Input Concepts

Concept	Description	Type	Required	Default Value
url	The URL to make the HEAD request to.	text	Yes	(no default)
headers	The headers to include in the request. For example {"Authorization": "Bearer "}. Note: If connect is set, "Authorization" header will be added automatically to the request and manually set "Authorization" header will be ignored.	json	No	(no default)

Output Concepts

Concept	Description	Type
answer	The response from the HEAD request.	`` or file or list of or text

Examples

Get the headers of a post with the following details

head "https://jsonplaceholder.typicode.com/posts/1"

Get the headers of a post with Authentication header

create a json
use the above as the headers input
set the headers input's "Authentication" to "Bearer <token>"
head "https://jsonplaceholder.typicode.com/posts/1"
... the headers is the headers input

to patch payload on a url

Make a PATCH request to the specified url.

Input Concepts

Concept	Description	Type	Required	Default Value
url	The URL to make the PATCH request to.	text	Yes	(no default)
payload	The payload to include in the request.	`` or file or list of or text	Yes	(no default)
headers	The headers to include in the request. For example {"Authorization": "Bearer "}. Note: If connect is set, "Authorization" header will be added automatically to the request and manually set "Authorization" header will be ignored.	json	No	(no default)

Output Concepts

Concept	Description	Type
answer	The response from the PATCH request.	`` or file or list of or text

Examples

Update a post with the following details

create a json
use the above as the post json
set the post json's title to "My Post Title"
set the post json's body to "Awesome Body"
set the post json's userId to 1
patch the post json on "https://jsonplaceholder.typicode.com/posts/1"

Update a post with Authentication header

create a json
use the above as the post json
set the post json's title to "My Post Title edited"
set the post json's body to "Awesome Body"
set the post json's userId to 1
create a json
use the above as the headers input
set the headers input's "Authentication" to "Bearer <token>"
patch the post json to "https://jsonplaceholder.typicode.com/posts"
... the headers is the headers input

to post payload to a url

Make a POST request to the specified url.

Input Concepts

Concept	Description	Type	Required	Default Value
url	The URL to make the POST request to.	text	Yes	(no default)
payload	The payload to include in the request.	`` or file or list of or text	Yes	(no default)
headers	The headers to include in the request. For example {"Authorization": "Bearer "}. Note: If connect is set, "Authorization" header will be added automatically to the request and manually set "Authorization" header will be ignored.	json	No	(no default)

Output Concepts

Concept	Description	Type
answer	The response from the POST request.	`` or file or list of or text

Examples

Create a new post with the following details

create a json
use the above as the post json
set the post json's title to "My Post Title"
set the post json's body to "Awesome Body"
set the post json's userId to 1
post the post json to "https://jsonplaceholder.typicode.com/posts"

Create a new post with Authentication header

create a json
use the above as the post json
set the post json's title to "My Post Title"
set the post json's body to "Awesome Body"
set the post json's userId to 1
create a json
use the above as the headers input
set the headers input's "Authentication" to "Bearer <token>"
post the post json to "https://jsonplaceholder.typicode.com/posts"
... the headers is the headers input

to put payload on a url

Make a PUT request to the specified url.

Input Concepts

Concept	Description	Type	Required	Default Value
url	The URL to make the PUT request to.	text	Yes	(no default)
payload	The payload to include in the request.	`` or file or list of or text	Yes	(no default)
headers	The headers to include in the request. For example {"Authorization": "Bearer "}. Note: If connect is set, "Authorization" header will be added automatically to the request and manually set "Authorization" header will be ignored.	json	No	(no default)

Output Concepts

Concept	Description	Type
answer	The response from the PUT request.	`` or file or list of or text

Examples

Update a post with the following details

create a json
use the above as the post json
set the post json's title to "My Post Title edited"
set the post json's body to "Awesome Body"
set the post json's userId to 1
put the post json on "https://jsonplaceholder.typicode.com/posts/1"

Update a post with Authentication header

create a json
use the above as the post json
set the post json's title to "My Post Title edited"
set the post json's body to "Awesome Body"
set the post json's userId to 1
create a json
use the above as the headers input
set the headers input's "Authentication" to "Bearer <token>"
put the post json on "https://jsonplaceholder.typicode.com/posts"
... the headers is the headers input

to retrieve a url

FILTER - CAPABLE

Make a GET request to the specified url.

Input Concepts

Concept	Description	Type	Required	Default Value
url	The URL to make the GET request to.	text	Yes	(no default)
headers	The headers to include in the request. For example {"Authorization": "Bearer "}. Note: If connect is set, "Authorization" header will be added automatically to the request and manually set "Authorization" header will be ignored.	json	No	(no default)

Output Concepts

Concept	Description	Type
answer	The response from the GET request.	`` or file or list of or text

Examples

Retrieve all posts

retrieve "https://jsonplaceholder.typicode.com/posts"

Retrieve a post with id 1

retrieve "https://jsonplaceholder.typicode.com/posts/1"

Retrieve all posts by a user with id 1

retrieve "https://jsonplaceholder.typicode.com/posts" whose "userId" is 1

Retrieve all posts with Authenticated header

create a json
use the above as the headers input
set the headers input's "Authentication" to "Bearer <token>"
retrieve "https://jsonplaceholder.typicode.com/posts"
... the headers is the headers input