移動先

• リクエスト
• レスポンス
• 例

イベントのインスタンス・サマリーの取得

get

/mftapp/rest/v1/events/{eventSessionId}

イベント・ステータスおよび様々なステータスに対するインスタンス数を取得します。パス・パラメータとしてeventSessionIdを送信する必要があります。

リクエストでは、オプションのブール・パラメータfileCountがサポートされます。デフォルト値は、falseです。trueに設定した場合、レスポンスにはdownloadableFileCount、stagedFileCountおよびsourceFileCountが含まれます。

リクエスト

パス・パラメータ

• eventSessionId(required): string
  イベント・セッションのID
• fileCount: boolean
  trueに設定した場合、レスポンスにはdownLoadableFileCount、stagedFileCountおよびsourceFileCountが含まれます。

トップに戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200レスポンス

イベント・ステータス。

本文 ()

ルート・スキーマ: eventStatus

型: object

タイトル: eventStatus

ソースを表示

• activeInstanceCount: integer
  アクティブなインスタンスの数。
• comments: string
  イベントの成功または失敗の理由を説明する文字列値。
• completedInstanceCount: integer
  完了したインスタンスの数。
• downloadableFileCount: integer
  fileCountをtrueにした場合に、ファイル・フィルタの適用後にソース・ロケーションにあるダウンロード可能な候補ファイルであるファイルの数。ソース・タイプがファイル、FTPおよびSFTPソースの場合のみ適用可能です。
• failedInstanceCount: integer
  失敗したインスタンスの数。
• sourceFileCount: integer
  fileCountをtrueにした場合に、ファイル・フィルタの適用後にソースにあるファイルの数。ソース・タイプがファイル、FTPおよびSFTPソースの場合のみ適用可能です。
• stagedFileCount: integer
  fileCountをtrueにした場合に、Managed File Transferに正常にステージングされたファイルの数。
• status: string
  インスタンスのステータスを示す文字列値。

{
    "title":"eventStatus",
    "type":"object",
    "properties":{
        "activeInstanceCount":{
            "type":"integer",
            "description":"The number of active instances."
        },
        "completedInstanceCount":{
            "type":"integer",
            "description":"The number of completed instances."
        },
        "downloadableFileCount":{
            "type":"integer",
            "description":"When <code>fileCount</code> is <code>true</code>, the number of files at the source location that are downloadable candidate files, after the file filters are applied. Applicable for File, FTP, and SFTP source types only."
        },
        "failedInstanceCount":{
            "type":"integer",
            "description":"The number of failed instances."
        },
        "stagedFileCount":{
            "type":"integer",
            "description":"When <code>fileCount</code> is <code>true</code>, the number of files successfully staged in Managed File Transfer."
        },
        "sourceFileCount":{
            "type":"integer",
            "description":"When <code>fileCount</code> is <code>true</code>, the number of files at the source after the file filters are applied. Applicable for File, FTP, and SFTP source types only."
        },
        "status":{
            "type":"string",
            "description":"String value depicting status of the instance."
        },
        "comments":{
            "type":"string",
            "description":"String value describing success or failure reason of the event."
        }
    }
}

500レスポンス

エラー情報。

本文 ()

ルート・スキーマ : errors

型: object

タイトル: errors

ソースを表示

• errorCode: string
  Oracle Managed File Transferから返されるエラー・コード。
• errorKey: string
  Oracle Managed File Transferから返されるエラー・キー。
• errorMessage: string
  Oracle Managed File Transferから返されるエラーを説明するメッセージ。

{
    "title":"errors",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"The error code that Oracle Managed File Transfer returns."
        },
        "errorKey":{
            "type":"string",
            "description":"The error key that Oracle Managed File Transfer returns."
        },
        "errorMessage":{
            "type":"string",
            "description":"A message describing the error that Oracle Managed File Transfer returns."
        }
    }
}

トップに戻る

例

次のcURLの例は、cURLを使用してRESTリソースにGETリクエストを発行して、イベント・サマリーを取得する方法を示しています。

curl -i -X GET -u <username>:<password> -H "Content-Type: application/json"  http://<host>:<port>/mftapp/rest/v1/events/77990703-A512-4469-924C-891170EC0EAA 

レスポンス本文の例: 200レスポンス

次の例では、正常終了したリクエストのレスポンス本文のコンテンツを示しています(JSON形式)。

{
  "activeInstanceCount":"0"
   "completedInstanceCount":"5"
   "failedInstanceCount":"0"
   "status":"DONE" 
}

レスポンス本文の例: 500レスポンス

次の例では、正常終了したリクエストのレスポンス本文のコンテンツを示しています(JSON形式):

{
   "errorCode":"MFT-5436"
   "errorKey":"MFT_WS_EVENT_SERVICE_NO_EVENT_FOUND"
   "errorMessage":"Error in processing EventService request. No Event found with provided Event Session Id {id}."     
} 

トップに戻る