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’un BAT dans l’API Workfront, vous pouvez ajouter des options de vérification avancées.
Utilisez l’un des workflows suivants pour ajouter des options de vérification à un BAT à l’aide de l’API :
-
(Recommandé) Créez un BAT simple à l’aide de l’API Workfront, puis ajoutez des options de vérification avancées au BAT à l’aide de l’API ProofHQ.
-
Création d’un BAT avec des options de vérification avancées à l’aide de JSON dans l’API Workfront
Créer un BAT à 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 un BAT avec des options de vérification avancées via l’API Workfront, à l’aide d’une combinaison d’API Workfront et de BATHQ.
L’API ProofHQ inclut diverses actions qui ne sont pas disponibles pour les bons à tirer dans l’API Workfront. En utilisant ces actions, vous pouvez modifier ou configurer le BAT avec plus de précision que ne l’est l’API Workfront.
Pour un aperçu de l’API ProofHQ, consultez la présentation de PoofHQ. Vous pouvez également vous reporter à la documentation ProofHQ.
- L’API Workfront est une API REST-ful. L’API ProofHQ est une API SOAP.
- Les bons à tirer créés dans l’API ProofHQ ne sont pas automatiquement liés à Workfront. Par conséquent, nous vous recommandons de créer des bons à tirer dans l’API Workfront avant de les mettre à jour avec l’API ProofHQ.
Créer un BAT avec des options de vérification avancées
-
Créez un BAT à l’aide de l’action
Document createProofdans l’API Workfront.note note NOTE Lors de la création du BAT, définissez {}comme valeur du paramètreadvancedProofingOptions. -
Une fois le BAT créé, utilisez l’API ProofHQ pour ajouter toutes les options avancées.
Exemples
Cette section présente des exemples de mises à jour que vous pouvez effectuer avec l’API ProofHQ.
Exemples :
Un bon à tirer peut être téléchargé, comporte un message et est partagé publiquement
La documentation de ce point de terminaison est disponible 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 de sorte 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 .
<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 à un BAT sans décideur principal
La documentation de ce point de terminaison est disponible 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éation d’un BAT à l’aide de JSON dans l’API Workfront
Cette section décrit comment créer un BAT avec des options de vérification avancées via l’API Workfront, en utilisant JSON comme valeur de paramètre dans l’API Workfront
Créer un BAT avec des options de vérification avancées
Vous pouvez créer des bons à tirer via l’API Workfront à l’aide de l’action Document createProof. Cette action accepte le paramètre advancedProofingOptions, qui a le type de valeur string. Pour inclure des options de vérification 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 JSON pour le paramètre advancedProofingOptions. Votre fichier JSON advancedProofingOptions peut comporter plus ou moins de champs qu’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
}