update requests documentation and values
This commit is contained in:
+36
-11
@@ -11,7 +11,7 @@ http:
|
|||||||
value: XMLHttpRequest
|
value: XMLHttpRequest
|
||||||
params:
|
params:
|
||||||
- name: request_id
|
- name: request_id
|
||||||
value: "7007"
|
value: "27547"
|
||||||
type: path
|
type: path
|
||||||
body:
|
body:
|
||||||
type: form-urlencoded
|
type: form-urlencoded
|
||||||
@@ -19,17 +19,16 @@ http:
|
|||||||
- name: username
|
- name: username
|
||||||
value: "{{elixFormsApiUsername}}"
|
value: "{{elixFormsApiUsername}}"
|
||||||
- name: outcome
|
- name: outcome
|
||||||
value: OK
|
value: KO
|
||||||
description: OK, KO
|
description: OK, KO
|
||||||
- name: resultCode
|
- name: resultCode
|
||||||
value: VAL
|
value: KO
|
||||||
description: 'possibili valori: VAL("Validata"), IMP("Importata"), IMPW("Impostata con warning"), KO("Rifiutata")'
|
description: 'possibili valori: VAL("Validata"), IMP("Importata"), IMPW("Impostata con warning"), KO("Rifiutata")'
|
||||||
- name: resultDescription
|
- name: resultDescription
|
||||||
value: ""
|
value: messaggio custom
|
||||||
description: descrizione esito processo esterno
|
description: descrizione esito processo esterno
|
||||||
disabled: true
|
|
||||||
- name: resultReceiptId
|
- name: resultReceiptId
|
||||||
value: "123"
|
value: "999"
|
||||||
description: id pratica processo esterno di riferimento
|
description: id pratica processo esterno di riferimento
|
||||||
- name: resultTimestamp
|
- name: resultTimestamp
|
||||||
value: ""
|
value: ""
|
||||||
@@ -136,8 +135,34 @@ examples:
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
docs: |-
|
docs: |
|
||||||
Viene ritornato l'esito dell'operazione di storicizzazione si elixForms©.
|
# Acquisizione delle istanze elaborate da processo esterno
|
||||||
La ricezione di "ok" o "ko" provocherà una decisione nel workflow semplice (analogo a quello di elixFlow©) in base a quanto disposto in elixForms per il modulo.
|
|
||||||
Esempio="OK","VAL","..." imposta lo stato di workflow semplice corrispondente imposta lo step ad "evasa" notifica email
|
~~Scopo: per confermare che l'istanza é stata ricevuta e non andrà più trasmessa.~~
|
||||||
Esempio="KO","KO","..." imposta lo stato di workflow semplice corrispondente non cambia lo stato dello step
|
**(MA ASSOLUTAMENTE NO!)**
|
||||||
|
|
||||||
|
Empiricamente, sposta l'istanza in stato "Evasa" e impedisce la riapertura della stessa.
|
||||||
|
|
||||||
|
## Parametri importanti
|
||||||
|
|
||||||
|
- **outcome(*)** (esito del servizio): possibili valori:
|
||||||
|
- OK
|
||||||
|
- KO
|
||||||
|
- **resultCode(*)** (codice esito processo esterno): possibili valori:
|
||||||
|
- VAL("Validata")
|
||||||
|
- IMP("Importata")
|
||||||
|
- IMPW("Impostata con warning")
|
||||||
|
- KO("Rifiutata")
|
||||||
|
- **resultDescription** (descrizione esito processo esterno)
|
||||||
|
- **resultReceiptId(*)** (id pratica processo esterno di riferimento)
|
||||||
|
- **resultTimestamp**: (timestamp di riferimento dell'elaborazione pratica dal processo esterno): in formato standard ISO 8601; se non impostata viene inizializzata con la data/ora server corrente
|
||||||
|
- **properties** (mappa chiave,valore/i aggiuntivo/i in formato json): url-encoding richiesto in UTF-8
|
||||||
|
|
||||||
|
## Descrizione
|
||||||
|
|
||||||
|
Viene ritornato l'esito dell'operazione di storicizzazione su elixForms.
|
||||||
|
|
||||||
|
La ricezione di "ok" o "ko" provocherà una decisione nel workflow semplice (analogo a quello di elixFlow) in base a quanto disposto in elixForms per il modulo.
|
||||||
|
|
||||||
|
- Esempio="OK","VAL","..." imposta lo stato di workflow semplice corrispondente imposta lo step ad "evasa" notifica email
|
||||||
|
- Esempio="KO","KO","..." imposta lo stato di workflow semplice corrispondente non cambia lo stato dello step
|
||||||
|
|||||||
+17
-8
@@ -5,7 +5,7 @@ info:
|
|||||||
|
|
||||||
http:
|
http:
|
||||||
method: POST
|
method: POST
|
||||||
url: "{{elixFormsApiUrl_Default}}/request/:request_id/swf/columns;{{elixRegisterResultColumns}}?username={{elixFormsApiUsername}}"
|
url: "{{elixFormsApiUrl_Default}}/request/:request_id/swf/{{columns}}?username={{elixFormsApiUsername}}"
|
||||||
headers:
|
headers:
|
||||||
- name: x-requested-with
|
- name: x-requested-with
|
||||||
value: XMLHttpRequest
|
value: XMLHttpRequest
|
||||||
@@ -14,12 +14,18 @@ http:
|
|||||||
value: "{{elixFormsApiUsername}}"
|
value: "{{elixFormsApiUsername}}"
|
||||||
type: query
|
type: query
|
||||||
- name: request_id
|
- name: request_id
|
||||||
value: "6085"
|
value: "27310"
|
||||||
type: path
|
type: path
|
||||||
body:
|
|
||||||
type: form-urlencoded
|
|
||||||
auth: inherit
|
auth: inherit
|
||||||
|
|
||||||
|
runtime:
|
||||||
|
variables:
|
||||||
|
- name: columns
|
||||||
|
value: ""
|
||||||
|
disabled: true
|
||||||
|
- name: columns
|
||||||
|
value: COL0001="1";COL0002={{$isoTimestamp}}
|
||||||
|
|
||||||
settings:
|
settings:
|
||||||
encodeUrl: true
|
encodeUrl: true
|
||||||
timeout: 0
|
timeout: 0
|
||||||
@@ -103,12 +109,13 @@ examples:
|
|||||||
}
|
}
|
||||||
|
|
||||||
docs: |-
|
docs: |-
|
||||||
The elixRegisterResultColumns variable must be built like the following:
|
The columns variable must be built like the following:
|
||||||
|
|
||||||
- one index=value couple for every field in the SWF schema that must be updated, where index is the "name" of the schema field (e.g.: COL0003, if the field is found in the SWF schema) and the value is the string content that must be assigned
|
- variable must start with "columns;"
|
||||||
|
- add one "index=value" couple for every field in the SWF schema to be updated, where "index" is the name of the associated SWF schema field (e.g.: COL0003) and "value" is the string content to be used
|
||||||
- each couple must be separated by a semi-period (\`;\` character)
|
- each couple must be separated by a semi-period (\`;\` character)
|
||||||
|
|
||||||
For example, suppose the request has a SWF schema with ID 356, containing:
|
For example, suppose the request has a SWF schema with ID 356 having:
|
||||||
|
|
||||||
- State = COL0001
|
- State = COL0001
|
||||||
- Date = COL0002
|
- Date = COL0002
|
||||||
@@ -117,6 +124,8 @@ docs: |-
|
|||||||
|
|
||||||
If you want to change the CURRENT state's date and message values, you will put into the variable the following value:
|
If you want to change the CURRENT state's date and message values, you will put into the variable the following value:
|
||||||
|
|
||||||
|
`columns;[{"key":"COL0002","value":"31-03-2025"},{"key":"COL0004","value":"this is the new message"}]`
|
||||||
|
|
||||||
`COL0002=31-03-2025;COL0004=this is the new message`
|
`COL0002=31-03-2025;COL0004=this is the new message`
|
||||||
|
|
||||||
Keep in mind that Postman automatically encodes the parameter, so it's allowed to use spaces and other symbols (maybe?).
|
Keep in mind that Bruno automatically encodes the parameter, so you may use spaces and other symbols (maybe?).
|
||||||
|
|||||||
Reference in New Issue
Block a user