DataBolsa docs
Referência da APIPlataformaModules

Busca capacidades

Ranqueia, para uma pergunta em texto livre, o que a credencial alcança: primitivas de Objects, Functions do core e as Functions e Actions dos módulos instalados no workspace. Cada descritor diz o tipo, o módulo, o domínio, o sujeito, os scopes e a rota de execução; o spec completo está em `getCapability`.

GET
/v1/capabilities

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

query?string

Texto livre: casa com id, título, descrição e critério de uso.

type?string

Recorta ao tipo: primitive (álgebra de Objects), function (cálculo ou composição), action (escrita de módulo) ou system.

Value in"primitive" | "function" | "action" | "system"
module?string

core ou o id da extensão.

subject_kind?string

Só capacidades que aceitam este tipo de objeto como sujeito.

limit?integer

Candidatos a devolver (1–100, default 20).

Default20
Range1 <= value <= 100

Response Body

curl -X GET "https://api.databolsa.com/v1/capabilities?query=string&type=primitive&module=string&subject_kind=string&limit=20"
{
  "data": [
    {
      "id": "string",
      "type": "primitive",
      "module": "string",
      "domain": "string",
      "title": "string",
      "description": "string",
      "criterio": "string",
      "subject": {
        "mode": "object",
        "kinds": [
          "company"
        ],
        "subkinds": [
          "string"
        ],
        "grain": "object"
      },
      "lifecycle": "default",
      "stability": "stable",
      "scopes": [
        "string"
      ],
      "confirmation": "required",
      "execute": {
        "method": "GET",
        "path": "string"
      },
      "describe": "string",
      "legacy_operation": "string"
    }
  ],
  "meta": {
    "next_cursor": null,
    "count": 0,
    "query": "string",
    "total": 0,
    "hint": "string"
  }
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "details": {
    "property1": null,
    "property2": null
  }
}

Um módulo e as capacidades que publica

O descritor do módulo (`core` ou o id da extensão) com a lista das suas capacidades como descritores curtos.

Módulos da plataforma

O core e as extensões como módulos: instalação, disponibilidade no workspace da credencial, scopes, contratos, tipos de objeto, Functions e Actions publicadas.