Ajouter des options de relecture avancées lors de la création d’une épreuve via l’API Adobe Workfront
Lors de la création d’une épreuve dans l’API Workfront, vous pouvez ajouter des options de relecture avancées.
Utilisez l’un des workflows suivants pour ajouter des options de relecture à une épreuve à l’aide de l’API :
-
(Recommandé) Créer une épreuve simple à l’aide de l’API Workfront, puis ajouter des options de relecture avancées à l’épreuve à l’aide de l’API ProofHQ.
-
Créer une épreuve avec des options de relecture avancées à l’aide d’un fichier JSON dans l’API Workfront
Créer une épreuve à l’aide des API Workfront et ProofHQ (recommandé) create-a-proof-using-the-workfront-and-proofhq-apis-recommended
Cette section décrit comment créer une épreuve avec des options de relecture avancées via l’API Workfront, à l’aide d’une combinaison d’API Workfront et ProofHQ.
L’API ProofHQ inclut diverses actions qui ne sont pas disponibles pour les épreuves dans l’API Workfront. En utilisant ces actions, vous pouvez modifier ou configurer l’épreuve avec plus de précision que l’API Workfront.
Pour une vue d’ensemble de l’API ProofHQ, voir Vue d’ensemble de PoofHQ. Vous pouvez également consulter la documentation de ProofHQ.
- L’API Workfront est une API REST-ful. L’API ProofHQ est une API SOAP.
- Les épreuves créées dans l’API ProofHQ ne sont pas automatiquement liées à Workfront. Par conséquent, nous vous recommandons de créer des épreuves dans l’API Workfront avant de les mettre à jour avec l’API ProofHQ.
Créer une épreuve avec des options de relecture avancées
-
Créez une épreuve à l’aide de l’action
Document createProofdans l’API Workfront.note note NOTE Lors de la création de l’épreuve, définissez {}comme valeur du paramètreadvancedProofingOptions. -
Une fois l’épreuve créée, utilisez l’API ProofHQ pour ajouter les options avancées.
Exemples
Cette section présente des exemples de mises à jour que vous pouvez effectuer avec l’API ProofHQ.
Exemples :
Une épreuve peut être téléchargée, comporte un message et est partagée publiquement
La documentation de ce point d’entrée se trouve sur la page 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>
Mettre à jour une étape afin qu’elle ne soit pas privée, pas obligatoire et ne nécessite qu’une seule approbation
La documentation de ce point de terminaison se trouve sur la page API ProofHQ updateWorkflowProofStage page.
<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>
Ajouter deux destinataires à une épreuve sans personne décisionnaire principale
La documentation de ce point d’entrée se trouve sur la page API ProofHQ 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>
Créer une épreuve à l’aide d’un fichier JSON dans l’API Workfront
Cette section décrit comment créer une épreuve avec des options de relecture avancées via l’API Workfront, en utilisant JSON comme valeur de paramètre dans l’API Workfront
Créer une épreuve avec des options de relecture avancées
Vous pouvez créer des épreuves via l’API Workfront à l’aide de l’action Document createProof. Cette action accepte le paramètre advancedProofingOptions qui possède le type de valeur string. Pour inclure des options de relecture avancées dans votre action createProof, vous devez saisir les options dans le paramètre advancedProofingOptions au format JSON.
Exemple
Cet exemple présente les champs et la mise en forme que vous pouvez utiliser lors de la création de votre fichier JSON pour le paramètre advancedProofingOptions. Votre fichier JSON advancedProofingOptions peut comporter plus ou moins de champs que celui illustré ici.
Exemple :
{
"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
}