REST API

/{version}/configuration/udts

The following operations are supported on this resource:

GET

Gets a paged list of user defined type links.

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 udts with names that match the specified value. When filtering results, you can repeat this parameter. query
attach-to-name Displays only links to user defined types attached to the specified item in the system, such as Sample, Project, Container, or the name of a process. Refer to the 'type' 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)
udts (XML)
  • application/xml
description
the list of user defined field links starting from the paging offset 'start-index'.

/{version}/configuration/udts

Home

REST Endpoints

XML Data Elements

XML Data Types