List Parts (POST)

POST

Lists a collection of parts.

Request

This endpoint expects an object.

typelist of enumsOptional

Allowed values: capabilityenhancementfeatureproduct

Filters for parts of the provided type(s).

created_bylist of stringsOptional

Filters for parts created by any of these users.

cursorstringOptional

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

limitintegerOptional

The maximum number of parts to return. The default is ‘50’.

mode"after" or "before"Optional

Allowed values: afterbefore

The iteration mode to use. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

namelist of stringsOptional

Filters for parts of the provided name(s).

owned_bylist of stringsOptional

Filters for parts owned by any of these users.

parent_partobjectOptional

The filter for specifying parent part.

Response

Success.

partslist of objects

The list of parts.

next_cursorstringOptional

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptional

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

POST

1 curl -X POST https://api.devrev.ai/parts.list \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

200Successful

1 {
2   "parts": [
3     {
4       "type": "product",
5       "id": "parts",
6       "name": "parts",
7       "owned_by": [
8         {
9           "type": "sys_user",
10           "id": "parts"
11         }
12       ],
13       "artifacts": [
14         {
15           "id": "id"
16         }
17       ],
18       "created_by": {
19         "type": "sys_user",
20         "id": "parts"
21       },
22       "created_date": "2023-01-01T12:00:00Z",
23       "description": "parts",
24       "display_id": "parts",
25       "modified_by": {
26         "type": "sys_user",
27         "id": "parts"
28       },
29       "modified_date": "2023-01-01T12:00:00Z",
30       "tags": [
31         {
32           "tag": {
33             "id": "id",
34             "name": "name"
35           }
36         }
37       ]
38     }
39   ],
40   "next_cursor": "next_cursor",
41   "prev_cursor": "prev_cursor"
42 }

Built with

1	curl -X POST https://api.devrev.ai/parts.list \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"parts": [
3	{
4	"type": "product",
5	"id": "parts",
6	"name": "parts",
7	"owned_by": [
8	{
9	"type": "sys_user",
10	"id": "parts"
11	}
12	],
13	"artifacts": [
14	{
15	"id": "id"
16	}
17	],
18	"created_by": {
19	"type": "sys_user",
20	"id": "parts"
21	},
22	"created_date": "2023-01-01T12:00:00Z",
23	"description": "parts",
24	"display_id": "parts",
25	"modified_by": {
26	"type": "sys_user",
27	"id": "parts"
28	},
29	"modified_date": "2023-01-01T12:00:00Z",
30	"tags": [
31	{
32	"tag": {
33	"id": "id",
34	"name": "name"
35	}
36	}
37	]
38	}
39	],
40	"next_cursor": "next_cursor",
41	"prev_cursor": "prev_cursor"
42	}