リクエストトークンを取得する

目次

リクエストトークンを取得する

リクエストトークンを取得する API です。

API名

UtilGetRequestToken

利用できるバージョン

  • クラウド版 Garoon
  • パッケージ版 Garoon 3.5 以降

返されるトークンは固定トークンで、同一セッション内なら使い回すことができます。
セッション認証をしない場合はリクエストトークンを必要としないため、この API を呼び出す必要はありません。

リクエストパラメーター

なし

レスポンスパラメーター

API 名とレスポンスの要素名が異なります。

パラメーター名 パラメーター数 説明
request_token/text() xsd:string 1 リクエストトークン
1
2
3
<returns>
  <request_token>56cadf654fe6486881eec47ac0589035</request_token>
</returns>

補足

取得したリクエストトークンを用いて API を利用する場合、次のようにリクエストの body にリクエストトークンを含めます。

リクエストトークンを利用したリクエスト例(sheduleaddfollows)
1
2
3
4
5
6
7
8
<soap-env:body>
  <scheduleaddfollows>
    <parameters>
      <request_token>56cadf654fe6486881eec47ac0589035</request_token>
      <follow xmlns="" event_id="65" content="followcontent"></follow>
    </parameters>
  </scheduleaddfollows>
</soap-env:body>
レスポンス例
1
2
3
4
5
6
7
8
9
<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
Mail
  • 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