Ploomes CRM icon

Ploomes CRM

Interact with the Ploomes CRM API with full OData support

Actions126

Product Part → Get Many

AI-generated

Summary

Retrieves multiple Product Part records from Ploomes CRM with OData query support, including filtering, sorting, pagination, field selection, expansion, and optional caching.

Inputs

  • Cache Strategy — How to use in‑memory cache for GET requests. Options: disabled (no cache), cacheFirst (use cached response if available and valid), fallbackOnly (always fetch from API; use cache only if the request fails). Default: disabled.
  • Cache TTL (Seconds) — Time‑to‑live for cached responses in seconds. Only applies when cache strategy is not disabled. Default: 300 (5 minutes).
  • $top (Limit) — Maximum number of records to return. Default: 1.
  • $skip (Offset) — Number of records to skip for pagination. Default: 0.
  • $select (Fields) — Comma‑separated list of fields to return. Example: Id,Name,Title. Default: Id.
  • $orderby (Sort) — Field to sort by with optional direction (asc/desc). Example: Id desc, Name asc. Default: Id.
  • Use Filter Builder — Whether to use the visual filter builder or write a raw OData $filter string. Default: true.
  • Filter Conditions — Array of filter conditions when using the filter builder. Each condition includes Field, Operator, Value, Value Type, and Logical Operator (AND/OR) to combine with the next condition.
  • $filter (Raw) — Raw OData $filter expression when not using the filter builder. Example: Id eq 123 and Name eq 'John'.
  • Custom Property Filters — Filters on custom fields (OtherProperties). Each filter specifies Field ID, Value Property (StringValue, IntegerValue, etc.), Operator, Value, and whether the value is numeric. Combined with AND to the main filter.
  • Navigation Property Filters — Filters on navigation properties (e.g., Lists, Tags, City, State, Owner). Each filter specifies Filter Type (Collection (any) or Direct Navigation), Navigation Property name, Field to filter on, Operator, Value, and Logical Operator to combine with the next filter. Combined with AND to the main filter.
  • Use Expand Builder — Whether to use the visual expand builder or write a raw OData $expand string. Default: true.
  • Expand Relations — Related entities to expand when using the expand builder. Each expansion includes Property Name, optional $select (nested fields), optional nested filter, and optional nested expand.
  • $expand (Raw) — Raw OData $expand expression when not using the expand builder. Example: OtherProperties,Owner($select=Id,Name).
  • Expand Nested Filters — Nested $filter conditions for expanded properties when using the expand builder. Each filter specifies Expansion Property (must match a property in Expand Relations), Field, Operator, Value, whether the value is numeric, and Logical Operator (AND/OR) to combine with the next condition for the same expansion.

Output shape

array

Each element is a JSON object representing a Product Part record. By default only the Id field is returned unless $select is expanded. Expanded navigation properties appear as nested objects when $expand is used. When caching is enabled, objects may include _fromCache: true (served from cache) or _fallback: true (served from cache after a request failure).

Examples

Example 1: Get the first 10 Product Parts, returning Id and Name, sorted by Name ascending.

Set $top to 10, $skip to 0, $select to 'Id,Name', $orderby to 'Name asc'. Use default cache strategy (disabled).

Example 2: Retrieve Product Parts whose Name contains 'Gear' and expand the Owner navigation property with Id and Name fields.

Enable Filter Builder, add a condition: Field Name, Operator Contains, Value Gear. Enable Expand Builder, add an expansion: Property Owner, $select Id,Name. Leave other fields at defaults.

Links

Discussion