REST API

/{version}/configuration/udfs/{udfid}/dynamicpresets/{attach-to-limsid}

The following operations are supported on this resource:

GET

Gets a list of dynamic user defined field presets.

When submitting a GET request, it should include the following path parameters.

Parameters

name description type default
udfid The ID of the user defined field to retrieve dynamic presets for. path
attach-to-limsid The LIMSID of the resource that the dynamic presets are attached to. path

Output Payload

element produceable content type(s)
field-dynamic-preset-details (XML)
  • application/xml
description
A list of dynamic user defined field presets tied to the specific user defined field and resource

POST

Create a list of dynamic user defined field presets.

When submitting a POST request, it should include the following path parameters.

Parameters

name description type default
udfid The ID of the user defined field for which the dynamic presets will be created. path
attach-to-limsid The LIMSID of the resource that the dynamic presets should be attached to. path

Input Payload

element consumeable content type(s)
field-dynamic-preset-details (XML)
  • */*
  • application/xml
description
The request body that should include the list of dynamic presets to be created

Output Payload

element produceable content type(s)
field-dynamic-preset-details (XML)
  • application/xml
description
When the dynamic user defined fields are successfully created, the system returns an HTTP 201 (Created) code with a response body that includes information about the newly created dynamic user defined field(s) presets

PUT

Updates the list of dynamic user defined field presets.

Existing presets that do not exist in the request body will be deleted. New presets in the request body will be created. When submitting a PUT request, it should include the following path parameters

Parameters

name description type default
udfid The ID of the user defined field to update dynamic presets for. path
attach-to-limsid The LIMSID of the resource that the dynamic presets are attached to. path

Input Payload

element consumeable content type(s)
field-dynamic-preset-details (XML)
  • */*
  • application/xml
description
The request body that should include the new list of dynamic presets.

Output Payload

element produceable content type(s)
field-dynamic-preset-details (XML)
  • application/xml
description
The list of updated dynamic user defined field presets tied to the specific user defined field and resource

/{version}/configuration/udfs/{udfid}/dynamicpresets/{attach-to-limsid}

Home

REST Endpoints

XML Data Elements

XML Data Types