集信管理情報の取得
登録済みの集信管理情報を取得します。
Request Interface
https://ControlURL/api/v1/managements/receivings/detail/{id}
WebAPIのControlURLで指定するパスはHULFTの管理画面にアクセスするためのURLと同じURLです。
詳細は以下を参照してください。
HULFT10 for Container Platform スタートアップガイド(OpenShift) : 「導入手順」の「HULFT管理画面の起動」
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>
-
有効期間 (終了)
- accept_term : object
-
要求の受付時間帯
- start : string
-
受付時間帯 (開始)
- end : string
-
受付時間帯 (終了)
- 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
-
: 監視者(履歴だけを参照できるユーザー)
]
- file : object
-
集信ファイル
- name : string
-
集信ファイル名
- owner : string
-
オーナー名
- group : string
-
グループ名
- permission : object
-
ファイル権限
- owner : object
-
オーナー権限
- readable : boolean
-
読み込み権限
- writable : boolean
-
書き込み権限
- executable : boolean
-
実行権限
- group : object
-
グループ権限
- readable : boolean
-
読み込み権限
- writable : boolean
-
書き込み権限
- executable : boolean
-
実行権限
- other : object
-
その他のメンバー権限
- readable : boolean
-
読み込み権限
- writable : boolean
-
書き込み権限
- executable : boolean
-
実行権限
- write_mode : string
-
登録モード
以下のいずれかが取得されます。
- new
-
: 新規作成(集信ファイルを新規に作成、同名のファイルがすでに存在している場合はエラー)
- replace
-
: 置き換え(既存のファイル内容を受信データに置き換え、ファイルが存在しない場合は新規に作成)
- append
-
: 追加(既存ファイルの最後に受信データを追加、ファイルが存在しない場合は新規に作成)
- abnormal_treat : string
-
異常時の処理
以下のいずれかが取得されます。
- delete
-
: 削除(集信ファイルを削除)
- keep
-
: 保存(集信が失敗した時点の集信ファイルを保持)
- recover
-
: 復元(集信開始前に集信ファイルをバックアップし、集信が失敗したらバックアップを復元)
- code_conversion : object
-
コード変換
- own_code_set : string
-
転送コードセット
以下のいずれかが取得されます。
- system
-
: システム(システム動作環境設定の「転送コードセット」の設定値)
- utf8
-
: UTF-8
- sjis
-
: Shift-JIS
- euc_jp
-
: EUC-JP
- gb18030
-
: GB18030
- standard_for_japanese : string
-
日本語規格
以下のいずれかが取得されます。
- system
-
: システム(システム動作環境設定の「日本語規格」の設定値)
- jis83
-
: JIS83(JIS 83年度)
- jis78
-
: JIS78(JIS 78年度)
- ebcdic_set : string
-
相手ホストのEBCDICセット
以下のいずれかが取得されます。
- auto
-
: 自動
- katakana
-
: カナ文字
- lowercase
-
: 英小文字
- ascii
-
: ASCII
- japan_latin_for_ibm
-
: IBM英小文字
- japan_latin_extended_for_ibm
-
: IBM英小文字拡張
- japan_katakana_extended_for_ibm
-
: IBMカナ文字拡張
- job : object
-
ジョブ起動設定
- successful : string
-
正常時ジョブID
- unsuccessful : string
-
異常時ジョブID
- communication : object
-
通信設定
- transfer_group : string
-
転送グループID
- finish_sync_mode : string
-
集信完了通知
以下のいずれかが取得されます。
- eof
-
: 受信完了(ファイル受信完了後に通知)
- job
-
: 正常時ジョブ完了(集信後正常時ジョブ完了後に通知)
- security : object
-
セキュリティ設定
- password_type : string
-
暗号キーの種類
以下のいずれかが取得されます。
- ascii
-
: データを暗号化するキーを8バイトから20バイトの英数字で指定
- hex
-
: データを暗号化するキーを16桁から40桁の16進数で指定
- password : string <password>
-
暗号キー
- verify : string
-
データ検証
以下のいずれかが取得されます。
- none
-
: データ検証を行わない
- sha256
-
: SHA256でデータ検証を行う
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
-
クエリ情報
]