リクエストトークンを取得する
リクエストトークンを取得するAPIです。
API名
UtilGetRequestToken
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.5.0以降
返されるトークンは固定トークンで、同一セッション内なら使い回す事ができます。
※セッション認証を行わない場合はリクエストトークンを必要としないため、本APIを呼び出す必要はありません。
リクエスト
| パラメーター名 | 型 | パラーメーター数 | 説明 |
| - | - | - | - |
リクエスト例
なし
レスポンス
API名とレスポンスの要素名が異なるためご注意ください。
| パラメーター名 | 型 | パラメーター数 | 説明 |
| request_token/text() | xsd:string | 1 | リクエストトークン |
レスポンス例
<returns> <request_token>56cadf654fe6486881eec47ac0589035</request_token> </returns>
補足
取得したリクエストトークンを用いてAPIを利用する場合、以下のようにリクエストのbodyにリクエストトークンを含めます。
リクエストトークンを利用したリクエスト例（sheduleaddfollows）
<soap-env:body>
<scheduleaddfollows>
<parameters>
<request_token>56cadf654fe6486881eec47ac0589035</request_token>
<follow xmlns="" event_id="65" content="followcontent"></follow>
</parameters>
</scheduleaddfollows>
</soap-env:body>
レスポンス例
<soap:body>
<schedule:scheduleaddfollowsresponse>
<returns>
<schedule_event id="65" ... >
...
</schedule_event>
</returns>
</schedule:scheduleaddfollowsresponse>
</soap:body>
またリクエストトークンが必要なAPI一覧は以下です。
| Application | API |
| Admin | AdminAddUserAccount AdminModifyUserAccount AdminRemoveUsersByIds AdminAddOrg AdminModifyOrgInfo AdminRemoveOrgsByIds AdminAddUsersToOrg AdminSetOrgsOfUser AdminAddChildrenOfOrg AdminRemoveUsersFromOrg |
| Schedule | ScheduleAddEvents ScheduleModifyEvents ScheduleModifyRepeatEvents ScheduleRemoveEvents ScheduleRemoveEventsFromRepeatEvent ScheduleAddFollows ScheduleAddFollowsToRepeatEvent ScheduleRemoveFollows ScheduleDetermineTemporaryEvents ScheduleRemoveTemporaryEventCandidates ScheduleParticipateEvents ScheduleParticipateEventsToRepeatEvent ScheduleLeaveEvents ScheduleLeaveEventsFromRepeatEvent ScheduleSetProfiles |
| Address | AddressAddCards AddressModifyCards AddressRemovePersonalCards AddressRemoveSharedCards AddressCopyPersonalCardsToOtherBook AddressAddMyAddressGroups AddressModifyMyAddressGroups AddressRemoveMyAddressGroups AddressModifyCardsInMyAddressGroup AddressSetProfiles |
| Workflow | WorkflowHandleApplications WorkflowSetProxies |
| MailSendMails MailReplyMails MailForwardMails MailSaveDraftMails MailRemoveMails MailOpenDispositionNotifications MailAddFolders MailModifyFolders MailRemoveFolders MailMoveMailsToOtherFolder MailSetProfiles MailCreateUserAccount MailEditUserAccount MailDeleteUserAccount MailAddMailServers MailModifyMailServers MailRemoveMailServers |
|
| Message | MessageCreateThreads MessageModifyThreads MessageSaveDraftThreads MessageConfirmThreads MessageRemoveThreads MessageAddFollows MessageRemoveFollows MessageSetProfiles |
| Notification | NotificationConfirmNotification NotificationSetProfiles |
| Report | ReportAddFollows ReportRemoveFollows ReportRemoveReports |
| Cabinet | CabinetAddFile CabinetUpdateFile CabinetUpdateFileInformation CabinetDeleteFiles |
| Star | StarAddStars StarRemoveStars |
| Bulletin | BulletinCreateTopics BulletinModifyTopics BulletinSaveDraftTopics BulletinRemoveTopics BulletinAddFollows BulletinRemoveFollows |
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。