Fields: GetFieldSet

Returns a field set. This is a set of fields that can appear on a room's Details tab in the console, such as contactName and phone.

Request

HTTP request

GET /restapi/v2/accounts/{accountId}/field_sets/{fieldSetId}

Parameters

Parameter NameValueDescription
Path Parameters
fieldSetIdstring

(Required) The id of the field set.

Example: 4aef602b-cf7f-4882-3481-08d76696f678

accountIdstring

(Required) The id of the account.

Responses

CodeDescriptionReference
200

FieldSet successfully retrieved.

FieldSet
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Fields::GetFieldSet

Definitions

ApiError

This object describes errors that occur. It is valid only for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

CustomData

Contains information about whether the field is required when a room is created or submitted for review.

isRequiredOnCreateboolean

When set to true, the field is required when a new room is created.

isRequiredOnSubmitboolean

When set to true, the field is required when a room is submitted for review.

DependsOn

Contains information about a parent field on which this field depends.

actionTypestring

The child field action that depends on the parent field.

Example: visibility

For example, in the console, you must select a country for a list of states to become visible.

parentApiNamestring

The name that the Rooms API uses for the parent field.

Example: country

Field

Contains details about a field in a field set.

fieldIdstring

An id that uniquely identifies the instance of a fieldDefinition within a field set.

fieldDefinitionIdstring

The id of the DocuSign field definition from which this field derives. When an Admin user configures a field set by using the API, this is the id that they use to add this field definition to the field set. The original field definition associated with this id contains more information about the field, such as the default title, default API name, and configurations such as the maximum length or the maximum value allowed.

titlestring

The human-readable title or name of the field.

Example: Company contact name

apiNamestring

The name that the Rooms API uses for the field.

Example: companyContactName

Note: When you create a new room, you use the apiName values for fields to specify the details that you want to appear on the room's Details tab.

typestring

The type of field. The valid values are:

  • Date
  • Text
  • Checkbox
  • Currency
  • Numeric
  • SelectList
  • TextArea
  • Percentage
  • Integer

fields[Field]

An array of fields.

configurationFieldConfiguration

Contains information about how the field is configured, such as the maximum length.

customDataCustomData

Contains information about whether the field is required when a room is created or submitted for review.

FieldConfiguration

Contains details about how a field is configured.

maxValuenumber

The maximum value allowed for the field.

minValuenumber

The minimum value allowed for the field.

multipleOfnumber

This property is used for validation. When you set a number value for this property, the value for the field must be a multiple of it.

maxLengthinteger

The maximum length of the field.

minLengthinteger

The minimum length of the field.

patternstring

The regular expression pattern to use to validate the value of the field.

isPublisherboolean

When set to true, the field is a parent field on which one or more child fields depend.

dependsOn[DependsOn]

This property applies to child fields. It contains information about the parent field that must have a value set in order for this field to have a value. For example, you must specify a country before you can select a state.

options[SelectListFieldOption]

An array of options in a list.

FieldSet

Contains details about a field set.

fieldSetIdstring

The id of the field set.

Example: 4aef602b-cf7f-4882-3481-08d76696f678

titlestring

The title or name of the field set.

fields[Field]

An array of fields.

SelectListFieldOption

Contains details about an option in a list.

idobject

The id of the list option.

Example: AU

titlestring

The title or name of the list option.

Example: Australia

orderinteger

The order of the list option in the list.

Example: 3

}} />