Hierarchy filters

This section covers all the details about the hierarchy filters. This input data can be specified within the matches field in the search request object.

Search flow

matches.hierarchy can be used to search for a specific branch within a hierarchical structure, such as the Bill of Materials for a particular machine, a hierarchical category structure, or a multilevel department organization. If provided, the search is limited to the included nodes and their dependents. For example, ["NODE129128.13871", "NODE132983290.39"].

---

HTTP

> POST https://api.partium.io/1/find/search
> Authorization: Bearer <<Your Access Token or API Key>>
> Content-Type: application/json
> Content-Length: 179
> 
> {
>   "language": "en",
>   "projection": ["results.id", "results.name"],
>   "matches": {
>      "organization": "<<Your Organization Name>>",
>      "hierarchy": ["TRACTOR.2454488"]
>   }
> }
> 
< HTTP/1.1 200 OK
< Content-Type: application/json
< Content-Length: 347
<
< {
<   "sessionId": "cfaac7fc-8c0a-420a-b6ee-f59396861753",
<   "imageId": null,
<   "results": [
<     {
<       "id": "PM19239.AD",
<       "name": "HERRINGBONE GEAR 25 millimetre"
<     },
<     {
<       "id": "PM19245.AD",
<       "name": "ZEROL BEVEL GEAR 25 millimetre"
<     },
<     {
<       "id": "PM19247.AD",
<       "name": "SCREW GEAR 25 millimetre"
<     }
<   ]
< }

Python

response = requests.post(
  'https://api.partium.io/1/find/search',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
  },
  json={
    'language': 'en',
    'projection': ['results.id', 'results.name'],
    'matches': {
      'organization': '<<Your Organization Name>>',
      'hierarchy': ['TRACTOR.2454488']
    },
  },
)

JavaScript

fetch('https://api.partium.io/1/find/search', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <<Your Access Token or API Key>>',
  },
  body: {
    language: 'en',
    projection: ['results.id', 'results.name'],
    matches: {
      organization: '<<Your Organization Name>>',
      hierarchy: ['TRACTOR.2454488']
    },
  },
}).then(res => {
  ...
});

note

Replace <<Your Organization Name>> with the provided organization name.

Replace <<Your Access Token or API Key>> with the preferred authentication method. See Authentication.

---

Navigating the hierarchy

The current hierarchical structure can be navigated by the client application by using the auxiliary /1/find/filters/hierarchy endpoint.

The hierarchy can be traversed level by level, from the top downwards. By default, the root nodes are returned and can be browsed for their immediate children by passing rootId or rootPartiumId as a query parameter.

The response is paginated. The results property contains a single page of results. The default pageSize query parameter is 20 and can be adjusted respecting 1 <= pageSize <= 100. To fetch additional results, the next link property must be followed. When there are no more results, next will be set to null.

---

HTTP

> GET https://api.partium.io/1/find/filters/hierarchy
> Authorization: Bearer <<Your Access Token or API Key>>
>
> 
< HTTP/1.1 200 OK
< Content-Type: application/json
< Content-Length: 262
<
< {
<   "results": [
<     {
<       "id": "ADKH10983",
<       "partiumId": "fa832081-ade6-4787-86b3-e952e5481815",
<       "name": "3D-printing machine",
<       "partCount": 150
<     }
<   ],
<   "next": "https://api.partium.io/1/find/filters/hierarchy?cursor=abcef=="
< }
<
> GET https://api.k8s.int.partium.io/1/find/filters/hierarchy?rootId=ADKH10983&query=head
> Authorization: Bearer <<Your Access Token or API Key>>
>
> 
< HTTP/1.1 200 OK
< Content-Type: application/json
< Content-Length: 270
<
< {
<   "results": [
<     {
<       "id": "ADKG12975",
<       "partiumId": "602d9a38-75ba-4d75-a78e-418b814956a7",
<       "name": "Axial printing head",
<       "partCount": 3
<     }
<   ],
<   "next": null
< }
<
> POST https://api.k8s.int.partium.io/1/find/search
> Authorization: Bearer <<Your Access Token or API Key>>
> Content-Type: application/json
> Content-Length: 123
> 
> {
>   "language": "en",
>   "projection": ["results.id", "results.name"],
>   "matches": {
>      "hierarchy": ["ADKG12975"]
>   }
> }
>

Python

filtersResponse = requests.get(
  'https://api.partium.io/1/find/filters/hierarchy',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
  },
)
filters = filtersResponse.json()['results']
...
subTreeResponse = requests.get(
  'https://api.partium.io/1/find/filters/hierarchy',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
  },
  params={
    'rootId': filters[0]['id'],
    'query': 'head',
  },
)
filters = subTreeResponse.json()['results']
...
response = requests.post(
  'https://api.partium.io/1/find/search',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
  },
  json={
    'language': 'en',
    'projection': ['results.id', 'results.name'],
    'matches': {
      'hierarchy': [filters[0]['id']]
    },
  },
)

JavaScript

let tree = [];
fetch('https://api.partium.io/1/find/filters/hierarchy', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <<Your Access Token or API Key>>',
  },
}).then(res => {
  tree = res.results;
});
...
let subTree = [];
fetch('https://api.partium.io/1/find/filters/hierarchy?' + (new URLSearchParams({rootId: 'ADKH10983', query: 'head'}).toString()), {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <<Your Access Token or API Key>>',
  },
}).then(res => {
  subTree = res.results;
});
...
fetch('https://api.partium.io/1/find/search', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <<Your Access Token or API Key>>',
  },
  body: {
    language: 'en',
    projection: ['results.id', 'results.name'],
    matches: {',
      hierarchy: [subTree[0].id]
    },
  },
}).then(res => {
  ...
});

note

Replace <<Your Access Token or API Key>> with the preferred authentication method. See Authentication.

---