# ジョブ起動情報の登録および更新

ジョブ起動情報を登録および更新します。

## Examples

REQUEST EXAMPLE

サンプルは以下となります。

    {
      "id": "JOBID",
      "meta": {
        "display_name": "display name",
        "comment": "sample comment",
        "valid_term": {
          "start": "2025-10-03T03:04:05+09:00",
          "end": "2025-10-04T03:04:05+09:00"
        }
      },
      "authorities": [
        {
          "type": "user",
          "name": "user_name",
          "role": "owner"
        }
      ],
      "steps": [
        {
          "title": "notify job",
          "type": "webapi",
          "url": "https://hooks.hulft.com/services/xxxx/yyyy/zzzz",
          "method": "POST",
          "headers": [
            {
              "header": "Authorization",
              "header_value": "Bearer token"
            }
          ],
          "body": "{\"id\": \"notify_id\"}"
        }
      ]
    }

## Request Interface

    https://ControlURL/api/v1/managements/jobs/detail

= 備考 =

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

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

HULFT10 for Container Platform スタートアップガイド（OpenShift） : 「導入手順」の「HULFT管理画面の起動」

REQUEST BODY SCHEMA : application/json

id : string

  ジョブID （必須）

  50バイト以内で指定します。

  英数字および“_”で指定します。

meta : object

  メタ情報 （必須）

  display_name : string

    表示名 （必須）

    1024バイト以内で指定します。

  comment : string

    コメント

    1024バイト以内で指定します。

  valid_term : object

    管理情報の有効期間

    start : string <date-time>

      有効期間 (開始)

    end : string <date-time>

      有効期間 (終了)

      「有効期間 (終了)」は「有効期間 (開始)」より後の時間を指定します。

authorities : Array of objects

  権限情報

  最大権限情報数：100

  以下の構造の情報（Array[]）を複数設定可能です。

  Array[

  type : string

    ユーザーグループID/ユーザーID （必須）

    管理情報に対する権限を保持している、ユーザーグループおよびユーザーのID

    以下のいずれかを指定します。

    group

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

    user

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

  name : string

    権限付与対象名 （必須）

  role : string

    管理情報の権限 （必須）

    「ユーザーグループID」および「ユーザーID」の、管理情報に対する権限

    以下のいずれかを指定します。

    owner

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

    contributor

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

    executor

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

    reader

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

    auditor

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

  ]

steps : Array of objects

  ジョブステップ （必須）

  実行するWeb APIステップを指定します。

  最大実行ステップ数：20

  以下の構造の情報（Array[]）を複数（～20）設定可能です。

  Array[

  title : string

    タイトル （必須）

    起動するジョブのステップ名称

    1024バイト以内で指定します。

  type : string

    ステップ種別 （必須）

    起動するジョブのステップ種別

    以下の値を指定します。

    webapi

      : Web APIステップ

  url : string

    URL （必須）

    起動するジョブのURL

    4096バイト以内で指定します。

  method : string

    メソッド （必須）

    起動するジョブのメソッド

    以下のいずれかを指定します。

    GET

      : リソースの取得

    HEAD

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

    POST

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

    OPTIONS

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

    PUT

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

    DELETE

      : リソースの削除

    TRACE

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

    PATCH

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

    LINK

      : 他の情報への関連付け

    UNLINK

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

  query_params : Array of objects

    クエリパラメーター

    最大クエリパラメーター数：20

    以下の構造の情報（Array[]）を複数（～20）設定可能です。

    Array[

    param : string

      パラメーター名 （必須）

      パラメーターの名称

      128バイト以内で指定します。

    param_value : string

      パラメーター値 （必須）

      パラメーターの値

      特定のリソースを操作して取得する際に必要な情報を指定します。

      URIの指定で「?」の後に記載される値です。

      4096バイト以内で指定します。

    ]

  headers : Array of objects

    ヘッダー

    最大ヘッダー数：20

    以下の構造の情報（Array[]）を複数（～20）設定可能です。

    Array[

    header : string

      ヘッダー名 （必須）

      ヘッダーの名称

      ヘッダー名は一意にする必要があります。

      128バイト以内で指定します。

    header_value : string

      ヘッダー値 （必須）

      ヘッダーの値

      4096バイト以内で指定します。

    ]

  body : string

    ボディー

    リクエストのボディー

    追加および更新する際の内容を指定します。

    2097152バイト以内で指定します。

  ]

## 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

    ボディー

  ]

### 201 新規管理情報の登録に成功

RESPONSE HEADERS

X-Request-ID : string

  WebAPI履歴のリクエストID

Location : string

  作成されたリソースのパス

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

        クエリ情報

  ]