IM-Sign 利用ガイド 第6版 2022-12-01

IM-Sign 利用ガイド 第6版 2022-12-01

6.3. Acrobat Signタスクの一覧

Acrobat Signタスクは、下記一覧に記載の130個を利用することが可能です。
IM-LogicDesignerの各タスクにおける入力値、および出力値については、Acrobat Signの入出力値と一致します。
「Acrobat Sign REST API Version 6 Methods」を参照してください。

コラム

ロジックフロー定義編集画面にて、Acrobat Signのカテゴリおよびタスクのアイコンが表示されない場合、アイコンのリカバリを実行することで表示されるようになる場合があります。
詳細は、「IM-LogicDesigner ユーザ操作ガイド」 - 「ユーザアイコンをリカバリする」を参照してください。

6.3.1. タスク一覧

Acrobat Signタスクは、IM-LogicDesignerのカテゴリを以下の6つに分けて格納しています。

6.3.1.1. 契約カテゴリ

LDタスク名 説明 メソッド URI
im_adobesignTransientDocuments ファイルのアップロード POST /transientDocuments
im_adobesignCreateAgreement 契約を作成 POST /agreements
im_adobesignAddTemplateFieldsToAgreement 契約にテンプレートフィールドを追加 POST /agreements/{agreementId}/formFields
im_adobesignCreateDelegatedParticipantSets 契約の受信者セットを登録 POST /agreements/{agreementId}/members/participantSets/{participantSetId}/delegatedParticipantSets
im_adobesignCreateShareOnAgreement 契約を共有 POST /agreements/{agreementId}/members/share
im_adobesignCreateReminderOnParticipant 契約のリマインダーを登録 POST /agreements/{agreementId}/reminders
im_adobesignCreateAgreementViews 契約の参照URLを取得 POST /agreements/{agreementId}/views
im_adobesignGetAgreements 契約の検索 GET /agreements
im_adobesignGetAgreementInfo 契約情報を取得 GET /agreements/{agreementId}
im_adobesignGetAgreementAuditTrail 契約の監査レポートを取得 GET /agreements/{agreementId}/auditTrail
im_adobesignGetAgreementCombinedDocument 契約のPDFを取得 GET /agreements/{agreementId}/combinedDocument
im_adobesignGetCombinedDocumentPagesInfo 契約のPDF情報を取得 GET /agreements/{agreementId}/combinedDocument/pagesInfo
im_adobesignGetAgreementCombinedDocumentUrl 契約のPDFのダウンロードURLを取得 GET /agreements/{agreementId}/combinedDocument/url
im_adobesignGetAgreementAllDocuments 契約のファイルを取得 GET /agreements/{agreementId}/documents
im_adobesignGetAgreementDocument 契約の個別ファイルを取得 GET /agreements/{agreementId}/documents/{documentId}
im_adobesignGetAgreementDocumentImageUrls 契約の個別ファイルイメージURLを取得 GET /agreements/{agreementId}/documents/{documentId}/imageUrls
im_adobesignGetAgreementAllDocumentsImageUrls 契約のファイルイメージURLを取得 GET /agreements/{agreementId}/documents/imageUrls
im_adobesignGetAgreementEvents 契約のアクティビティを取得 GET /agreements/{agreementId}/events
im_adobesignGetAgreementFormData 契約のフォームデータを取得 GET /agreements/{agreementId}/formData
im_adobesignGetAgreementFormFields 契約のフィールドを取得 GET /agreements/{agreementId}/formFields
im_adobesignGetAgreementMergeInfo 契約のマージ情報を更新 GET /agreements/{agreementId}/formFields/mergeInfo
im_adobesignGetAgreementNoteForApiUser 契約のメモを取得 GET /agreements/{agreementId}/me/note
im_adobesignGetAllAgreementMembers 契約の参加者を取得 GET /agreements/{agreementId}/members
im_adobesignGetAgreementParticipantSet 契約の受信者セットを取得 GET /agreements/{agreementId}/members/participantSets/{participantSetId}
im_adobesignGetAgreementSecurityOptionsForParticipation 契約の受信者のセキュリティオプションを取得 GET /agreements/{agreementId}/members/participantSets/{participantSetId}/participants/{participantId}/securityOptions
im_adobesignGetAgreementReminders 契約のリマインダーの検索 GET /agreements/{agreementId}/reminders
im_adobesignGetAgreementReminder 契約のリマインダー情報を取得 GET /agreements/{agreementId}/reminders/{reminderId}
im_adobesignGetAgreementSigningUrls 契約の署名URLを取得 GET /agreements/{agreementId}/signingUrls
im_adobesignGetAgreementInfoForUser 契約のアカウント共有情報を取得 GET /agreements/{agreementId}/me
im_adobesignUpdateAgreement 契約を更新 PUT /agreements/{agreementId}
im_adobesignUpdateAgreementFormFields 契約のフィールドを更新 PUT /agreements/{agreementId}/formFields
im_adobesignUpdateAgreementMergeInfo 契約のマージ情報を更新 PUT /agreements/{agreementId}/formFields/mergeInfo
im_adobesignUpdateAgreementVisibility 契約の可視性を更新 PUT /agreements/{agreementId}/me/visibility
im_adobesignUpdateAgreementVaulted ヴォールトサービス契約情報更新 PUT /agreements/{agreementId}/vaulted
im_adobesignUpdateAgreementParticipantSet 契約の受信者セットを更新 PUT /agreements/{agreementId}/members/participantSets/{participantSetId}
im_adobesignRejectAgreementForParticipation 契約を拒否 PUT /agreements/{agreementId}/members/participantSets/{participantSetId}/participants/{participantId}/reject
im_adobesignUpdateAgreementSecurityOptionsForParticipation 契約の受信者のセキュリティオプションを更新 PUT /agreements/{agreementId}/members/participantSets/{participantSetId}/participants/{participantId}/securityOptions
im_adobesignUpdateAgreementReminder 契約のリマインダーを更新 PUT /agreements/{agreementId}/reminders/{reminderId}
im_adobesignUpdateAgreementState 契約のステータスを更新 PUT /agreements/{agreementId}/state
im_adobesignUpdateAgreementNoteForApiUser 契約のメモを更新 PUT /agreements/{agreementId}/me/note
im_adobesignDeleteAgreementDocuments 契約のファイルを削除 DELETE /agreements/{agreementId}/documents

6.3.1.2. ユーザ/グループカテゴリ

LDタスク名 説明 メソッド URI
im_adobesignGetUserViews ユーザの参照URLを取得 POST /users/{userId}/views
im_adobesignGetUsers ユーザを検索 GET /users
im_adobesignGetUserDetail ユーザ情報を取得 GET /users/{userId}
im_adobesignGetGroupsOfUser ユーザの所属グループを取得 GET /users/{userId}/groups
im_adobesignUpdateUser ユーザを更新 PUT /users/{userId}
im_adobesignUpdateGroupsOfUser ユーザの所属グループを更新 PUT /users/{userId}/groups
im_adobesignUpdateUserState ユーザのステータス更新 PUT /users/{userId}/state
im_adobesignCreateGroup グループを登録 POST /groups
im_adobesignGetGroups グループを検索 GET /groups
im_adobesignGetGroupDetail グループ情報を取得 GET /groups/{groupId}
im_adobesignGetUsersInGroup グループに所属するユーザを取得 GET /groups/{groupId}/users
im_adobesignUpdateGroup グループを更新 PUT /groups/{groupId}
im_adobesignDeleteGroup グループを削除 DELETE /groups/{groupId}

6.3.1.3. ライブラリテンプレートカテゴリ

LDタスク名 説明 メソッド URI
im_adobesignCreateLibraryDocument ライブラリテンプレートを登録 POST /libraryDocuments
im_adobesignCreateLibraryDocumentViews ライブラリテンプレートの参照URLを取得 POST /libraryDocuments/{libraryDocumentId}/views
im_adobesignGetLibraryDocuments ライブラリテンプレートを検索 GET /libraryDocuments
im_adobesignGetLibraryDocumentInfo ライブラリテンプレート情報を取得 GET /libraryDocuments/{libraryDocumentId}
im_adobesignGetLibraryDocumentAuditTrail ライブラリテンプレートの監査レポートを取得 GET /libraryDocuments/{libraryDocumentId}/auditTrail
im_adobesignGetLibraryDocumentCombinedDocument ライブラリテンプレートのPDFを取得 GET /libraryDocuments/{libraryDocumentId}/combinedDocument
im_adobesignGetLibraryDocumentCombinedDocumentUrl ライブラリテンプレートのPDFのダウンロードURLを取得 GET /libraryDocuments/{libraryDocumentId}/combinedDocument/url
im_adobesignGetLibraryDocumentDocuments ライブラリテンプレートのファイルを取得 GET /libraryDocuments/{libraryDocumentId}/documents
im_adobesignGetLibraryDocumentDocument ライブラリテンプレートの個別ファイルを取得 GET /libraryDocuments/{libraryDocumentId}/documents/{documentId}
im_adobesignGetLibraryDocumentImageUrls ライブラリテンプレートの個別ファイルイメージURLを取得 GET /libraryDocuments/{libraryDocumentId}/documents/{documentId}/imageUrls
im_adobesignGetLibraryDocumentFormData ライブラリテンプレートのフォームデータを取得 GET /libraryDocuments/{libraryDocumentId}/formData
im_adobesignGetLibraryDocumentFormFields ライブラリテンプレートのフィールドを取得 GET /libraryDocuments/{libraryDocumentId}/formFields
im_adobesignGetAllLibraryDocumentMembers ライブラリテンプレートの参加者を取得 GET /libraryDocuments/{libraryDocumentId}/members
im_adobesignGetLibraryDocumentInfoForUser ライブラリテンプレートのアカウント共有情報を取得 GET /libraryDocuments/{libraryDocumentId}/me
im_adobesignGetLibraryDocumentEvents ライブラリテンプレートのアクティビティを取得 GET /libraryDocuments/{libraryDocumentId}/events
im_adobesignGetLibraryDocumentNoteForApiUser ライブラリテンプレートのメモを取得 GET /libraryDocuments/{libraryDocumentId}/me/note
im_adobesignUpdateLibraryDocumentFormFields ライブラリテンプレートのフィールドを更新 PUT /libraryDocuments/{libraryDocumentId}/formFields
im_adobesignUpdateLibraryDocumentNoteForApiUser ライブラリテンプレートのメモを更新 PUT /libraryDocuments/{libraryDocumentId}/me/note
im_adobesignUpdateLibraryDocument ライブラリテンプレートを更新 PUT /libraryDocuments/{libraryDocumentId}
im_adobesignUpdateLibraryDocumentVisibility ライブラリテンプレートの可視性を更新 PUT /libraryDocuments/{libraryDocumentId}/me/visibility
im_adobesignUpdateLibraryDocumentState ライブラリテンプレートのステータス更新 PUT /libraryDocuments/{libraryDocumentId}/state

6.3.1.4. Webフォームカテゴリ

LDタスク名 説明 メソッド URI
im_adobesignCreateWidget Webフォームを登録 POST /widgets
im_adobesignCreateShareOnWidget Webフォームを共有 POST /widgets/{widgetId}/members/share
im_adobesignGetWidgetViews Webフォームの参照URLを取得 POST /widgets/{widgetId}/views
im_adobesignGetWidgets Webフォームを検索 GET /widgets
im_adobesignGetWidgetInfo Webフォーム情報の取得 GET /widgets/{widgetId}
im_adobesignGetWidgetAgreements Webフォームに紐づく子契約の取得 GET /widgets/{widgetId}/agreements
im_adobesignGetWidgetAuditTrail Webフォームの監査レポートを取得 GET /widgets/{widgetId}/auditTrail
im_adobesignGetWidgetCombinedDocument WebフォームのPDFを取得 GET /widgets/{widgetId}/combinedDocument
im_adobesignGetWidgetCombinedDocumentUrl WebフォームのPDFのダウンロードURLを取得 GET /widgets/{widgetId}/combinedDocument/url
im_adobesignGetWidgetDocuments Webフォームのファイルを取得 GET /widgets/{widgetId}/documents
im_adobesignGetWidgetDocument Webフォームの個別ファイルを取得 GET /widgets/{widgetId}/documents/{documentId}
im_adobesignGetWidgetEvents Webフォームのアクティビティを取得 GET /widgets/{widgetId}/events
im_adobesignGetWidgetFormFields Webフォームのフィールドを取得 GET /widgets/{widgetId}/formFields
im_adobesignGetWidgetAllDocumentsImageUrls WebフォームのファイルイメージURLを取得 GET /widgets/{widgetId}/documents/imageUrls
im_adobesignGetWidgetFormData Webフォームのフォームデータを取得 GET /widgets/{widgetId}/formData
im_adobesignGetWidgetNoteForApiUser Webフォームのメモを取得 GET /widgets/{widgetId}/me/note
im_adobesignGetAllWidgetMembers Webフォームの参加者を取得 GET /widgets/{widgetId}/members
im_adobesignGetWidgetParticipantSet Webフォームの受信者セットを取得 GET /widgets/{widgetId}/members/participantSets/{participantSetId}
im_adobesignGetWidgetSecurityOptionsForParticipation Webフォームの受信者のセキュリティオプションを取得 GET /widgets/{widgetId}/members/participantSets/{participantSetId}/participants/{participantId}/securityOptions
im_adobesignGetWidgetInfoForUser Webフォームのアカウント共有情報を取得 GET /widgets/{widgetId}/me
im_adobesignUpdateWidget Webフォームを更新 PUT /widgets/{widgetId}
im_adobesignUpdateWidgetFormFields Webフォームのフィールドを更新 PUT /widgets/{widgetId}/formFields
im_adobesignUpdateWidgetVisibility Webフォームの可視性を更新 PUT /widgets/{widgetId}/me/visibility
im_adobesignUpdateWidgetState Webフォームのステータス更新 PUT /widgets/{widgetId}/state
im_adobesignUpdateWidgetNoteForApiUser Webフォームのメモを更新 PUT /widgets/{widgetId}/me/note
im_adobesignUpdateWidgetSecurityOptionsForParticipation Webフォームの受信者のセキュリティオプションを更新 PUT /widgets/{widgetId}/members/participantSets/{participantSetId}/participants/{participantId}/securityOptions

6.3.1.5. Megaサインカテゴリ

LDタスク名 説明 メソッド URI
im_adobesignCreateMegaSign Megaサインを登録 POST /megaSigns
im_adobesignCreateShareOnMegaSign Megaサインを共有 POST /megaSigns/{megaSignId}/members/share
im_adobesignCreateReminderOnMegaSign Megaサインのリマインダーを登録 POST /megaSigns/{megaSignId}/reminders
im_adobesignGetMegaSignViews Megaサインの参照URLを取得 POST /megaSigns/{megaSignId}/views
im_adobesignGetMegaSigns Megaサインを検索 GET /megaSigns
im_adobesignGetMegaSignInfo Megaサイン情報を取得 GET /megaSigns/{megaSignId}
im_adobesignGetMegaSignChildAgreements Megaサインに紐づく契約を取得 GET /megaSigns/{megaSignId}/agreements
im_adobesignGetMegaSignChildAgreementsInfoFile Megaサインに紐づく契約情報ファイルを取得 GET /megaSigns/{megaSignId}/childAgreementsInfo/{childAgreementsInfoFileId}
im_adobesignGetMegaSignCombinedDocument MegaサインのPDFを取得 GET /megaSigns/{megaSignId}/combinedDocument
im_adobesignGetMegaSignCombinedDocumentUrl MegaサインのPDFのダウンロードURLを取得 GET /megaSigns/{megaSignId}/combinedDocument/url
im_adobesignGetMegaSignEvents Megaサインのアクティビティを取得 GET /megaSigns/{megaSignId}/events
im_adobesignGetMegaSignFormData Megaサインのフォームデータを取得 GET /megaSigns/{megaSignId}/formData
im_adobesignGetAllMegaSignMembers Megaサインの参加者を取得 GET /megaSigns/{megaSignId}/members
im_adobesignGetMegaSignNoteForApiUser Megaサインのメモを取得 GET /megaSigns/{megaSignId}/me/note
im_adobesignGetMegaSignAllDocumentsImageUrls MegaサインのファイルイメージURLを取得 GET /megaSigns/{megaSignId}/documents/imageUrls
im_adobesignGetMegaSignAllDocuments Megaサインのファイルを取得 GET /megaSigns/{megaSignId}/documents
im_adobesignGetMegaSignDocument Megaサインの個別ファイルを取得 GET /megaSigns/{megaSignId}/documents/{documentId}
im_adobesignGetMegaSignInfoForUser Megaサインのアカウント共有情報を取得 GET /megaSigns/{megaSignId}/me
im_adobesignGetMegaSignRemindersTask Megaサインのリマインダーを検索 GET /megaSigns/{megaSignId}/reminders
im_adobesignGetMegaSignReminderTask Megaサインのリマインダー情報を取得 GET /megaSigns/{megaSignId}/reminders/{reminderId}
im_adobesignUpdateMegaSign Megaサインを更新 PUT /megaSigns/{megaSignId}
im_adobesignUpdateMegaSignReminder Megaサインのリマインダーを更新 PUT /megaSigns/{megaSignId}/reminders/{reminderId}
im_adobesignUpdateMegaSignNoteForApiUser Megaサインのメモを更新 PUT /megaSigns/{megaSignId}/me/note
im_adobesignUpdateMegaSignState Megaサインのステータス更新 PUT /megaSigns/{megaSignId}/state
im_adobesignUpdateMegaSignVisibility Megaサインの可視性を更新 PUT /megaSigns/{megaSignId}/me/visibility

6.3.1.6. 共通カテゴリ

LDタスク名 説明 メソッド URI
im_adobesignGetAccountInfo アカウント情報を取得 GET /accounts/{accountId}
im_adobesignGetWorkflows ワークフローを検索 GET /workflows
im_adobesignGetWorkflowInfo ワークフロー情報を取得 GET /workflows/{workflowId}
im_adobesignGetMessageTemplates メッセージテンプレートを検索 GET /messageTemplates