DataBolsa docs
Referência da APIExtensõesCreditFunctions

Executa uma Function

Executa a Function no sujeito informado (`entity_id` do recurso) com o `input` do spec. `at` aplica o corte temporal no campo que o spec declara. Recusas trazem `details.code`: `subject_required`, `subject_not_found`, `temporal_cut_unsupported`, `invalid_input`, `scope_missing`.

POST
/v1/desk/functions/{functionId}/execute
AuthorizationBearer <token>

In: header

Path Parameters

functionIdstring

Id qualificado da Function, como o catálogo em GET {base}/functions a publica.

subject?object

O sujeito da Function: entity_id ou resolve (com kind). Omita nas Functions sem sujeito.

input?object

Os parâmetros da função, conforme input_schema.

Empty Object

at?string

Corte temporal ISO (AAAA-MM-DD); recusado quando a função só responde o vigente.

series?string

Papel escolhido quando o grão é por papel e o sujeito tem vários.

Response Body

curl -X POST "https://api.databolsa.com/v1/desk/functions/string/execute" \  -H "Content-Type: application/json" \  -d '{}'
{
  "function": "string",
  "subject": {
    "id": "string",
    "kind": "string",
    "subkind": "string",
    "name": "string",
    "code": "string"
  },
  "at": "string",
  "result": null
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "details": {
    "property1": null,
    "property2": null
  }
}