Skip to content
Cloud APIs
/
/
/
CreateParameterDefinition...

CreateParameterDefinitionRequestDto

namestring, [ 1 .. 128 ] charactersrequired

Gets or Sets Name

typeParameterTypeDto (string)required
One of:

The parameter type.

string(ParameterTypeDto)
Enum:"Number""String""Boolean""Options"
levelObjectTypeDto (string)required
One of:

The DrillPlan object type.

string(ObjectTypeDto)
Enum:"Well""Wellbore""Section"
descriptionstring or null, <= 500 characters

Gets or Sets Description

is_available_as_ddiboolean or null

Gets or Sets IsAvailableAsDDI

unique_idstring or null, <= 500 characters

Gets or Sets UniqueId

tagsArray of strings or null

Gets or Sets Tags

optionsobject

Gets or Sets Options (also be called as List on UI)

{
  "name": "string",
  "type": "Number",
  "level": "Well",
  "description": "string",
  "is_available_as_ddi": true,
  "unique_id": "string",
  "tags": [
    "string"
  ],
  "options": {
    "property1": "string",
    "property2": "string"
  }
}