Fox Project icon

Fox Project

Interact with Fox Project API

Get Project Schema

AI-generated

Summary

Retrieve the schema details of a specific project from the Fox Project API.

Inputs

  • requestOptions (required) — Options to configure the request, including batching settings, SSL validation, proxy, and timeout.
  • requestOptions.batching — Settings for batching requests to control the number of items processed at once and the interval between batches.
  • requestOptions.batching.batchSize — Specify the number of items to include in each batch; -1 disables batching, and 0 is treated as 1.
  • requestOptions.batching.batchInterval — Time in milliseconds to wait between each batch request; 0 disables the interval.
  • requestOptions.allowUnauthorizedCerts — Accept responses even if SSL certificate validation fails.
  • requestOptions.proxy — Specify an HTTP proxy for the request.
  • requestOptions.timeout — Time in milliseconds to wait for the server to respond before aborting the request.

Output shape

a schema object containing the project's structure and fields

Return shape contains details specific to the project schema.

Discussion