/{version}/instruments
The following operations are supported on this resource:
Displays a list of instruments stored in the system. If the number of instruments returned exceeds the display maximum, the results are paged.
When submitting a GET request, you can use the following query parameters to filter the results.
For more information about using query parameters, please refer to the Filtering list resources section under REST General Concepts.
Parameters
| name |
description |
type |
default |
| start-index |
When working with large lists of instruments, displays the instruments from a set point. If omitted, the first page of instruments is returned.
|
query |
0 |
| name |
Displays only the instruments that match the instrument name against the provided parameter. When filtering results, you can repeat this parameter.
|
query |
|
Output Payload
| element |
produceable content type(s) |
|
instruments (XML)
|
|
| description |
| The system returns a response that includes a list of instruments and URI links, starting from the start-index offset. |