Create package API, can we use data field to store some data
Thursday, February 18, 2021 at 09:29amUsing create package API, Along with creating package, can we use also use data field to store some data.
This field value we use in when retrieve the package.
"data": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
I am attaching the package request body
Reply to: Create package API, can we use data field to store some data
Thursday, February 18, 2021 at 10:45amHi Ravinder,
Thanks for your post! And somehow I think your attachment was blocked by the CMS. I did a quick test specifying nested JSON in "data" node, and can successfully retrieve it back, the JSON I tested is:
"data": {
"obj1": {
"item1": "value1",
"item2": {
"item21": "value2",
"item22": "value3"
}
}
}
Would you mind directly post the request body in plain text, or send to [email protected] so that I can try to reproduce the issue? And as a workaround, you can always encoding the properties, and add them as a string value.
Duo
Reply to: Hi Ravinder, Thanks for…
Thursday, February 18, 2021 at 11:22amHi Duo Liang,
Thanks a lot for your prompt response
Please see the request body in plain text
{
"roles": [
{
"id": "Signer1",
"signers": [
{
"lastName": "abc",
"firstName": "Test user1 ",
"email": "[email protected]",
"company": "[email protected]",
"language": "en"
}
],
"name": "Customer",
"index": 1,
"reassign": true,
"emailMessage": {
"content": "THIS IS TEST AGREEMENT."
},
"attachmentRequirements": [
{
"description": "Please upload Purchase Order (PDF format).",
"required": false,
"name": "Attachment"
}
]
}
],
"data": {
"additionalProp1": {"env":"dev"}
},
"documents": [
{
"name": "Agreement_EN.pdf",
"extract": true,
"extractionTypes": [
"TEXT_TAGS",
"ACROFIELDS"
],
"id": "Doc1"
}
],
"name": "TEST_ID-00000943",
"type": "PACKAGE",
"language": "en",
"emailMessage": "",
"description": "ID-TEST-2020-06-09T18:30:00.000Z",
"due": "2021-06-10T18:30:00.000Z",
"visibility": "ACCOUNT",
"status": "SENT",
"autocomplete": true
}
Reply to: Hi Duo Liang, Thanks a lot…
Thursday, February 18, 2021 at 11:40amI was testing in US2 sandbox environment (https://sandbox.esignlive.com/api) and this is what I retrieved with the same package JSON in Postman:
So in your case, can you see other out-of-the-box data values from response? Like "origin" or "currentSignerProgress"? What if you put a string value "additionalProp1" :"some_string_value", can it be returned?
Also, can you share a package ID that you created?
Duo
Reply to: Create package API, can we use data field to store some data
Friday, February 19, 2021 at 01:53amI can see the out-of-the-box data values from response origin, currentSignerProgress, overallProgress
The key and value that I added using create package API is retrieved later using get package API
packaged ids created are v_7o_RRHmKtAJJQy0Gaxu90HcJ8=, rhfAY4VRSDc0Tfx4aPEWv-tNZr8=, txI7oIg4tDyyCaxdBQzHV6ONbdU=
Reply to: Create package API, can we use data field to store some data
Friday, February 19, 2021 at 08:56amHi Ravinder,
Unfortunately, due to the GDPR compliance, OneSpan Sign has removed the custom package attributes from the backoffice, so I can't check the actual values in your package JSON. Could you supply some code snippets how you retrieved the package JSON? With Java, .NET http client or Postman? A screenshot with debug break point or console print would be much appreciated.
Duo