Agregar documentos a sobres usando plantillas compuestas en DocuSign

Question

Estoy tratando de agregar documentos a una plantilla compuesta utilizando la API DocUsign y los documentos no están cargando en el sobre de la forma en que esperaría que lo haga. Actualmente tengo mi código trabajando con una prueba JSON donde agrego documentos sin usar plantillas compuestas y funciona perfectamente. Parece que las plantillas compuestas se saltan de inmediato los documentos. Aquí es cómo lo estoy creando:

{
"emailSubject": "Test Email Subject_FA",
"emailBlurb": "Test Email Body_FA",
"status": "created",
"compositeTemplates": [
    {
        "inlineTemplates": [
            {
                "sequence": "1",
                "recipients": {
                    "signers": [
                        {
                            "email": "test1@yahoo.com",
                            "name": "test1",
                            "recipientId": "1",
                            "routingOrder": "1",
                            "roleName": "Client 1"
                        },
                        {
                            "email": "test2@gmail.com",
                            "name": "test2",
                            "recipientId": "2",
                            "routingOrder": "2",
                            "roleName": "Client 2"
                        }
                    ],
                    "documents": [
                        {
                            "transformPdfFields": "false",
                            "name": "test0.pdf",
                            "documentId": "1"
                        }
                    ]
                }
            }
        ]
    },
    {
        "inlineTemplates": [
            {
                "sequence": "1",
                "recipients": {
                    "signers": [
                        {
                            "email": "test1@yahoo.com",
                            "name": "test1",
                            "recipientId": "1",
                            "routingOrder": "1",
                            "roleName": "Client 1"
                        },
                        {
                            "email": "test2@gmail.com",
                            "name": "test2",
                            "recipientId": "2",
                            "routingOrder": "2",
                            "roleName": "Client 2"
                        }
                    ],
                    "documents": [
                        {
                            "transformPdfFields": "false",
                            "name": "test1.pdf",
                            "documentId": "2"
                        }
                    ]
                }
            }
        ]
    }
]

}

Esta es una pequeña prueba que lo estoy haciendo, así que entiendo que esto es poco práctico. Pero lo que estoy tratando de entender es por qué esto no agregaría documentos al sobre. La solicitud a continuación hace lo que estoy tratando de hacer arriba.

{
"emailSubject": "Test Email Subject_FA",
"emailBlurb": "Test Email Body_FA",
"status": "created",
"documents": [
    {
        "name": "test0.pdf",
        "documentId": "1"
    },
    {
        "name": "test1.pdf",
        "documentId": "2"
    },
    {
        "name": "test2.pdf",
        "documentId": "3"
    }
],
"recipients": {
    "signers": [
        {
            "email": "test1@yahoo.com",
            "name": "test1",
            "recipientId": "1",
            "clientUserId": "1",
            "signerName": "test1",
            "defaultRecipient": "true",
            "defaultRecipientSpecified": "true",
            "routingOrder": "1"
        },
        {
            "email": "test2@gmail.com",
            "name": "test2",
            "recipientId": "2",
            "clientUserId": "2",
            "signerName": "test2",
            "routingOrder": "2"
        }
    ]
}

}

¿Alguien sabe por qué mi sobre para la plantilla compuesta no cargará los documentos?

¡Gracias de antemano!

update :

Aquí está mi solicitud de la plantilla compuesta:

--MY_BOUNDARY
Content-Type: application/json
Content-Disposition: form-data
{                
"emailSubject": "Test Email Subject_FA",
"emailBlurb": "Test Email Body_FA",
"status" : "created",               
"compositeTemplates": [               
{                    
"inlineTemplates": [  
{ 
    "sequence": "1",    
    "recipients": 
    {                           
        "signers": [                              
        {                              
            "email": "test1@yahoo.com",    
            "name": "test1",             
            "recipientId": "1"                
        },                              
        {                              
            "email": "test2@gmail.com",  
            "name": "test2",         
            "recipientId": "2"              
        }                            
        ],                           
        "document":                  
        {                            
            "name": "test0",              
            "documentId": "1",            
            "fileExtension": "pdf"         
        }                               
    }                  
}                  
]               
},               
{                
"inlineTemplates": [   
{                     
    "sequence": "2",       
    "recipients": {         
    "signers": [            
        {                        
            "email": "test1@yahoo.com",   
            "name": "test1",          
            "recipientId": "1"
        },
        {                              
            "email": "test3@yahoo.com",  
            "name": "test3",                           
            "recipientId": "2"                               
        }
    ],                  
    "document":                                 
        {    
            "name": "test1",                             
            "documentId": "2",                           
            "fileExtension": "pdf"                       
        }                                             
    }                  
}                  
]               
}               
]           
}
--MY_BOUNDARY

Content-Type: application/pdf
Content-Disposition: file; filename="test0.pdf"; documentid="1"

--MY_BOUNDARY

Content-Type: application/pdf
Content-Disposition: file; filename="test1.pdf"; documentid="2"




--MY_BOUNDARY--

He ajustado mi documento para usar el nombre y la textura de archivos, así que dejé fuera la extensión .pdf en el nombre de archivo, ya que parece ser otro método para implementar esto. Lo he intentado en ambos sentidos y no tuve suerte.

Answer 1

En la solicitud JSON que publicó, está especificando " documentos " (plural) como una recopilación / matriz de objetos strong>, lo que no es correcto. Cada elemento de plantilla compuesto dentro de la matriz de composición solo puede contener, a lo sumo, un documento solo . Esto significa que la sintaxis JSON para especificar el documento dentro de una plantilla compuesta es la siguiente:

"document": {
    "documentId": 1,
    "name": "test1.pdf"
}

i.e., Documento es singular, y es un objeto (no una matriz de objetos). La sintaxis de solicitud completa de la solicitud JSON de 'Plantillas compuestas' se muestra en la respuesta de su pregunta anterior: ¿Cómo aplico una plantilla? a un documento usando DocUsign REST API .

re la "actualización" a su pregunta:

En la parte JSON de la solicitud que ha publicado en "Actualización", noté que ha incluido Documento dentro del objeto de los destinatarios (que está contenido Dentro del inlinetemplates objeto): esta no es la ubicación correcta para documento . Compare su estructura JSON detenidamente con la siguiente estructura (correcta) y ajuste su solicitud en consecuencia. Esencialmente, el documento debe ser un compañero de inlinetemplates - no ubicado dentro de inlinetemplates .

POST https://demo.docusign.net/restapi/v2/accounts/ACCOUNTNBR/envelopes HTTP/1.1

X-DocuSign-Authentication: {"Username":"USERNAME","Password":"PASSWORD","IntegratorKey":"INTEGRATORKEY"}
Content-Type: multipart/form-data; boundary=MY_BOUNDARY
Accept: application/json
Host: demo.docusign.net
Content-Length: 162100

--MY_BOUNDARY
Content-Type: application/json
Content-Disposition: form-data

{
    "status" : "sent",
    "emailSubject" : "Test Envelope Subject",
    "emailBlurb" : "Test Envelope Blurb",
    "compositeTemplates": [
    {
        "inlineTemplates": [
        {
            "sequence" : 1,
            "recipients": {
                "signers" : [{
                    "email": "abbysemail@outlook.com",
                    "name": "Abby Abbott",
                    "recipientId": "1"
                }]
            }
        }],
        "document": {
            "documentId": 1,
            "name": "CustomerAgreement",
            "fileExtension": "pdf"
        }
    }]
}

--MY_BOUNDARY
Content-Type: application/pdf
Content-Disposition: file; filename="CustomerAgreement.pdf"; documentid="1"

    <document bytes removed>

--MY_BOUNDARY
Content-Type: application/pdf
Content-Disposition: file; filename="Invoice.pdf"; documentid="2"

    <document bytes removed>

--MY_BOUNDARY--