Skip to main content
POST
/
api
/
end_user_files
/
rename_rules
Create a file rename rule
curl --request POST \
  --url https://app.herondata.io/api/end_user_files/rename_rules \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "end_user_file_class": "<string>",
  "file_name_template": "<string>",
  "is_enabled": true,
  "variables": [
    {
      "description": "<string>",
      "examples": [
        "<string>"
      ],
      "key": "<string>",
      "name": "<string>"
    }
  ]
}
'
import requests

url = "https://app.herondata.io/api/end_user_files/rename_rules"

payload = {
"end_user_file_class": "<string>",
"file_name_template": "<string>",
"is_enabled": True,
"variables": [
{
"description": "<string>",
"examples": ["<string>"],
"key": "<string>",
"name": "<string>"
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
end_user_file_class: '<string>',
file_name_template: '<string>',
is_enabled: true,
variables: [
{
description: '<string>',
examples: ['<string>'],
key: '<string>',
name: '<string>'
}
]
})
};

fetch('https://app.herondata.io/api/end_user_files/rename_rules', 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://app.herondata.io/api/end_user_files/rename_rules",
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([
'end_user_file_class' => '<string>',
'file_name_template' => '<string>',
'is_enabled' => true,
'variables' => [
[
'description' => '<string>',
'examples' => [
'<string>'
],
'key' => '<string>',
'name' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$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://app.herondata.io/api/end_user_files/rename_rules"

payload := strings.NewReader("{\n \"end_user_file_class\": \"<string>\",\n \"file_name_template\": \"<string>\",\n \"is_enabled\": true,\n \"variables\": [\n {\n \"description\": \"<string>\",\n \"examples\": [\n \"<string>\"\n ],\n \"key\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}")

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

req.Header.Add("x-api-key", "<api-key>")
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://app.herondata.io/api/end_user_files/rename_rules")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"end_user_file_class\": \"<string>\",\n \"file_name_template\": \"<string>\",\n \"is_enabled\": true,\n \"variables\": [\n {\n \"description\": \"<string>\",\n \"examples\": [\n \"<string>\"\n ],\n \"key\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.herondata.io/api/end_user_files/rename_rules")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"end_user_file_class\": \"<string>\",\n \"file_name_template\": \"<string>\",\n \"is_enabled\": true,\n \"variables\": [\n {\n \"description\": \"<string>\",\n \"examples\": [\n \"<string>\"\n ],\n \"key\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "end_user_file_class": "<string>",
  "file_name_template": "<string>",
  "is_enabled": true,
  "heron_id": "<string>",
  "variables": [
    {
      "description": "<string>",
      "examples": [
        "<string>"
      ],
      "key": "<string>",
      "name": "<string>"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Body

application/json
end_user_file_class
string
required
file_name_template
string
required
is_enabled
boolean
required
variables
object[]

Response

200 - application/json

The created file rename rule

end_user_file_class
string
required
file_name_template
string
required
is_enabled
boolean
required
heron_id
string
variables
object[]