Skip to main content
GET
README app
GET https://api-datahub.octoparse.com/v1/data-apps/{app_id}/readme Autenticazione: facoltativa. Con API key puoi vedere app che richiedono una vista autenticata. Rich text orientato all’uomo (Markdown grezzo). Non fa parte del payload di dettaglio machine-readable; si recupera on demand. Default: ultima versione.

Richiesta

Parametri di percorso

string
obbligatorio
Riferimento app: app_<hex> oppure <namespace>/<app_name>.

Parametri di query

string
Versione da leggere. Default: latest.

Esempio di richiesta

Risposta

200 successo

Il body è text/markdown grezzo, senza envelope. Le app senza README restituiscono un body vuoto.

Errori

Le risposte di errore usano {"error": {code, category, message, retryable}}. Vedi Errori.

Librerie client

Gli SDK Python e JavaScript non wrappano ancora questo endpoint. Chiama REST direttamente.