Link the item created for a workflow request to its step

curl --request POST \
  --url https://api.juridiq.com.br/workflow/instances/{id}/steps/{stepId}/link \
  --header 'Content-Type: application/json' \
  --header 'x-juridiq-api-key: <api-key>' \
  --data '
{
  "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.juridiq.com.br/workflow/instances/{id}/steps/{stepId}/link"

payload = { "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
    "x-juridiq-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-juridiq-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({entityId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

fetch('https://api.juridiq.com.br/workflow/instances/{id}/steps/{stepId}/link', 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.juridiq.com.br/workflow/instances/{id}/steps/{stepId}/link",
  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([
    'entityId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-juridiq-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://api.juridiq.com.br/workflow/instances/{id}/steps/{stepId}/link"

	payload := strings.NewReader("{\n  \"entityId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

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

	req.Header.Add("x-juridiq-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://api.juridiq.com.br/workflow/instances/{id}/steps/{stepId}/link")
  .header("x-juridiq-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entityId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/workflow/instances/{id}/steps/{stepId}/link")

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

request = Net::HTTP::Post.new(url)
request["x-juridiq-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entityId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "completed": true
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

POST

workflow

instances

{id}

steps

{stepId}

link

Link the item created for a workflow request to its step

curl --request POST \
  --url https://api.juridiq.com.br/workflow/instances/{id}/steps/{stepId}/link \
  --header 'Content-Type: application/json' \
  --header 'x-juridiq-api-key: <api-key>' \
  --data '
{
  "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.juridiq.com.br/workflow/instances/{id}/steps/{stepId}/link"

payload = { "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
    "x-juridiq-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-juridiq-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({entityId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

fetch('https://api.juridiq.com.br/workflow/instances/{id}/steps/{stepId}/link', 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.juridiq.com.br/workflow/instances/{id}/steps/{stepId}/link",
  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([
    'entityId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-juridiq-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://api.juridiq.com.br/workflow/instances/{id}/steps/{stepId}/link"

	payload := strings.NewReader("{\n  \"entityId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

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

	req.Header.Add("x-juridiq-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://api.juridiq.com.br/workflow/instances/{id}/steps/{stepId}/link")
  .header("x-juridiq-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entityId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/workflow/instances/{id}/steps/{stepId}/link")

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

request = Net::HTTP::Post.new(url)
request["x-juridiq-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entityId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "completed": true
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

Authorizations

x-juridiq-api-key

string

header

required

Chave de API do escritório (criada no painel). Envie o valor no header x-juridiq-api-key. A API aberta aplica rate limit por chave (veja a documentação de integradores).

Path Parameters

string

required

stepId

string

required

Body

application/json

entityType

enum<string>

required

Available options:

LAWSUIT,

SIGNATURE,

DOCUMENT

entityId

string<uuid>

required

Response

Default Response

completed

boolean

required

Primeiros Passos

API Reference

Link the item created for a workflow request to its step

Authorizations

Path Parameters

Body

Response