/{version}/configuration/udfs
The following operations are supported on this resource:
Gets a paged list of user defined field links. This list is ordered by attach-to-name, UDT, and then sequence number (mimics client display order).
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 |
An offset parameter that enables paging of the results. If omitted, the system returns the first page of user defined field links.
|
query |
0 |
| name |
Displays only links to user defined fields with names that match the specified value.
|
query |
|
| attach-to-name |
Displays only links to user defined fields attached to the specified item in the system, such as Sample, Project, Container, or the name of a process. Refer to the 'field' type in the 'cnf' namespace for more information.
|
query |
|
| attach-to-category |
If 'attach-to-name' is the name of a process, specify 'ProcessType'. Must not be provided otherwise.
|
query |
|
Output Payload
| element |
produceable content type(s) |
|
udfs (XML)
|
|
| description |
| the list of user defined field links starting from the paging offset 'start-index'. |