Assignment of part types

Use the following endpoints to manage the assignment of part types to assemblies:

Creating assignments of part types to assemblies

POST /1/catalog/assignments/parts

Multiple part types can be assigned to assemblies in one call by specifying a list of assignments. Assignments are defined as pairs of part id and assembly id.

The endpoint returns a list of indices of assignments, which have been created. The result contains also an error dictionary in case some assignments could not be created with corresponding error descriptions. Assignments that already exist will be ignored.

Each assignment in the list contains:

Parameter	Value
part_id	Unique id of the part type to be assigned to an assembly
ass_id	Unique id of the assembly node to which the part type should be assigned

note

This endpoint will respond with error code 503 when the catalog API is in maintenance mode.

🡢 See API Reference

---

HTTP

> POST https://api.partium.io/1/catalog/assignments/parts
> Authorization: Bearer <<Your Access Token or API Key>>
> Content-Type: application/json
>
> [
>   {
>     "part_id": "part1",
>     "ass_id": "ass1"
>   },
>   {
>     "part_id": "part1",
>     "ass_id": "ass2"
>   },
>   {
>     "part_id": "part2",
>     "ass_id": "ass1"
>   }
> ]
>
< HTTP/1.1 200 OK
< Content-Type: application/json
<
< {
<   "created": [0,1,2],
<   "errors": {}
< }

Python

response = requests.post(
  'https://api.partium.io/1/catalog/assignments/parts',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
  },
  json=[
    {
      "part_id": "part1",
      "ass_id": "ass1"
    },
    {
      "part_id": "part1",
      "ass_id": "ass2"
    },
    {
      "part_id": "part2",
      "ass_id": "ass1"
    }
  ]
)

JavaScript

fetch('https://api.partium.io/1/catalog/assignments/parts', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <<Your Access Token or API Key>>',
  },
  body: [
    {
      "part_id": "part1",
      "ass_id": "ass1"
    },
    {
      "part_id": "part1",
      "ass_id": "ass2"
    },
    {
      "part_id": "part2",
      "ass_id": "ass1"
    }
  ]
}).then(res => {
  ...
});

note

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

---

Removing assignments of part types to assemblies

DELETE /1/catalog/assignments/parts

Multiple part types can be removed from assemblies in one call by specifying a list of assignments. Assignments are defined as pairs of part id and assembly id.

The endpoint does not return information about deleted entities. Assignments that do not exist will be silently ignored.

Each entry in the list of assignments to remove contains:

Parameter	Value
part_id	Unique id of the part type to be removed from an assembly
ass_id	Unique id of the assembly node from which the part type should be removed

note

This endpoint will respond with error code 503 when the catalog API is in maintenance mode.

🡢 See API Reference

---

HTTP

> DELETE https://api.partium.io/1/catalog/assignments/parts
> Authorization: Bearer <<Your Access Token or API Key>>
> Content-Type: application/json
>
> [
>   {
>     "part_id": "part1",
>     "ass_id": "ass1"
>   },
>   {
>     "part_id": "part2",
>     "ass_id": "ass1"
>   }
> ]
>
< HTTP/1.1 200 OK
< Content-Type: application/json
<
< {}

Python

response = requests.delete(
  'https://api.partium.io/1/catalog/assignments/parts',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
  },
  json=[
    {
      "part_id": "part1",
      "ass_id": "ass1"
    },
    {
      "part_id": "part2",
      "ass_id": "ass1"
    }
  ]
)

JavaScript

fetch('https://api.partium.io/1/catalog/assignments/parts', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer <<Your Access Token or API Key>>',
  },
  body: [
    {
      "part_id": "part1",
      "ass_id": "ass1"
    },
    {
      "part_id": "part2",
      "ass_id": "ass1"
    }
  ]
}).then(res => {
  ...
});

note

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

---

Listing assignments of part types to assemblies

POST /1/catalog/assignments/parts/list

Query a list of assignments of part types to assemblies. The list can be filtered by specifying a list of ass_ids and a list of part_ids. A paging mechanism can be used to fetch more data if the number of results exceeds the paging limit.

Parameter	Value
query.ass_ids	Optional list of assembly ids. If specified, only assignments to the specified assemblies are part of the result
query.part_ids	Optional list of part ids. If specified, only assignments of the specified part types are included in the result
paging.limit	Maximum number of results returned by the endpoint
paging.last_object_id	Use this id to get the next page of results. The id is returned by a previous call to this endpoint

🡢 See API Reference

---

HTTP

> POST https://api.partium.io/1/catalog/assignments/parts/list
> Authorization: Bearer <<Your Access Token or API Key>>
> Content-Type: application/json
>
> {
>   "query": {
>     "ass_ids": ["ass1", "ass2"]
>   },
>   "paging": {
>     "limit": 10
>   }
> }
>
< HTTP/1.1 200 OK
< Content-Type: application/json
<
< {
<   "result": [
<     {
<       "part_id": "part1",
<       "ass_id": "ass1"
<     },
<     {
<       "part_id": "part2",
<       "ass_id": "ass1"
<     },
<     {
<       "part_id": "part2",
<       "ass_id": "ass2"
<     }
<   ],
<   "last_object_id": "unique_object_id",
<   "more_data": false
< }

Python

response = requests.post(
  'https://api.partium.io/1/catalog/assignments/parts/list',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
  },
  json={
    "query": {
      "ass_ids": ["ass1", "ass2"]
    },
    "paging": {
      "limit": 10
    }
  }
)

JavaScript

fetch('https://api.partium.io/1/catalog/assignments/parts/list', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <<Your Access Token or API Key>>',
  },
  body: {
    "query": {
      "ass_ids": ["ass1", "ass2"]
    },
    "paging": {
      "limit": 10
    }
  }
}).then(res => {
  ...
});

note

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

more_data in the response is true indicates that there are more results to fetch. In that case use the returned last_object_id as a parameter for the next call to fetch the next page of results. Repeat this until more_data is false.

---