开发者中心

Ottieni dettagli modello

GET /esignglobal/v1/templates/templateDetail

Descrizione dell'interfaccia

Recupera le informazioni sui controlli nel modello.

Tramite il numero del modello di contrattotemplateIdper ottenere le informazioni sui controlli di compilazione impostati nel modello, che possono essere successivamente utilizzate tramite l'interfacciaCompila il modello per generare il file per riempire il modello.

Parametri di richiesta

Nome parametro

Tipo

Obbligatorio

Descrizione

templateId

string

true

ID del modello di contratto, può essere interrogato nell'elenco dei modelli di eSignGlobal

Esempio di richiesta

GET  https:// … …/esignglobal/v1/templates/templateDetail?templateId=d288b477-ed3c-4fe6-801c-80d8ec5fe9cf

Parametri di risposta

Nome parametro

Tipo

Descrizione

templateId

string

ID modello contratto

templateName

string

Nome modello contratto

templateType

int

Tipo modello contratto: 0-PDF, 1-WORD

createTime

string

Data di creazione del modello di contratto (formato timestamp Unix, unità: millisecondi)

updateTime

string

Data di aggiornamento del modello di contratto (formato timestamp Unix, unità: millisecondi)

templateStatus

int

Stato del modello di contratto: 0-Non abilitato, 1-Abilitato

fields

array

Informazioni sull'elenco dei controlli nel modello

 

fieldId

string

ID controllo (generato automaticamente dal sistema eSignGlobal durante l'impostazione del modello di contratto)

 

fieldKey

string

Chiave di controllo (definita dall'utente durante l'impostazione del modello di contratto)

 

fieldName

string

Nome controllo

 

required

boolean

Controllo obbligatorio:

True-Obbligatorio, false-Non obbligatorio

 

fieldType

string

1-Testo a riga singola, 2-Numero, 3-Data, 8-Testo multilinea, 9-Casella di controllo multipla, 10- Scelta singola, 11- Immagine, 14-Menu a tendina, 15-Casella di spunta

 

fieldPosition

object

Informazioni sulla posizione del controllo (restituito solo dal modello PDF)

 

 

posX

float

Coordinata X orizzontale della posizione del controllo

 

 

posY

float

Coordinata Y verticale della posizione del controllo

 

 

posNo

int

Pagina in cui si trova il controllo

 

 

movable

boolean

Consenti lo spostamento della posizione durante la firma, predefinito false

false - Non consentire al firmatario di regolare la posizione del proprio controllo di firma

true - Consenti al firmatario di regolare la posizione del proprio controllo di firma

 

fieldSpecialAttribute

object

Proprietà univoche del controllo

 

 

dateFormat

string

Formato data (univoco per il controllo data)

 

 

imageType

string

Tipo di immagine (univoco per il controllo immagine)

 

 

options

array

Opzioni (specifiche per controlli a tendina, controlli radio e controlli a selezione multipla)

 

 

 

optionContent

string

Contenuto dell'opzione

 

 

 

optionOrder

int

Ordine delle opzioni

 

 

 

selected

boolean

Opzione selezionata per impostazione predefinita?

 

 

numberFormat

string

Formato numero (specifico per il controllo numerico), il formato è il seguente: 0-intero, 0.0-conserva una cifra decimale, 0.00-conserva due cifre decimali

 

 

tableContent 

array

Contenuto delle righe e delle colonne della tabella (specifico per il controllo tabella dinamica), formato: [row{"column1":"value1","column2":"value2"}]

Note aggiuntive:

row indica la riga corrispondente alla tabella dinamica, il numero di righe dipende dal modello

Il numero di righe aggiunte nel controllo tabella dinamica.

column1 indica il valore della chiave della cella nella riga corrente, value1 indica il valore della cella nella riga corrente. Se la cella non ha un valore fisso impostato, è una stringa vuota "", altrimenti è il valore fisso impostato.

Vedi la spiegazione di tableContent.

 

 

fieldMaxLength

string

Limite massimo di lunghezza riempibile, unità: caratteri cinesi

[Nota] 1 carattere cinese = 2 caratteri inglesi;

 

 

fieldSize

object

Dimensioni del controllo

 

 

fieldWidth

float

Larghezza del controllo (distanza orizzontale del rettangolo, in px)

 

 

 

fieldHeight

float

Altezza del controllo (distanza verticale del rettangolo, in px)

Esempio di risposta

{
    "code": "0",
    "data ": {
        "createTime": 1693910774808,
        "fields": [
            {
                "fieldId": "7e4bbdb838f64a31b0a4bdea18d1613c",
                "fieldKey": "",
                "fieldName": "身份证号 ",
                "fieldPosition": null,
                "fieldSize": {
                    "fieldHeight": "",
                    "fieldWidth": ""
                },
                "fieldSpecialAttribute": {
                    "dateFormat": "yyyy/MM/dd ",
                    "fieldMaxLength": "",
                    "imageType": "",
                    "numberFormat": "",
                    "options": [

                    ],
                    "tableContent": [

                    ]
                },
                "fieldType": 3,
                "required": false
            }
        ],
        "templateId": "d288b477-ed3c-4fe6-801c-80d8ec5fe9cf",
        "templateName": "test123456 ",
        "templateStatus": 0,
        "updateTime": 1693911131351
    },
    "message": "成功 "
}

 

Descrizione dell'interfaccia
Parametri di richiesta
Esempio di richiesta
Parametri di risposta
Esempio di risposta