# ジョブ起動情報の取得

ジョブ起動情報を取得します。

## Request Interface

    https://ControlURL/api/v1/managements/jobs/detail/{id}

= 備考 =

WebAPIのControlURLで指定するパスはHULFTの管理画面にアクセスするためのURLと同じURLです。

詳細は以下を参照してください。

スタートアップガイド（EC2）

  : 導入手順

スタートアップガイド（Fargate）

  : 導入手順

PATH PARAMETERS

id : string

  ジョブID （必須）

  登録済みIDを指定

## Response Interface

### 200 管理情報の取得に成功

RESPONSE HEADERS

X-Request-ID : string

  WebAPI履歴のリクエストID

RESPONSE SCHEMA : application/json

id : string

  ジョブID

meta : object

  メタ情報

  modified_datetime : string <date-time>

    更新日時

  modified_user : string

    更新ユーザー

  request_user : object

    ロール情報

    systems_role : string

      APIを実行したユーザーの「ユーザーの権限」

    managements_id_role : string

      APIを実行したユーザーの「管理情報の権限」

  display_name : string

    表示名

  comment : string

    コメント

  valid_term : object

    管理情報の有効期間

    start : string <date-time>

      有効期間 (開始)

    end : string <date-time>

      有効期間 (終了)

authorities : Array of objects

  権限情報

  以下の構造の情報（Array[]）が複数（～100）取得されます。

  Array[

  type : string

    ユーザーグループID/ユーザーID

    以下のいずれかが取得されます。

    group

      : ユーザーグループIDを、3バイトから255バイトの英数字、および半角スペース、“-”、“/”、“*”を除く記号で指定

    user

      : ユーザーIDを、1024バイト以内の英数字、および“/”を除く記号で指定

  name : string

    権限付与対象名

  role : string

    管理情報の権限

    以下のいずれかが取得されます。

    owner

      : 所有者（管理情報に対してすべての操作が可能なユーザー）

    contributor

      : 更新者（管理情報の情報を更新可能なユーザー）

    executor

      : 実行者（管理情報を使用して、転送を開始できるユーザー）

    reader

      : 閲覧者（管理情報を参照できるユーザー）

    auditor

      : 監視者（履歴だけを参照できるユーザー）

  ]

steps : Array of objects

  ジョブステップ

  以下の構造の情報（Array[]）が複数（～20）取得されます。

  Array[

  title : string

    タイトル

  type : string

    ステップ種別

    以下の値が取得されます。

    webapi

      : Web APIステップ

  url : string

    URL

  method : string

    メソッド

    以下のいずれかが取得されます。

    GET

      : リソースの取得

    HEAD

      : リソースのヘッダーデータの取得

    POST

      : 子リソースの作成、リソースへのデータの追加、その他の処理

    OPTIONS

      : リソースがサポートしているメソッドの取得

    PUT

      : リソースの更新、リソースの作成

    DELETE

      : リソースの削除

    TRACE

      : 対象のリソースまでのパスに沿ってメッセージのループバックテストを実施

    PATCH

      : リソースの部分的な変更

    LINK

      : 他の情報への関連付け

    UNLINK

      : 他の情報との関連付けの解除

  query_params : Array of objects

    クエリパラメーター

    以下の構造の情報（Array[]）が複数（～20）取得されます。

    Array[

    param : string

      パラメーター名

    param_value : string

      パラメーター値

    ]

  headers : Array of objects

    ヘッダー

    以下の構造の情報（Array[]）が複数（～20）取得されます。

    Array[

    header : string

      ヘッダー名

    header_value : string

      ヘッダー値

    ]

  body : string

    ボディー

  ]

### 400 リクエストパラメーターの指定が不正

RESPONSE HEADERS

X-Request-ID : string

  WebAPI履歴のリクエストID

RESPONSE SCHEMA : application/json

request_id : string

  リクエストID

accept_datetime : string <date-time>

  受付日時

api_path : string

  APIパス

http_method : string

  HTTPリクエストのメソッド形式

  以下のいずれかが取得されます。

  GET

  HEAD

  POST

  OPTIONS

  PUT

  DELETE

  TRACE

  PATCH

  LINK

  UNLINK

errors : Array of objects

  エラー詳細情報

  以下の構造の情報（Array[]）が複数取得されます。

  Array[

  kind : string

    エラー種別

  description : string

    エラーの説明

  measure : string

    対処方法

  detail : string

    詳細エラー情報

  additional : (Error1(object or null)) or (Error2(object or null)) or (Error3(object or null))

    "Error1"、"Error2"、"Error3"のいずれかが取得されます。

    Error1
      message : string

        エラーメッセージ

      tables : Array of strings

        テーブル情報

      query : string

        クエリ情報

    Error2
      hulft_id : string

        HULFT ID

      code : integer

        実行結果

      detail : integer

        詳細コード

      message : string

        エラーメッセージ

    Error3
      message : string

        エラーメッセージ

      fields : string

        クエリ情報

  ]

### 401 認証エラー

RESPONSE HEADERS

X-Request-ID : string

  WebAPI履歴のリクエストID

RESPONSE SCHEMA : application/json

request_id : string

  リクエストID

accept_datetime : string <date-time>

  受付日時

api_path : string

  APIパス

http_method : string

  HTTPリクエストのメソッド形式

  以下のいずれかが取得されます。

  GET

  HEAD

  POST

  OPTIONS

  PUT

  DELETE

  TRACE

  PATCH

  LINK

  UNLINK

### 403 認可エラー

RESPONSE HEADERS

X-Request-ID : string

  WebAPI履歴のリクエストID

RESPONSE SCHEMA : application/json

request_id : string

  リクエストID

accept_datetime : string <date-time>

  受付日時

api_path : string

  APIパス

http_method : string

  HTTPリクエストのメソッド形式

  以下のいずれかが取得されます。

  GET

  HEAD

  POST

  OPTIONS

  PUT

  DELETE

  TRACE

  PATCH

  LINK

  UNLINK

errors : Array of objects

  エラー詳細情報

  以下の構造の情報（Array[]）が複数取得されます。

  Array[

  kind : string

    エラー種別

  description : string

    エラーの説明

  measure : string

    対処方法

  detail : string

    詳細エラー情報

  additional : (Error1(object or null)) or (Error2(object or null)) or (Error3(object or null))

    "Error1"、"Error2"、"Error3"のいずれかが取得されます。

    Error1
      message : string

        エラーメッセージ

      tables : Array of strings

        テーブル情報

      query : string

        クエリ情報

    Error2
      hulft_id : string

        HULFT ID

      code : integer

        実行結果

      detail : integer

        詳細コード

      message : string

        エラーメッセージ

    Error3
      message : string

        エラーメッセージ

      fields : string

        クエリ情報

  ]

### 404 指定したIDまたは参照先のIDが未登録

RESPONSE HEADERS

X-Request-ID : string

  WebAPI履歴のリクエストID

RESPONSE SCHEMA : application/json

request_id : string

  リクエストID

accept_datetime : string <date-time>

  受付日時

api_path : string

  APIパス

http_method : string

  HTTPリクエストのメソッド形式

  以下のいずれかが取得されます。

  GET

  HEAD

  POST

  OPTIONS

  PUT

  DELETE

  TRACE

  PATCH

  LINK

  UNLINK

errors : Array of objects

  エラー詳細情報

  以下の構造の情報（Array[]）が複数取得されます。

  Array[

  kind : string

    エラー種別

  description : string

    エラーの説明

  measure : string

    対処方法

  detail : string

    詳細エラー情報

  additional : (Error1(object or null)) or (Error2(object or null)) or (Error3(object or null))

    "Error1"、"Error2"、"Error3"のいずれかが取得されます。

    Error1
      message : string

        エラーメッセージ

      tables : Array of strings

        テーブル情報

      query : string

        クエリ情報

    Error2
      hulft_id : string

        HULFT ID

      code : integer

        実行結果

      detail : integer

        詳細コード

      message : string

        エラーメッセージ

    Error3
      message : string

        エラーメッセージ

      fields : string

        クエリ情報

  ]