Editar nota da Wiki

curl --request PATCH \
  --url https://api.juridiq.com.br/wiki/notes/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-juridiq-api-key: <api-key>' \
  --data '
{
  "version": 123,
  "title": "<string>",
  "icon": "<string>",
  "markdown": "<string>"
}
'

import requests

url = "https://api.juridiq.com.br/wiki/notes/{id}"

payload = {
    "version": 123,
    "title": "<string>",
    "icon": "<string>",
    "markdown": "<string>"
}
headers = {
    "x-juridiq-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-juridiq-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({version: 123, title: '<string>', icon: '<string>', markdown: '<string>'})
};

fetch('https://api.juridiq.com.br/wiki/notes/{id}', 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/wiki/notes/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'version' => 123,
    'title' => '<string>',
    'icon' => '<string>',
    'markdown' => '<string>'
  ]),
  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/wiki/notes/{id}"

	payload := strings.NewReader("{\n  \"version\": 123,\n  \"title\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"markdown\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.juridiq.com.br/wiki/notes/{id}")
  .header("x-juridiq-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"version\": 123,\n  \"title\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"markdown\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/wiki/notes/{id}")

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

request = Net::HTTP::Patch.new(url)
request["x-juridiq-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"version\": 123,\n  \"title\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"markdown\": \"<string>\"\n}"

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

{
  "version": 123
}

{
  "message": "<string>",
  "issues": "<unknown>"
}

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

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

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>",
  "code": "<string>",
  "version": 123,
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedByName": "<string>"
}

Wiki

Editar nota da Wiki

Altera título, ícone e/ou conteúdo. markdown substitui o conteúdo inteiro: o que o Markdown não representa (cores, sublinhado, alinhamento, largura de colunas) se perde. Envie a version lida; se alguém salvou antes, a resposta é 409 com a versão atual, e nada é gravado. Nota privada de outra pessoa não pode ser editada.

Quem vê o quê: a chave age como o usuário dono dela e enxerga as notas do Escritório e as próprias notas privadas. Privadas de outras pessoas e notas compartilhadas não aparecem, nem para Gestor.

Disponibilidade: só para escritórios com a Wiki liberada; fora disso, 404.

Auditoria: toda ação por chave fica na auditoria do escritório (entityType wikiPage ou wikiComment), sem o conteúdo da nota.

PATCH

wiki

notes

{id}

Editar nota da Wiki

curl --request PATCH \
  --url https://api.juridiq.com.br/wiki/notes/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-juridiq-api-key: <api-key>' \
  --data '
{
  "version": 123,
  "title": "<string>",
  "icon": "<string>",
  "markdown": "<string>"
}
'

import requests

url = "https://api.juridiq.com.br/wiki/notes/{id}"

payload = {
    "version": 123,
    "title": "<string>",
    "icon": "<string>",
    "markdown": "<string>"
}
headers = {
    "x-juridiq-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-juridiq-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({version: 123, title: '<string>', icon: '<string>', markdown: '<string>'})
};

fetch('https://api.juridiq.com.br/wiki/notes/{id}', 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/wiki/notes/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'version' => 123,
    'title' => '<string>',
    'icon' => '<string>',
    'markdown' => '<string>'
  ]),
  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/wiki/notes/{id}"

	payload := strings.NewReader("{\n  \"version\": 123,\n  \"title\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"markdown\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.juridiq.com.br/wiki/notes/{id}")
  .header("x-juridiq-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"version\": 123,\n  \"title\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"markdown\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/wiki/notes/{id}")

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

request = Net::HTTP::Patch.new(url)
request["x-juridiq-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"version\": 123,\n  \"title\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"markdown\": \"<string>\"\n}"

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

{
  "version": 123
}

{
  "message": "<string>",
  "issues": "<unknown>"
}

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

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

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>",
  "code": "<string>",
  "version": 123,
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedByName": "<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<uuid>

required

ID da nota (página da Wiki)

Body

application/json

version

integer

required

Versão lida em GET /wiki/notes/{id}; se outra pessoa salvou antes, 409

title

string

Título da nota

Required string length: 1 - 500

icon

string | null

Emoji usado como ícone da nota; null tira o ícone

Maximum string length: 16

markdown

string

Substitui o conteúdo inteiro da nota. Veja o formato aceito em POST /wiki/notes

Maximum string length: 500000

Response

Default Response

version

integer

required

Nova versão

Primeiros Passos

API Reference

Editar nota da Wiki

Authorizations

Path Parameters

Body

Response