aVenture APIEntity Maintenance

List the accepted typeRecord values

View as Markdown
Returns typeRecord alias guidance for API help and CLI command suggestions.

Response headers

X-RateLimit-Limitinteger

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-Remaininginteger

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-Resetinteger

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

OK
aliaslist of strings

Alias tokens accepted by EntityType.fromRaw (case-insensitive).

canOwnPublicProductServiceRouteboolean

Whether this EntityType can provide the parent route for a public Product/Service.

canonicalstring

Canonical EntityType value (e.g. “Company”, “Investment Firm”).

descriptionstring

Human-facing meaning of this EntityType.

productServiceRouteSegmentstring
Nested public route segment shared by Product and Service records.
publicPathPrefixstring
Public website path prefix for this EntityType.

Errors

400
Bad Request Error
406
Not Acceptable Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error