GET
例
機能
FirstClassオブジェクトからフィールドレベルでデータを抽出します。GETコマンドはフィールドIDごとに要求された3種類のフィールド(fieldID、fieldtype、およびfieldvalue)のデータ行を、PUTコマンドのフィールドリストに合う形式で返します。REPLYコマンドをGETコマンドの前に記述しなければなりません。詳細はPUTコマンドを参照してください。パスの各要素はコロンで区切ってください。PATHCHARコマンドを使用すると、デフォルトのパス文字を変更できます。objdescがない場合は、PATHが使用されます。
構文
REPLY
GET keyword fieldIDs +d +D +g
宛先のフィールドを取得するために使用する場合は、以下のように入力します。
REPLY
GET keyword addressID index パラメータ
ABOUT containername |
会議室またはカレンダーの情報です。 |
ABOUTPATH containername |
ディレクトリに登録されていない会議室またはカレンダーの情報です。 |
CLIENT clientID |
クライアントIDで指定された[ユーザ情報]フォームです。または、リモート名やルートの[ディレクトリ情報]フォームです。 |
DIRECTORY directorytype |
会議室(ODInfo)、フォルダ(ODInfo)、ゲートウェイ(ODGateway)、ユーザグループ(ODInfo)の[ディレクトリ情報]フォームです。directorytypeキーワードは、conference、calendar、maillist、またはgroupです。 |
path |
管理者デスクトップからの相対パスで指定されたオブジェクトです。 |
DESKTOP userID path |
ユーザのデスクトップからの相対パスで指定されたオブジェクトです。パスの各要素はコロンで区切ってください。 |
PROFILE userID appID.formID |
ユーザIDで指定した、特定のアプリケーションのプロフィールです。アプリケーションIDとアプリケーションのプロフィールはピリオドでつなげます。 |
PROFILE clientID appID.formID |
クライアントIDで指定した、特定のアプリケーションのプロフィールです。アプリケーションIDとアプリケーションのプロフィールはピリオドでつなげます。 |
PREFERENCES userid |
ユーザの[基本設定]フォームと[印刷レイアウト]フォームです。 |
PROPERTIES path |
Macの[情報を見る]フォームまたはWindowsの[プロパティ]フォームから情報を取得するために使用します。パスは、管理者のデスクトップからの相対パスで指定します。 |
PROPERTIES byindex indexnumber path |
Macの[情報を見る]フォームまたはWindowsの[プロパティ]フォームから情報を取得するために使用します。 |
PROPERTIES byindex indexnumber DESKTOP userID path |
Macの[情報を見る]フォームまたはWindowsの[プロパティ]フォームからフィールドの情報を取得するために使用します。 |
PROPERTIES byindex indexnumber path |
Macの[情報を見る]フォームまたはWindowsの[プロパティ]フォームから情報を取得するために使用します。インデックス番号(indexnumber)を取り出すにはDIRコマンドを使用します。パスは、管理者のデスクトップからの相対パスで指定します。 |
PROPERTIES byindex indexnumber DESKTOP userID path |
Macの[情報を見る]フォームまたはWindowsの[プロパティ]フォームからフィールドの情報を取得するために使用します。インデックス番号(indexnumber)を取り出すにはDIRコマンドを使用します。 |
PERMISSIONS path |
会議室、カレンダー、またはコンタクトデータベースの権限フォームです。パスは、管理者のデスクトップからの相対パスで指定します。 |
PERMISSIONS DESKTOP userID path |
会議室、カレンダー、またはコンタクトデータベースの権限フォームです。パスは、ユーザのデスクトップからの相対パスで指定します。 |
USER userID |
ユーザIDで指定された[ユーザ情報]フォームです。 |
USERCONFIG userID |
ユーザの[メールのインポート]フォームです。 |
RESUME userid |
ユーザのプロフィールです。 |
RULES path rulename |
コンテナの[Rules & Resources]フォルダです。パスは、管理者デスクトップからの相対位置で指定します。 |
RULES DESKTOP userid path rulename |
コンテナの[Rules & Resources]フォルダです。パスは、ユーザのデスクトップからの相対位置で指定します。 |
SYSPROFILE |
システムプロファイルです。 |
fieldIDs |
取得するフィールドのフィールドIDです。フィールドIDは、FirstClassデザイナーとともにインストールされたExample.fcで調べることができます。 |
addressID |
[宛先]フィールドは4、[CC]フィールドは5、[BCC]フィールドは14です。権限フォーム上の[対象]フィールドは29です。これらのフィールドについては上記のIDを使用し、FirstClassデザイナーで表示されるフィールドIDは無視してください。 |
index |
リスト内でエントリを指定する位置です。0は一番上に表示されている名前、1は2番目に表示されている名前、というように続きます。-1にすると、すべてのエントリを取得します。 |
+d +D |
省略可能です。文字と小文字が区別されます。+dはクライアントのフォーマットで時間を返します。+Dはシステムのデフォルトのフォーマットで時間を返します。このオプションは、[ユーザ情報]フォームの[作成日時]フィールド(ID 1235)および[最終ログイン日時]フィールド(ID 1230)で使用できます。 |
例 PUTコマンドの作成
GETコマンドは、PUTコマンドを作成する際に役立ちます。例えば、[住所]フィールド(ID 1205)と[電話]フィールド(ID 1206)をすべてのユーザに追加したい場合、以下のようにGETコマンドを利用してPUT構文を作成できます。
1 FirstClassデザイナーでExample.fcを開きます。
2 [ユーザ情報]フォーム(フォームID 125)を開き、この2つのフィールドのフィールドIDを調べます。
3 任意のユーザ(この例ではsbram)の住所と電話を入力します。
4 以下のようにGETコマンドを記述して送信します。
reply
GET USER sbram 1255 1256
フィールドのID、種類、および値がサーバから返されます。
1255 0 "9055551212" 1256 0 "1212"
5 フィールドの値を適切な内容に置き換えて、PUTコマンドを作成します。ユーザID pchuのユーザに住所と電話番号の情報を追加する場合は、下記のようになります。
PUT USER pchu 1255 0 "9055551213" 1256 0 "1213" [プロフィール]フォームの情報の取得
ディレクトリに公開されているコンテナで使用します。[プロフィール]フォームのタイトル(フィールドID 1000)と本文(フィールドID 6)を取り出すには、以下のように入力します。
REPLY
GET ABOUT "General Conferences:Employee Lounge" 1000 6
会議室は、[プロフィール]フォーム(フォームID 97)を使用しています。
ディレクトリに名前が公開されていない会議室やカレンダーの[プロフィール]フォームからタイトル(フィールドID 1000)と本文(フィールドID 6)を取り出すには、以下のように入力します。
REPLY
GET ABOUTPATH "General Conferences:secret employee lounge" 1000 6 ユーザIDによるユーザ情報の取得
ユーザsbramの[ユーザ情報]フォームから[ユーザID]フィールド(ID 1201)、[名前1]フィールド(ID 1202)、[名前2]フィールド(ID 1203)および[名前3]フィールド(ID 1204)を取得するには、以下のように入力します。
REPLY
GET USER sbram 1201 1202 1203 1204
サーバから以下の情報が返されます。
1201 0 "sbram" 1202 0 "Susan 1203 0 "A" 1204 0 "Bram"
返信メッセージにユーザIDが含まれるように問い合わせを行えば、どのユーザに関する情報なのかを識別できます。1つのコマンドで複数のフィールドに対して問い合わせをする方が、複数のコマンドを送信するより効率的です。
[パスワード]フィールド(ID 1217)は、管理者アカウントからのみ取り出すことができます。sbramのパスワードを取り出すには、以下のように入力します。
REPLY
GET USER sbram 1201 1217
MD5形式でパスワードを取り出すには、以下のように入力します。
REPLY
GET USER sbram 1201 1217 +m
サーバから以下の情報が返されます。
1217 0 "brocoli"
sbramの最終ログイン日時を取り出すには、以下のように入力します。
REPLY
GET USER sbram 1201 1230 +d
サーバが1904年1月1日を返した場合は、ユーザがサーバに一度もログインしていないことを表します。
ユーザが所属するグループを知りたい場合には、[ユーザ情報]フォームの[このユーザが所属するグループ]フィールドからデータを取り出す必要があります。このフィールドは[宛先]フィールドであるため、フィールドIDは4になります。フィールドの種類は必要ありません。
REPLY
GET USER sbram 4 -1
サーバから、以下の情報が返されます。
4 0 "Regular Users"
4 1 "Employee"
4 2 "East Coast"
sbramが2番目に所属しているグループを知るには、以下のように入力します。
REPLY
GET USER sbram 4 1
他のフィールドのIDを調べる場合は、FirstClassデザイナーでexample.fcファイルの[ユーザ情報]フォーム(フォームID 125)を開いてください。 クライアントIDによるユーザ情報の取得
ユーザIDは管理者によって変更が可能ですが、クライアントIDは変更できず、同じ番号が重複して利用されることもありません。
Susan Bram(ユーザID sbram)のクライアントIDが1602であるとします。sbramの[ユーザID]フィールド(ID 1201)、[名前1]フィールド(ID 1202)、[名前2]フィールド(ID 1203)および[名前3]フィールド(ID 1204)を、クライアントIDを指定して取り出すには、以下のように入力します。
REPLY
GET CLIENT 1602 1201 1202 1203 1204
サーバから以下の情報が返されます。
1201 0 "sbram" 1202 0 "Susan 1203 0 "A" 1204 0 "Bram"
クライアントIDを使用して、DIRECTORYキーワードが対応している[ディレクトリ情報]フォームから情報を取り出すこともできます。また、CLIENTキーワードを使用して、リモート名とルートの[ディレクトリ情報]フォームから情報を取り出すことができます。
クライアントIDが1956のリモート名から[メールエイリアス]フィールドの情報を取り出すには、以下のように入力します。
REPLY
GET CLIENT 1956 1252
注意
リモートユーザの[ディレクトリ情報]フォームに表示されているクライアントIDは、リモートサイト上でのクライアントIDです。ディレクトリの一覧を使用して、自サイトでの正しいクライアントIDを調べてください。 ドメイン名の取得
[インターネットの基本設定]フォームの、[プライマリドメイン名]フィールド(ID 1001)を取得するには、以下のように入力します。
REPLY
GET "internet services:basic internet setup" 1001 インデックス番号によるカレンダー情報の取得
Employee Calendarという名のカレンダーで、Susan Bramがたくさんの予定を登録しているとします。大半のコマンドはオブジェクトの名前を指定して動作させることができますが、このカレンダーでは、多くのイベントがSusan Bramという同じ名前になっています。また、PATHCHARコマンドを使えば件名を指定できますが、このカレンダーには同じ件名のイベントが複数登録されています。このような場合には、BYINDEXキーワードが使用できます。
以下のコマンドを送信すると、予定のインデックス番号を取り出せます。
REPLY
DIR "general conferences:employee lounge:employee calendar" +pld
サーバから、以下のようなメッセージが返されます。
Contents of:"general conferences:employee lounge:employee calendar"
[L:2] "Susan Bram" "避難訓練" 2004/05/17 09:06:48
[L:3] "Susan Bram" "ランチミーティング" 2004/04/17 09:08:28
[L:4] "Susan Bram" "資金調達に関する会議" 2004/05/17 09:09:24
[L:5] "Susan Bram" "ランチミーティング" 2004/05/17 09:45:43
4月の「ランチミーティング」の予定に対して操作を行うには、以下のコマンドを入力します。
REPLY
DIR BYINDEX 3 "general conferences:employee lounge:employee calendar" 1009
同じ予定の[プロパティ]フォームに対して操作を行うには、以下のコマンドを入力します。
REPLY
DIR PROPERTIES BYINDEX 3 "general conferences:employee lounge:employee calendar" 1016
Susan Bramのデスクトップにあるカレンダーに対して操作を行う場合、コマンドは以下のようになります。
REPLY
GET PROPERTIES byindex 3 desktop sbram "calendar" 1016
詳しくはDIRコマンドを参照してください。 ホームページ情報の取得
SusanのデスクトップにあるWebフォルダ内に保存されたHome Pageというドキュメントの本文を取り出すには、以下のように入力します。
REPLY
GET DESKTOP sbram "my web site:home page" 6 アプリケーションプロフィール情報の取得
フォームID 4001を使用してローカルアプリケーションを作成したとします。また、アプリケーション作成の際、このアプリケーションのプロフィールを表示するために独自のフォームも作成したとします。アプリケーションの[プロフィール]フォームのIDは1001にしました。ユーザIDで指定されたこのアプリケーションのプロフィールからフィールドID 2001の情報を取得するには、以下のように入力します。
REPLY
GET PROFILE USER sbram 4001.1001 2001
クライアントID(1706)で指定されたこのアプリケーションのプロフィールからフィールドID 2001の情報を取得するには、以下のように入力します。
REPLY
GET PROFILE CLIENT 1706 4001.1001 2001 権限情報の取得
[コンタクトの権限]フォーム上にある[対象]部分の先頭のエントリを取り出すには、以下のように入力します。
REPLY
GET PERMISSIONS "General Conferences:Employee Lounge:Customer List" 29 0
[コンタクトの権限]フォーム上にある[対象]部分のすべてのエントリを取り出すには、以下のように入力します。
REPLY
GET PERMISSIONS "General Conferences:Employee Lounge:Customer List" 29 -1
上の例は、会議室とカレンダーでも利用できます。メンバー一覧と[所属]フィールドはGETコマンドに対応していません。
EXPORTコマンドを使用して、権限フォームから利用可能なすべてのフィールドの情報を取り出すことができます。[所属]フィールドとメンバー一覧を除く権限フォームの内容を取得するには、以下のように入力します。
EXPORT "General Conferences:Employee Lounge:Customer List" +np 基本設定情報の取得
[基本設定]フォーム(ID 127)の[返信テキスト]フィールド(ID 1106)を取り出すには、以下のように入力します。
REPLY
GET PREFERENCES sbram 1106
注意
10000以上の値のフィールドは取り出せません。
デフォルト値は保存されていません。例えば、ユーザが[返信の設定]フィールドをデフォルトの「自動」に設定していると、空のメッセージが返されます。 プロパティ情報の取得
[Employee Lounge]会議室の[プロパティ]フォームから、[アイコンID]フィールド(ID 1304)、[名前]フィールド(ID 1017)、[場所]フィールド(ID 1020)、および[作成者]フィールド(ID 1043)の情報を取り出し、この会議室が保護されているかどうか([保護]フィールド(ID 1016))を調べるには、以下のように入力します。
REPLY
GET PROPERTIES "General Conferences:employee lounge" 1304 1017 1020 1043 1016
Susanがデスクトップ上に[Presentations]という会議室を作成したとします。この会議室の[プロパティ]フォームから、[アイコンID]フィールド(ID 1304)、[名前]フィールド(ID 1017)、[場所]フィールド(ID 1020)、および[作成者]フィールド(ID 1043)の情報を取り出し、この会議室が保護(フィールドID 1016)されているかどうかを調べるには、以下のように入力します。
REPLY
GET PROPERTIES DESKTOP sbram presentations 1304 1017 1020 1043 1016
他のフィールドIDを調べる場合は、FirstClassデザイナーで[情報を見る]フォーム(フォームID 111)を開いてください。 [メールのインポート]フォームの情報の取得
sbramの[メールのインポート]フォームから、[アイコンID]フィールド(ID 2005)、[メールサーバ]フィールド(ID 2000)、[ユーザ名]フィールド(ID 2001)、[パスワード]フィールド(ID 2002)、および[メールアドレス]フィールド(ID 2003)を取り出すには、以下のように入力します。
REPLY
GET USERCONFIG sbram 2005 2000 2001 2002 2003
他のフィールドのIDを調べる場合は、FirstClassデザイナーで[メールのインポート]フォーム(フォームID 68)を開いてください。 プロフィール情報の取得
Susan Bram(ユーザID sbram)のプロフィールから[個人の電子メール]フィールド(ID 5)と本文(フィールドID 6)を取得するには、以下のように入力します。
REPLY
GET RESUME sbram 6 5 -1
-1を付けることで、[個人の電子メール]フィールドの先頭のエントリだけではなく、全エントリが抽出されます。他のフィールドのIDを調べる場合は、FirstClassデザイナーで[プロフィール]フォーム(フォームID 20502)を開いてください。 ルールが有効になっているかどうかの確認
「次のフォルダに保存する」というルールが有効になっているかどうか(フィールドID 13800)を確認するには、以下のように入力します。
REPLY
GET RULES "General Conferences:employee lounge" "次のフォルダに保存する" 13800
サーバから空の引用符(””)が返されたら、このフィールドは有効になっていることを表します。デフォルトでは、ルールは有効になっているため、値1はサーバに保存されません。 システムプロファイル情報の取得
システムプロファイルから、[ユーザおよび会議室を作成するボリューム]フィールド(ID 1224)、[シリアル番号]フィールド(ID 1217)、および[バージョン]フィールド(ID 1202)を取り出すには、以下のように入力します。
REPLY
GET SYSPROFILE 1224 1217 1202
他のフィールドのIDを調べる場合は、FirstClassデザイナーで[システムプロファイル]フォーム(フォームID 122)を開いてください。
関連するコマンド
フィールドの値を変更するには、PUTコマンドを参照してください。
オブジェクトを作成するには、NEWコマンドを参照してください。
インデックス番号を指定してオブジェクトを操作するには、DIRコマンドを参照してください。
すべてのフォームデータを含むスクリプトを生成するには、EXPORTコマンドを参照してください。
|