アプリケーションプログラミングインターフェイスガイド> Webサービスオペレーション> オペレーションリファレンス> beginSession
 
beginSession
新しいセッションを開始します。 Webサービスはコネクションレス型プロトコルを使用します。このオペレーションにより、複数のWebサービス呼び出しを同じセッションに属しているように見せることができます。
このオペレーションにより、HTTP接続にCookieが配置されます。クライアントがCookieをサポートしている場合、セッションを維持するために追加のアクションは必要ありません。
2番目のオプションとして、クライアントは、ユーザー名に&sessionToken=Xを使用し、空白のパスワードを提供して、HTTP基本認証で返されたセッショントークンを提供できます。ここで、Xはこのオペレーションによって返されるセッショントークン。
3番目のオプションとして、クライアントは、返されたセッショントークンに次のようなSOAPヘッダーエレメントsessionTokenを提供できます。
  <soap-env:Envelope
    xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:security="http://www.compositesw.com/services/system/util/security">
    <soap:Header>
      <security:sessionToken>b9f5d033fb4a81-b02b5b760641c1d6</security:sessionToken>
    </soap:Header>
    <soap-env:Body>
      <!-- write body element -->
    </soap-env:Body>
  </soap-env:Envelope>
 
これらのアプローチの複数を介してサーバーがトークンを受信した場合、最初にSOAPヘッダーが優先され、次にHTTP認証が優先され、最後にCookieが優先されます。
セッションが開いている間、セッション中に行われた要求に対するすべての応答には、SOAPヘッダーエレメントに「PUT_SOMETHING_HERE」セッショントークンが含まれます。
ロケーション
/services/webservices/system/util/session/operations/
リクエストエレメント
sessionTimeout(オプション):非アクティブなセッションを自動的に閉じる前に存続させる秒数。
デフォルトのセッションタイムアウトを表示するには、Studioのメニューバーから管理>構成を選択し、...>セッションの下のセッションタイムアウトパラメータの値を確認します。
sessionName(オプション):セッション名。これには通常、文字列の一部としてアプリケーション名が含まれます。
リクエスト例
<session:beginSession xmlns:session="http://www.compositesw.com/services/system/util/session">
<session:sessionTimeout>1200</session:sessionTimeout>
<session:sessionName>backup-restore-monthly</session:sessionName>
</session:beginSession>
応答エレメント
sessionToken:このセッションを一意に識別するトークン。これは、将来のオペレーションの呼び出しのためにSessionTokenSOAPヘッダー内で使用する必要があります。
エラー解析
IllegalArgument:sessionTimeoutが存在し、正の整数でない場合。
NotAllowed:現在の接続のセッションがすでに開いている場合。