Skip to main content
POST
/
generate-document-on-demand
Generate an on-demand document
curl --request POST \
  --url https://api.example.com/generate-document-on-demand \
  --header 'Content-Type: application/json' \
  --data '
{
  "productId": "<string>",
  "configName": "<string>",
  "targetId": "<string>",
  "branchId": "<string>",
  "metadata": [
    "<string>"
  ]
}
'
import requests

url = "https://api.example.com/generate-document-on-demand"

payload = {
"productId": "<string>",
"configName": "<string>",
"targetId": "<string>",
"branchId": "<string>",
"metadata": ["<string>"]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
productId: '<string>',
configName: '<string>',
targetId: '<string>',
branchId: '<string>',
metadata: ['<string>']
})
};

fetch('https://api.example.com/generate-document-on-demand', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/generate-document-on-demand",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'productId' => '<string>',
'configName' => '<string>',
'targetId' => '<string>',
'branchId' => '<string>',
'metadata' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/generate-document-on-demand"

payload := strings.NewReader("{\n \"productId\": \"<string>\",\n \"configName\": \"<string>\",\n \"targetId\": \"<string>\",\n \"branchId\": \"<string>\",\n \"metadata\": [\n \"<string>\"\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/generate-document-on-demand")
.header("Content-Type", "application/json")
.body("{\n \"productId\": \"<string>\",\n \"configName\": \"<string>\",\n \"targetId\": \"<string>\",\n \"branchId\": \"<string>\",\n \"metadata\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/generate-document-on-demand")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"productId\": \"<string>\",\n \"configName\": \"<string>\",\n \"targetId\": \"<string>\",\n \"branchId\": \"<string>\",\n \"metadata\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "attachmentId": "<string>"
}

Body

application/json
productId
string
required

The productId

configName
string
required
targetId
string
required
branchId
string
metadata
string[]

Response

attachmentId
string