Developers

Aparência

Vai integrar a API REST da Zarv com ajuda de IA? Copie a instrução que aponta o modelo para esta documentação.
Ver a instrução
Você vai integrar a API REST da Zarv. Use a documentação oficial como fonte da verdade.

- Página desta integração: https://developers.zarv.com/api/lens/updateResearchEntity
- Autenticação Bearer JWT e hosts: https://developers.zarv.com/setup
- Índice das APIs: https://developers.zarv.com/api
- Índice da documentação em markdown: https://developers.zarv.com/llms.txt
- Documentação completa em um arquivo: https://developers.zarv.com/llms-full.txt

Os specs OpenAPI publicados são a fonte da verdade para rotas e schemas — use o spec da API que você escolher antes de escrever qualquer request.

Antes de escrever qualquer código, leia a página desta integração. Siga exatamente os nomes de campos, endpoints, callbacks e formatos que estiverem documentados — não invente parâmetros nem endpoints, e não deduza comportamento a partir de outras APIs que você conhece. Se algo de que você precisa não estiver na documentação, diga que não está em vez de supor.

Minha tarefa: [ex.: escolher a API certa e fazer a primeira chamada autenticada]

Editar um envolvido​

PUT
/api/v1/lens/{workspaceId}/research/{researchId}/entity/{id}

Um PATCH: muda os papéis, o motivo, o cadastro, os metadados e o vínculo com um veículo do caso.

  • parentId: null não mexe, "" desliga o vínculo, um id amarra ao veículo.
  • reason: null não mexe, "" apaga.
  • value é imutável. Se vier, tem de ser exatamente o que está gravado; qualquer outro valor é 400 IDENTITY_IS_IMMUTABLE. A placa e o CPF/CNPJ são a chave pela qual o Asset, o Zarv ID e as dimensões foram consultados — corrigir é remover e incluir de novo.
  • externalId, type e manual não são editáveis e são ignorados no corpo.

Authorizations​

BearerAuth

Token Bearer JWT obtido em POST /api/v1/authentication. O workspace do token precisa ser o mesmo do caminho.

Type
HTTP (bearer)

Parameters​

Path Parameters

workspaceId*

O workspace dono do caso. Tem de ser o workspace do token.

Type
string
Required
Example"3f1a2b4c-5d6e-4f70-8a91-b2c3d4e5f607"
Format
"uuid"
researchId*

O id do caso.

Type
string
Required
Example"7d2f8e10-4c3b-4a5d-9e8f-1a2b3c4d5e6f"
Format
"uuid"
id*

O id do envolvido.

Type
string
Required
Example"5e9a3c71-2b4d-4e8f-a9c0-6d1b7f2e8a35"
Format
"uuid"

Request Body​

application/json
JSON
{
  
"roles": [
  
  
"SEGURADO"
  
],
  
"reason": "string",
  
"parentId": "string",
  
"profile": {
  
  
"additionalProperties": "string"
  
},
  
"metadata": {
  
  
"additionalProperties": "string"
  
},
  
"value": "string"
}

Responses​

O envolvido depois da edição.

application/json
JSON
{
  
"id": "string",
  
"researchId": "string",
  
"parentId": "",
  
"externalId": "",
  
"type": "PERSON",
  
"value": "TST1A23",
  
"roles": [
  
  
"SEGURADO"
  
],
  
"reason": "string",
  
"profile": {
  
  
"additionalProperties": "string"
  
},
  
"manual": true,
  
"metadata": {
  
  
"additionalProperties": "string"
  
},
  
"createdAt": "string",
  
"updatedAt": "string"
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI