Get a Catalog Executor

Use this endpoint to retrieve the metadata and JSON Schema of a specific catalog executor.

GET /v1/catalog/executors/{id}

Get a Catalog Executor

cURL

curl --request GET \
  --url https://flowker.sandbox.lerian.net/v1/catalog/executors/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "category": "HTTP",
  "id": "http",
  "method": "POST",
  "name": "HTTP Request",
  "params": [
    {
      "in": "path",
      "name": "caseId",
      "required": true,
      "description": "Case ID",
      "schema": {
        "type": "string"
      }
    }
  ],
  "path": "/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/json",
  "providerId": "",
  "schema": "{\"type\":\"object\",\"properties\":{\"method\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"}}}",
  "version": "v1"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider. Send it in the Authorization header as Bearer <token>.

Parámetros de ruta

id · string · requerido

Unique identifier of the catalog executor.

Respuesta

200

application/json

Indicates that the request was successful and the response contains the requested data.

category · string

Functional category of the executor.

Ejemplo:

"HTTP"

id · string

Unique identifier of the executor.

Ejemplo:

"http"

method · string

Upper-case HTTP method of the executor's OpenAPI operation. Omitted for an executor not built from an OpenAPI spec.

Ejemplo:

"POST"

name · string

Display name of the executor.

Ejemplo:

"HTTP Request"

params · object[] | null

Path, query and header parameters the node maps, for an executor built from an OpenAPI spec.

Show child attributes

path · string

OpenAPI path template of the executor's operation. Omitted for an executor not built from an OpenAPI spec.

Ejemplo:

"/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/json"

providerId · string

ID of the provider this executor belongs to.

Ejemplo:

""

schema · string

JSON Schema defining the expected configuration for this executor.

Ejemplo:

"{\"type\":\"object\",\"properties\":{\"method\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"}}}"

version · string

Version of the executor.

Ejemplo:

"v1"