Postmanスクリプトリファレンス
pm
pm.info.eventName:String：現在実行中のスクリプトのタイプ（前処理スクリプトまたは後処理スクリプト）pm.info.iteration:Number：現在の繰り返し回数（テストコレクションでのみ有効）pm.info.iterationCount:Number：総繰り返し回数（テストコレクションでのみ有効）pm.info.requestName:String：現在実行中のAPIの名前pm.info.requestId:String：現在実行中のAPIのIDpm.sendRequest
pm.sendRequest:Functionpm.sendRequestは、スクリプト内で非同期にHTTP/HTTPSリクエストを送信するために使用する。pm.variables
pm.variables: Variable SDKのドキュメントを参照。ローカル変数 > 環境変数 > プロジェクト内で共有されるグローバル変数 > チーム内で共有されるグローバル変数pm.variables.has(variableName:String):function → Boolean：一時変数が存在するかチェックするpm.variables.get(variableName:String):function → *：一時変数を取得するpm.variables.set(variableName:String, variableValue:String):function → void：一時変数を設定するpm.variables.replaceIn(variableName:String):function：文字列内の「動的変数」（例：{{variable_name}}）を実際の値に置き換える。例：pm.variables.replaceInAsync(variableName:String):function：文字列内の「動的値の式」（例：{{$person.fullName}}）を実際の値に置き換える。このメソッドはPromiseを返すため、呼び出し時にawaitを使用する必要がある。例：pm.variables.toObject():function → Object：すべてのローカル変数をオブジェクトとして取得するpm.iterationData
pm.iterationData:pm.iterationData.has(variableName:String):function → Boolean：テスト変数が存在するかチェックするpm.iterationData.get(variableName:String):function → *：テスト変数を取得するpm.iterationData.replaceIn(variableName:String):function：文字列内の動的変数（例：{{variable_name}}）を実際の値に置き換えるpm.iterationData.toObject():function → Object：すべてのローカル変数をオブジェクトとして取得するpm.environment
pm.environment.name:String：環境名pm.environment.has(variableName:String):function → Boolean：環境変数が存在するかチェックするpm.environment.get(variableName:String):function → *：環境変数を取得するpm.environment.set(variableName:String, variableValue:String):function：環境変数を設定するpm.environment.replaceIn(variableName:String):function：文字列内の動的変数（例：{{variable_name}}）を実際の値に置き換えるpm.environment.toObject():function → Object：すべてのローカル変数をオブジェクトとして取得するpm.environment.unset(variableName:String):function：環境変数を解除するpm.environment.clear():function：現在の環境下のすべての環境変数をクリアするTIP
pm.globals
pm.globals.has(variableName:String):function → Boolean：グローバル変数が存在するかチェックするpm.globals.get(variableName:String，variableScope:String):function → *: グローバル変数を取得する。変数のスコープを指定するには「PROJECT」（デフォルト）または「TEAM」を使用。pm.globals.set(variableName:String，variableValue:String，variableScope:String):function: グローバル変数を設定する。変数のスコープを指定するには「PROJECT」（デフォルト）または「TEAM」を使用。pm.globals.replaceIn(variableName:String):function：文字列内の動的変数（例：{{variable_name}}）を実際の値に置き換える前処理スクリプトで変数を含むリクエストパラメータの値を取得するには、 pm.globals.replaceInを使用して変数を実際の値に置き換える
pm.globals.toObject():function → Object: すべてのグローバル変数をオブジェクトとして取得する。pm.globals.unset(variableName:String，variableScope:String):function: グローバル変数を解除する。変数のスコープを指定するには「PROJECT」（デフォルト）または「TEAM」を使用。pm.globals.clear():function：現在の環境下のすべてのグローバル変数をクリアするTIP
1.
2.
pm.request
pm.request：詳しくはRequest SDKドキュメントを参照。requestはAPIリクエストオブジェクトだ。前処理スクリプトでは、これから送信されるリクエストを指し、後処理スクリプトでは、既に送信されたリクエストを指す。requestには以下の情報が含まれる：pm.request.url：Url：現在のリクエストのURLpm.request.getBaseUrl()：現在の実行環境で選択されたBASE URLを取得する。この機能はバージョン2.1.39以降でサポートされているpm.request.headers：HeaderList：現在のリクエストのヘッダーリストpm.request.method:String：現在のリクエストのメソッド（GETやPOSTなど）pm.request.body：RequestBody：現在のリクエストのボディpm.request.headers.add({ key: headerName:String, value: headerValue:String}):function：現在のリクエストにヘッダーを追加するpm.request.headers.remove(headerName:String):function：現在のリクエストからヘッダーを削除するpm.request.headers.upsert({ key: headerName:String, value: headerValue:String}):function：現在のリクエストのヘッダーを更新または追加する。キーが既に存在する場合は修正される以下のAPIは 後処理スクリプトでのみ使用できる。
pm.response
pm.response：詳しくはResponse SDKドキュメントを参照。pm.responseを使用する。pm.response.code:Numberpm.response.status:Stringpm.response.headers：HeaderListpm.response.responseTime:Numberpm.response.responseSize:Numberpm.response.text():Function → Stringpm.response.json():Function → Objectpm.cookies
pm.cookies.has(cookieName:String):Function → BooleancookieName のクッキー値が存在するかチェックする
pm.cookies.get(cookieName:String):Function → StringcookieName からクッキー値を取得する
pm.cookies.toObject:Function → Object現在のドメインの下にあるすべてのクッキーをオブジェクトとして取得する
pm.cookies.jar().clear(pm.request.url)すべてのクッキーをクリアする
TIP
pm.test
done（オプションパラメータ）を使用して、非同期テストを実行できる：pm.test.index():Function → Number特定の場所からのテストの総数を取得する
pm.expect
pm.expectはアサーションメソッドだ。ChaiJS expects BDDライブラリのドキュメントを参照してね。pm.response.to.have.*
pm.response.to.have.status(code:Number)pm.response.to.have.status(reason:String)pm.response.to.have.header(key:String)pm.response.to.have.header(key:String, optionalValue:String)pm.response.to.have.body()pm.response.to.have.body(optionalValue:String)pm.response.to.have.body(optionalValue:RegExp)pm.response.to.have.jsonBody()pm.response.to.have.jsonBody(optionalExpectEqual:Object)pm.response.to.have.jsonBody(optionalExpectPath:String)pm.response.to.have.jsonBody(optionalExpectPath:String, optionalValue:*)pm.response.to.have.jsonSchema(schema:Object)pm.response.to.have.jsonSchema(schema:Object, ajvOptions:Object)pm.response.to.be.*
pm.response.to.beを使用して、クイックアサーションを行うことができる：pm.response.to.be.infoステータスコードが1XXかどうかをチェックする
pm.response.to.be.successステータスコードが2XXかどうかをチェックする
pm.response.to.be.redirectionステータスコードが3XXかどうかをチェックする
pm.response.to.be.clientErrorステータスコードが4XXかどうかをチェックする
pm.response.to.be.serverErrorステータスコードが5XXかどうかをチェックする
pm.response.to.be.errorステータスコードが4XXまたは5XXかどうかをチェックする
pm.response.to.be.okステータスコードが200かどうかをチェックする
pm.response.to.be.acceptedステータスコードが202かどうかをチェックする
pm.response.to.be.badRequestステータスコードが400かどうかをチェックする
pm.response.to.be.unauthorizedステータスコードが401かどうかをチェックする
pm.response.to.be.forbiddenステータスコードが403かどうかをチェックする
pm.response.to.be.notFoundステータスコードが404かどうかをチェックする
pm.response.to.be.rateLimitedステータスコードが429かどうかをチェックする
Modified at 2025-01-16 07:46:38