EndpointUrlSegments

Parameters comprising the segments of a JSON:API endpoint URL.

Properties

bundleId?

optional bundleId: string;

The bundle identifier.

Source

json-api-client/src/types.ts:83

---

cacheKey?

optional cacheKey: string;

Optional. The custom cacheKey to use for this request.

Source

json-api-client/src/types.ts:107

---

entityTypeId?

optional entityTypeId: string;

The entity type identifier.

Source

json-api-client/src/types.ts:79

---

localeSegment?

optional localeSegment: string;

Optional. The locale segment. Default is an empty string.

Source

json-api-client/src/types.ts:95

---

queryString?

optional queryString: string;

Optional. The query string. Default is an empty string.

Source

json-api-client/src/types.ts:103

---

resourceId?

optional resourceId: string;

Optional. The ID of the individual resource.

Source

json-api-client/src/types.ts:99

---

viewDisplayId?

optional viewDisplayId: string;

Optional. The display ID of a view.

Source

json-api-client/src/types.ts:91

---

viewName?

optional viewName: string;

Optional. The machine name of a view.

Source

json-api-client/src/types.ts:87