Campo
Contrato de respuesta: campo.
Este esquema conserva los nombres técnicos, tipos y restricciones de la API. Las propiedades incluidas en required son obligatorias; nullable admite null. oneOf requiere una variante, anyOf admite las variantes indicadas y allOf combina sus restricciones.
Propiedades principales
| Propiedad | Tipo | Obligatoria | Restricciones |
|---|---|---|---|
envelopeId | string | Sí | Sin restricciones adicionales en este nivel. |
envelopeItemId | string | Sí | Sin restricciones adicionales en este nivel. |
type | string | Sí | Valores: "SIGNATURE", "FREE_SIGNATURE", "INITIALS", "NAME", "EMAIL", "DATE", "TEXT", "NUMBER", "RADIO", "CHECKBOX", "DROPDOWN" |
id | number | Sí | Sin restricciones adicionales en este nivel. |
secondaryId | string | Sí | Sin restricciones adicionales en este nivel. |
recipientId | number | Sí | Sin restricciones adicionales en este nivel. |
page | number | Sí | Sin restricciones adicionales en este nivel. |
positionX | estructura no especificada | Sí | Sin restricciones adicionales en este nivel. |
positionY | estructura no especificada | Sí | Sin restricciones adicionales en este nivel. |
width | estructura no especificada | Sí | Sin restricciones adicionales en este nivel. |
height | estructura no especificada | Sí | Sin restricciones adicionales en este nivel. |
customText | string | Sí | Sin restricciones adicionales en este nivel. |
inserted | boolean | Sí | Sin restricciones adicionales en este nivel. |
fieldMeta | una variante (oneOf) o null | Sí | Sin restricciones adicionales en este nivel. |
En esta respuesta, el contrato deja positionX, positionY, width y height sin un tipo explícito. Los números del ejemplo son valores sintéticos; conserva la representación que devuelve la API y no deduzcas un tipo de respuesta a partir del ejemplo.
Ejemplo de la estructura
Este objeto es una muestra sintética de la estructura. Los identificadores, fechas, estados y tokens sirven como ejemplos de formato; no describen una operación real ni valores predeterminados.
{
"envelopeId": "sobre_de_ejemplo",
"envelopeItemId": "archivo_de_ejemplo",
"type": "SIGNATURE",
"id": 701,
"secondaryId": "field_secundario_de_ejemplo",
"recipientId": 501,
"page": 1,
"positionX": 60,
"positionY": 75,
"width": 25,
"height": 8,
"customText": "valor_de_ejemplo",
"inserted": false,
"fieldMeta": null
}Ver el esquema JSON completo
{
"type": "object",
"properties": {
"envelopeId": {
"type": "string"
},
"envelopeItemId": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"SIGNATURE",
"FREE_SIGNATURE",
"INITIALS",
"NAME",
"EMAIL",
"DATE",
"TEXT",
"NUMBER",
"RADIO",
"CHECKBOX",
"DROPDOWN"
]
},
"id": {
"type": "number"
},
"secondaryId": {
"type": "string"
},
"recipientId": {
"type": "number"
},
"page": {
"type": "number"
},
"positionX": {},
"positionY": {},
"width": {},
"height": {},
"customText": {
"type": "string"
},
"inserted": {
"type": "boolean"
},
"fieldMeta": {
"nullable": true,
"oneOf": [
{
"type": "object",
"properties": {
"label": {
"type": "string"
},
"placeholder": {
"type": "string"
},
"required": {
"type": "boolean"
},
"readOnly": {
"type": "boolean"
},
"fontSize": {
"type": "number",
"minimum": 8,
"maximum": 96,
"default": 12
},
"overflow": {
"type": "string",
"enum": [
"auto",
"horizontal",
"vertical",
"crop"
],
"default": "auto"
},
"type": {
"type": "string",
"enum": [
"signature"
]
}
},
"required": [
"overflow",
"type"
]
},
{
"type": "object",
"properties": {
"label": {
"type": "string"
},
"placeholder": {
"type": "string"
},
"required": {
"type": "boolean"
},
"readOnly": {
"type": "boolean"
},
"fontSize": {
"type": "number",
"minimum": 8,
"maximum": 96,
"default": 12
},
"overflow": {
"type": "string",
"enum": [
"auto",
"horizontal",
"vertical",
"crop"
]
},
"type": {
"type": "string",
"enum": [
"initials"
]
},
"textAlign": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"label": {
"type": "string"
},
"placeholder": {
"type": "string"
},
"required": {
"type": "boolean"
},
"readOnly": {
"type": "boolean"
},
"fontSize": {
"type": "number",
"minimum": 8,
"maximum": 96,
"default": 12
},
"overflow": {
"type": "string",
"enum": [
"auto",
"horizontal",
"vertical",
"crop"
]
},
"type": {
"type": "string",
"enum": [
"name"
]
},
"textAlign": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"label": {
"type": "string"
},
"placeholder": {
"type": "string"
},
"required": {
"type": "boolean"
},
"readOnly": {
"type": "boolean"
},
"fontSize": {
"type": "number",
"minimum": 8,
"maximum": 96,
"default": 12
},
"overflow": {
"type": "string",
"enum": [
"auto",
"horizontal",
"vertical",
"crop"
],
"default": "auto"
},
"type": {
"type": "string",
"enum": [
"email"
]
},
"textAlign": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
}
},
"required": [
"overflow",
"type"
]
},
{
"type": "object",
"properties": {
"label": {
"type": "string"
},
"placeholder": {
"type": "string"
},
"required": {
"type": "boolean"
},
"readOnly": {
"type": "boolean"
},
"fontSize": {
"type": "number",
"minimum": 8,
"maximum": 96,
"default": 12
},
"overflow": {
"type": "string",
"enum": [
"auto",
"horizontal",
"vertical",
"crop"
],
"default": "auto"
},
"type": {
"type": "string",
"enum": [
"date"
]
},
"textAlign": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
}
},
"required": [
"overflow",
"type"
]
},
{
"type": "object",
"properties": {
"label": {
"type": "string"
},
"placeholder": {
"type": "string"
},
"required": {
"type": "boolean"
},
"readOnly": {
"type": "boolean"
},
"fontSize": {
"type": "number",
"minimum": 8,
"maximum": 96,
"default": 12
},
"overflow": {
"type": "string",
"enum": [
"auto",
"horizontal",
"vertical",
"crop"
]
},
"type": {
"type": "string",
"enum": [
"text"
]
},
"text": {
"type": "string"
},
"characterLimit": {
"type": "number",
"minimum": 0
},
"textAlign": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
},
"lineHeight": {
"type": "number",
"nullable": true,
"minimum": 1,
"maximum": 10
},
"letterSpacing": {
"type": "number",
"nullable": true,
"minimum": 0,
"maximum": 100
},
"verticalAlign": {
"type": "string",
"nullable": true,
"enum": [
"top",
"middle",
"bottom",
null
]
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"label": {
"type": "string"
},
"placeholder": {
"type": "string"
},
"required": {
"type": "boolean"
},
"readOnly": {
"type": "boolean"
},
"fontSize": {
"type": "number",
"minimum": 8,
"maximum": 96,
"default": 12
},
"overflow": {
"type": "string",
"enum": [
"auto",
"horizontal",
"vertical",
"crop"
]
},
"type": {
"type": "string",
"enum": [
"number"
]
},
"numberFormat": {
"type": "string",
"nullable": true
},
"value": {
"type": "string"
},
"minValue": {
"type": "number",
"nullable": true
},
"maxValue": {
"type": "number",
"nullable": true
},
"textAlign": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
},
"lineHeight": {
"type": "number",
"nullable": true,
"minimum": 1,
"maximum": 10
},
"letterSpacing": {
"type": "number",
"nullable": true,
"minimum": 0,
"maximum": 100
},
"verticalAlign": {
"type": "string",
"nullable": true,
"enum": [
"top",
"middle",
"bottom",
null
]
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"label": {
"type": "string"
},
"placeholder": {
"type": "string"
},
"required": {
"type": "boolean"
},
"readOnly": {
"type": "boolean"
},
"fontSize": {
"type": "number",
"minimum": 8,
"maximum": 96,
"default": 12
},
"overflow": {
"type": "string",
"enum": [
"auto",
"horizontal",
"vertical",
"crop"
]
},
"type": {
"type": "string",
"enum": [
"radio"
]
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"checked": {
"type": "boolean"
},
"value": {
"type": "string"
}
},
"required": [
"id",
"checked",
"value"
]
}
},
"direction": {
"type": "string",
"enum": [
"vertical",
"horizontal"
],
"default": "vertical"
}
},
"required": [
"type",
"direction"
]
},
{
"type": "object",
"properties": {
"label": {
"type": "string"
},
"placeholder": {
"type": "string"
},
"required": {
"type": "boolean"
},
"readOnly": {
"type": "boolean"
},
"fontSize": {
"type": "number",
"minimum": 8,
"maximum": 96,
"default": 12
},
"overflow": {
"type": "string",
"enum": [
"auto",
"horizontal",
"vertical",
"crop"
]
},
"type": {
"type": "string",
"enum": [
"checkbox"
]
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"checked": {
"type": "boolean"
},
"value": {
"type": "string"
}
},
"required": [
"id",
"checked",
"value"
]
}
},
"validationRule": {
"type": "string"
},
"validationLength": {
"type": "number"
},
"direction": {
"type": "string",
"enum": [
"vertical",
"horizontal"
],
"default": "vertical"
}
},
"required": [
"type",
"direction"
]
},
{
"type": "object",
"properties": {
"label": {
"type": "string"
},
"placeholder": {
"type": "string"
},
"required": {
"type": "boolean"
},
"readOnly": {
"type": "boolean"
},
"fontSize": {
"type": "number",
"minimum": 8,
"maximum": 96,
"default": 12
},
"overflow": {
"type": "string",
"enum": [
"auto",
"horizontal",
"vertical",
"crop"
]
},
"type": {
"type": "string",
"enum": [
"dropdown"
]
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string"
}
},
"required": [
"value"
]
}
},
"defaultValue": {
"type": "string"
}
},
"required": [
"type"
]
}
]
}
},
"required": [
"envelopeId",
"envelopeItemId",
"type",
"id",
"secondaryId",
"recipientId",
"page",
"positionX",
"positionY",
"width",
"height",
"customText",
"inserted",
"fieldMeta"
]
}