機械翻訳について

ジャンプ先

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

条件に一致するジョブを取得

get

/api/v4/jobresource/jobinstances

サポートされるバージョン:

v4

リクエスト

問合せパラメータ

• fromdate: string
  オプション。 2つの日付の間のすべてのジョブを取得するために、toDateとともに使用されます。 このパラメータは、開始日を渡すために使用されます。 日付は書式である必要があります : YYYYMMDD
• jobid: string
  オプション。 ジョブ定義のID。
• jobmode: string
  デフォルト値: ALL
• jobtype: string
  オプション。 ジョブのタイプ。例: EXPORT/ENRICH。
• limit: integer
  オプション。 整数値を取得します。 リスト・ページのページ区切りで使用されます。

  デフォルト値: 15
• offset: integer
  オプション。 整数値を取得します。 リスト・ページのページ区切りで使用されます。

  デフォルト値: 0
• searchstring: string
  オプション。 文字列に基づいてジョブを検索するには、文字列値を渡します。
• sortorder: string
  ジョブがリストされるOptional.Order。 受け入れられる値はASCとDESCで、それぞれ昇順と降順を表します。
• sorttype: string
  オプション。 sortType =ジョブ名、タイプ、日付、送信者、ジョブ・ステータス、JobInstanceId、PartyType、EndTimeに基づいて出力をソートするために使用されます。

  デフォルト値: Date
• todate: string
  オプション。 2つの日付の間のすべてのジョブを取得するために、fromDateとともに使用されます。 このパラメータは、終了日を渡すために使用されます。 日付は書式である必要があります : YYYYMMDD

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

• application/xml; charset=UTF-8
• application/json; charset=UTF-8

200 レスポンス

成功

本文( )

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• completedRecordsCount: integer (int64)
• failedRecordsCount: integer (int64)
• jobInstanceList: array jobInstanceList
• jobInstancesList: array jobInstancesList
• totalRecordsCount: integer (int64)

{
    "properties":{
        "completedRecordsCount":{
            "format":"int64",
            "type":"integer"
        },
        "failedRecordsCount":{
            "format":"int64",
            "type":"integer"
        },
        "jobInstancesList":{
            "items":{
            },
            "type":"array"
        },
        "totalRecordsCount":{
            "format":"int64",
            "type":"integer"
        },
        "jobInstanceList":{
            "items":{
            },
            "type":"array"
        }
    },
    "type":"object"
}

ネストされたスキーマ : jobInstanceList

タイプ: array

ソースを表示

• Array of:

{
    "items":{
    },
    "type":"array"
}

ネストされたスキーマ : jobInstancesList

タイプ: array

ソースを表示

• Array of:

{
    "items":{
    },
    "type":"array"
}

404 レスポンス

リクエストされたリソースが見つかりませんでした。

500 レスポンス

リクエスト中に予期しないエラーが発生しました。

トップに戻る

例:

リクエストの例:

/api/v4/jobresource/jobinstances?jobid=123&searchstring=test&sorttype=Date&offset=0&limit=100&jobtype=Export

出力例:

{
    "jobInstanceList": {
        "completed": "4",
        "createdBy": "daas_user1",
        "createdOn": "2014-03-26 08:20:02.974237",
        "duplicated": "0",
        "failed": "4",
        "fileName": " "test ".csv",
        "jobDefDesc": "Enrichment of data",
        "jobDefId": "10095",
        "jobDefName": " "test "",
        "jobDefSearchType": "COMPANIES",
        "jobDefType": "ENRICH",
        "jobInstanceId": "10095",
        "modifiedBy": "daas_user1",
        "modifiedOn": "2014-03-26 08:20:03.561359",
        "rejected": "2",
        "status": "COMPLETED"
    },
    "totalRecordsCount": "1"
}

「トップに戻る」