REST API

/{version}/processtypes/{processtypeid}/fields/{fieldid}

The following operations are supported on this resource:

GET

This method has been deprecated. User-defined fields can now be retrieved from the udfs resource directly instead of by process type (/configuration/udfs)..

Gets the representation of a user defined field for a process.

Parameters

name description type default
processtypeid The ID of the process type for the user defined field. path
fieldid The ID of the user defined field. path

Output Payload

element produceable content type(s)
field (XML)
  • application/xml
description
The representation of the user defined field for a process.

PUT

This method has been deprecated. User-defined fields can now be updated on the udf resource directly (/configuration/udfs).

Updates the mutable values for a user defined field for a process type.

Only a subset of the user defined field's attributes can be modified. Unmodifiable attributes will be ignored.

The following attributes of a user defined field can be modified:

  • name
  • display-precision
  • unit label
  • presets

Parameters

name description type default
processtypeid The ID of the process type path
fieldid The ID of the user defined field. path

Input Payload

element consumeable content type(s)
field (XML)
  • */*
  • application/xml
description
The new representation of the user defined field.

Output Payload

element produceable content type(s)
field (XML)
  • application/xml
description
The current representation of the user defined field, after modifiable attributes have been updated.

/{version}/processtypes/{processtypeid}/fields/{fieldid}

Home

REST Endpoints

XML Data Elements

XML Data Types