Añada opciones avanzadas de revisión al crear una prueba a través de la API de Adobe Workfront
Al crear una prueba en la API de Workfront, puede añadir opciones de prueba avanzadas.
Utilice uno de los siguientes flujos de trabajo para añadir opciones de prueba a una prueba mediante la API:
-
(Recomendado) Cree una prueba sencilla con la API de Workfront y luego añada opciones de prueba avanzadas a la prueba con la API de ProofHQ
-
Cree una prueba con opciones de prueba avanzadas con JSON en la API de Workfront
Cree una prueba con las API de Workfront y ProofHQ (recomendado) create-a-proof-using-the-workfront-and-proofhq-apis-recommended
En esta sección se describe cómo crear una prueba con opciones de prueba avanzadas a través de la API de Workfront, utilizando una combinación de las API de Workfront y ProofHQ.
La API de ProofHQ incluye diversas acciones que no están disponibles para las pruebas en la API de Workfront. Con estas acciones, puede modificar o configurar la prueba con más precisión de la que está disponible en la API de Workfront.
Para obtener una descripción general de la API de ProofHQ, consulte la Información general de ProofHQ. También puede consultar la Documentación de ProofHQ.
- La API de Workfront es una API completa de REST. SOAP La API de ProofHQ es una API de.
- Las pruebas creadas en la API de ProofHQ no se vinculan automáticamente a Workfront. Por lo tanto, se recomienda crear pruebas en la API de Workfront antes de actualizarlas con la API de ProofHQ.
Creación de una prueba con opciones avanzadas de revisión
-
Cree una revisión con la acción
Document createProofen la API de Workfront.note note NOTE Al crear la prueba, establezca {}como el valor del parámetroadvancedProofingOptions. -
Una vez creada la prueba, utilice la API de ProofHQ para agregar opciones avanzadas.
Ejemplos
Esta sección muestra algunas actualizaciones de ejemplo que puede realizar con la API de ProofHQ.
Ejemplos:
Se puede descargar una revisión, contiene un mensaje y se comparte públicamente
La documentación para este extremo se encuentra en la página ProofHQ API updateProof.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="https://{{soap_host}}/">
<soapenv:Header/>
<soapenv:Body>
<soap:updateProof>
<SessionID>{{session_id}}</SessionID>
<FileID>{{file_id}}</FileID>
<OwnerID>0</OwnerID>
<Name>{{proof_name}}}</Name>
<Subject>Email subject here</Subject>
<Message>Email message here</Message>
<EnableDownload>true</EnableDownload>
<EnableTeamURL>true</EnableTeamURL>
</soap:updateProof>
</soapenv:Body>
</soapenv:Envelope>
Actualice una fase para que no sea privada, no sea obligatoria y requiera solo una aprobación
La documentación para este extremo se encuentra en la página ProofHQ API updateWorkflowProofStage.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="https://{{soap_host}}/">
<soapenv:Header/>
<soapenv:Body>
<soap:updateWorkflowProofStage>
<SessionID>{{session_id}}</SessionID>
<FileID>{{proof_id}}</FileID>
<Stage>
<stage_id>{{stage_id}}</stage_id>
<name>{{stage_name}}</name>
<stage_one_decision_only>true</stage_one_decision_only>
<stage_private>false</stage_private>
<mandatory>false</mandatory>
</Stage>
</soap:updateWorkflowProofStage>
</soapenv:Body>
</soapenv:Envelope>
Agregar dos destinatarios a una prueba sin responsable principal
La documentación para este extremo se encuentra en la página ProofHQ API addWorkflowProofReviewers.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="https://{{soap_host}}/">
<soapenv:Header/>
<soapenv:Body>
<soap:addWorkflowProofReviewers>
<SessionID>{{session_id}}</SessionID>
<FileID>{{proof_id}}</FileID>
<Recipients>
<item>
<email>{{recipient_email_1}}</email>
<role>5</role>
<name>{{recipient_name_1}}</name>
<primary_decision_maker>false</primary_decision_maker>
<stage_id>{{stage_id}}</stage_id>
</item>
<item>
<email> {{recipient_email_2}} </email>
<role>5</role>
<name> {{recipient_name_2}} </name>
<primary_decision_maker>false</primary_decision_maker>
<stage_id>{{stage_id}}</stage_id>
</item>
</Recipients>
<SuppressNewProofNotification></SuppressNewProofNotification>
</soap:addWorkflowProofReviewers>
</soapenv:Body>
</soapenv:Envelope>
Cree una prueba con JSON en la API de Workfront
En esta sección se describe cómo crear una prueba con opciones de prueba avanzadas a través de la API de Workfront, utilizando JSON como valor de parámetro en la API de Workfront
Creación de una prueba con opciones avanzadas de revisión
Puede crear pruebas a través de la API de Workfront usando la acción Document createProof. Esta acción acepta el parámetro advancedProofingOptions, que tiene el tipo de valor string. Para incluir opciones de revisión avanzadas en la acción createProof, debe escribir las opciones en el parámetro advancedProofingOptions en formato JSON.
Ejemplo
Este ejemplo muestra los campos y el formato que puede utilizar al crear su JSON para el parámetro advancedProofingOptions. El archivo JSON advancedProofingOptions puede tener más o menos campos de los que se muestran aquí.
Ejemplo:
{
"stages": [
{
"name": "stage1",
"lockOn": 1,
"position": 1,
"isPrivate": false,
"activateOn": 1,
"recipients": [
{
"name": "",
"role": 5,
"email": "user1_email@example.com",
"recipient_id": "",
"notifications": 0,
"isPrimaryDecisionMaker": null
},
{
"name": "",
"role": 5,
"email": "user2_email@example.com",
"recipient_id": "",
"notifications": 0,
"isPrimaryDecisionMaker": false
}
],
"isMandatory": false,
"deadlineDate": null,
"deadlineTime": null,
"isOneApproval": true,
"activateOnDate": null,
"parentPosition": null,
"activateOnDecision": null,
"deadlineCalculateOn": null,
"deadlineBusinessDays": null
}
],
"message": "",
"subject": "",
"templates": [],
"hasMessage": true,
"canDownload": true,
"customfields": [],
"hasPublicSharing": true,
"isAutomatedWorkflow": true,
"stageBasedVisibility": 0
}