v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
ServiceInventory

Get Inventory Items associated with a service

Get Inventory Items associated with a service.

get/v1/ServiceInventory

Query parameters

search.inventory_item_idinteger[]

Query by inventory item identifier.

search.customer_idinteger[]

Query by customer id.

search.service_idinteger[]

Query by service id.

search.identifierstring[]

Query by all or part of string identifier.

search.service_typestring[]

Query by service type

search.inventory_typestring[]

Query by inventory type

search.statusstring[]

Query by status of the inventory item.

search.assigned_date_startstring date-time

Format - date-time (as date-time in RFC3339). Query by assigned date.

search.assigned_date_endstring date-time

Format - date-time (as date-time in RFC3339). Query by assigned date.

search.assigned_byinteger[]

Query by assigned by

search.created_date_startstring date-time

Format - date-time (as date-time in RFC3339). Query by created date.

search.created_date_endstring date-time

Format - date-time (as date-time in RFC3339). Query by created date.

search.user_created_byinteger[]

Query by user created by

search.nPAstring[]

Query by NPA

search.nXXstring[]

Query by NXX

search.page_sizeinteger

Format - int32. Defines how many items to return at a time.

search.pageinteger

Format - int32. Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)

search.sortstring

Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.

Response

OK

has_moreboolean

Helper for pagination. Indicates there are more records returned.

record_countinteger

Total number of records found by the search.