Items

List similar items

Changed on

Returns the items most similar to the given item, best match first, each with a similarity score, a classification and the specifications the two items share. The item must belong to your organization and sit on a business node the access token grants. Otherwise the response is 404, the same as for an item that does not exist. Only similar items on business nodes the token grants are listed, and business_node_ids narrows them to some of those nodes. At most limit similar items are listed, while total counts all of them. When total is larger, ask again with a higher limit to list more: the order is stable, so the first items stay the same. Requires an access token granting the items:read scope. API access is enabled by Resourcly for your organization (contact support@resourcly.com).

get/items/{id}/similar

Request

  • Base URL
    https://api.resourcly.com/v1
  • URL
    https://api.resourcly.com/v1/items/{id}/similar
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.resourcly.com/v1/oauth/token scopes: items:read

Path parameters

idstring uuid required

Item ID

Query parameters

limitinteger

Maximum number of similar items to list, from 1 to 500. Other values use the default.

thresholdnumber

Minimum similarity score, from 0 to 1. Other values use the default. Best effort: organizations that use similarity classes list every classified match, and some organizations list matches down to 0.7 whatever the value.

class'duplicate' | 'interchangeable_variant' | 'language_variant' | 'superseded' | 'product_variant' | 'related_parts' | 'component_of'

Only matches of this similarity class. Applies to organizations that use similarity classes; it is ignored otherwise.

has_cadboolean

Only similar items that have a CAD file.

shared_specs'list' | 'count'

How to report the specifications each pair shares: list lists them in shared_specs, count gives only shared_spec_count, which answers much faster for an item with many similar items.

business_node_idsstring

Comma-separated business node IDs. Only similar items on these business nodes are listed and counted in total. Each must be a business node the access token grants. Omitted, every business node the token grants is included. The item itself may sit on any granted business node.

Response

OK

item_idstring

the item the matches are similar to

totalinteger

how many similar items there are, including any beyond limit

Changes