Copier le modèle vers un autre espace de travail

curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/copy \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "My Template Copy"
}
'

import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/copy"

payload = {
    "workspace_id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "My Template Copy"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({workspace_id: '550e8400-e29b-41d4-a716-446655440000', name: 'My Template Copy'})
};

fetch('https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/copy', 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.firma.dev/functions/v1/signing-request-api/templates/{id}/copy",
  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([
    'workspace_id' => '550e8400-e29b-41d4-a716-446655440000',
    'name' => 'My Template Copy'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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.firma.dev/functions/v1/signing-request-api/templates/{id}/copy"

	payload := strings.NewReader("{\n  \"workspace_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"name\": \"My Template Copy\"\n}")

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

	req.Header.Add("Authorization", "<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://api.firma.dev/functions/v1/signing-request-api/templates/{id}/copy")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspace_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"name\": \"My Template Copy\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/copy")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspace_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"name\": \"My Template Copy\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_date": "2023-11-07T05:31:56Z",
  "seal_participants": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order": 2,
      "seal": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "lineage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "version": 123,
        "display_name": "<string>"
      },
      "seal_out_of_scope": true,
      "dropped": false
    }
  ]
}

Modèles

Copier le modèle vers un autre espace de travail

Crée une copie complète d’un modèle (y compris les champs, destinataires, CC, rappels, définitions de champs personnalisés et le document PDF) dans un espace de travail cible de la même entreprise. Nécessite une clé API protégée au niveau de l’entreprise. Multi-documents (activation requise) : la copie d’un modèle comportant plus d’un document est un modèle à UN seul document, le document fusionné de la source ; son contenu et les numéros de page absolus de ses champs sont conservés, mais pas les libellés ni les positions propres à chaque document.

POST

templates

{id}

copy

Copier le modèle vers un autre espace de travail

curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/copy \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "My Template Copy"
}
'

import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/copy"

payload = {
    "workspace_id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "My Template Copy"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({workspace_id: '550e8400-e29b-41d4-a716-446655440000', name: 'My Template Copy'})
};

fetch('https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/copy', 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.firma.dev/functions/v1/signing-request-api/templates/{id}/copy",
  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([
    'workspace_id' => '550e8400-e29b-41d4-a716-446655440000',
    'name' => 'My Template Copy'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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.firma.dev/functions/v1/signing-request-api/templates/{id}/copy"

	payload := strings.NewReader("{\n  \"workspace_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"name\": \"My Template Copy\"\n}")

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

	req.Header.Add("Authorization", "<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://api.firma.dev/functions/v1/signing-request-api/templates/{id}/copy")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspace_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"name\": \"My Template Copy\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/copy")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspace_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"name\": \"My Template Copy\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_date": "2023-11-07T05:31:56Z",
  "seal_participants": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order": 2,
      "seal": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "lineage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "version": 123,
        "display_name": "<string>"
      },
      "seal_out_of_scope": true,
      "dropped": false
    }
  ]
}

Autorisations

Authorization

string

header

requis

Clé API pour l'authentification. Utilisez votre clé API directement sans préfixe (par exemple, 'your-api-key'). Le préfixe Bearer est optionnel mais pas obligatoire.

Paramètres de chemin

string<uuid>

requis

ID du modèle à copier

Corps

application/json

workspace_id

string<uuid>

requis

ID de l'espace de travail cible dans lequel copier le modèle

name

string

Nom du modèle copié (par défaut, le nom d'origine suivi du suffixe " (copy)")

Maximum string length: 255

Réponse

Modèle copié avec succès

Réponse de copie de modèle

string<uuid>

requis

ID de la nouvelle copie du modèle

name

string

requis

Nom du modèle copié

workspace_id

string<uuid>

requis

Espace de travail cible dans lequel le modèle a été copié

created_date

string<date-time>

requis

Horodatage de création

seal_participants

object[]

requis

Une entrée par participant de cachet actif du modèle source, dans l'ordre de la source. Un cachet qui n'est pas disponible dans l'espace de travail cible n'est pas copié, ni les champs qui lui sont affectés ; son entrée est { id: null, order: null, seal: <résumé ou null>, seal_out_of_scope: true, dropped: true }.

Un participant de cachet du modèle copié. order est sa position dans le modèle copié ; seal_out_of_scope vaut true uniquement lorsque le cachet a été révoqué ou supprimé.

Option 1
Option 2

Show child attributes