EndpointUrlSegments
Defined in: packages/json-api-client/src/types.ts:75
Parameters comprising the segments of a JSON:API endpoint URL.
Properties
Section titled “Properties”bundleId?
Section titled “bundleId?”optional bundleId?: string;Defined in: packages/json-api-client/src/types.ts:83
The bundle identifier.
cacheKey?
Section titled “cacheKey?”optional cacheKey?: string;Defined in: packages/json-api-client/src/types.ts:107
Optional. The custom cacheKey to use for this request.
entityTypeId?
Section titled “entityTypeId?”optional entityTypeId?: string;Defined in: packages/json-api-client/src/types.ts:79
The entity type identifier.
localeSegment?
Section titled “localeSegment?”optional localeSegment?: string;Defined in: packages/json-api-client/src/types.ts:95
Optional. The locale segment. Default is an empty string.
queryString?
Section titled “queryString?”optional queryString?: string;Defined in: packages/json-api-client/src/types.ts:103
Optional. The query string. Default is an empty string.
resourceId?
Section titled “resourceId?”optional resourceId?: string;Defined in: packages/json-api-client/src/types.ts:99
Optional. The ID of the individual resource.
viewDisplayId?
Section titled “viewDisplayId?”optional viewDisplayId?: string;Defined in: packages/json-api-client/src/types.ts:91
Optional. The display ID of a view.
viewName?
Section titled “viewName?”optional viewName?: string;Defined in: packages/json-api-client/src/types.ts:87
Optional. The machine name of a view.