BENTEN API documentation version v1
https://agent-host:5000/benten/v1
/auth
post
ログイン処理
post /auth/login
ログイン処理
Body
Media type: application/x-www-form-urlencoded
Type: object
Properties- username: required(string)
ユーザー名
Example:
BL14B2 - password: required(string)
パスワード
Example:
test - access_ip: (string)
アクセス元のIPアドレス (Web portalで利用)
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$id": "/auth/login.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
}
}Example:
{
"access_token":"b8a9d44798c14a108b4e0299bee50d1e",
"refresh_token":"127d441f4f2b4058a69a6e751ad4abfc",
"expires_in":86400,
"expires_time":1552369982
}
post
ログアウト処理
post /auth/logout
ログアウト処理
Secured by oidc_credentials
authentification with OpenID Connect 1.0 (Resource Owner Password Credentials)
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$id": "/auth/logout.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
}
}Example:
{
"deleted": true
}Secured by oidc_credentials
Headers
- Authorization: required(string)
Example:
Bearer ced168b33f624fef9c0b1d824a591c41
post
アクセストークン更新
post /auth/refresh_token
アクセストークン更新
Secured by oidc_credentials
authentification with OpenID Connect 1.0 (Resource Owner Password Credentials)
Body
Media type: application/x-www-form-urlencoded
Type: object
Properties- refresh_token: required(string)
リフレッシュトークン
Example:
07168bbf11da4e868dc182a6286dda61
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$id": "/auth/refresh_token.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
}
}Example:
{
"access_token":"19ff2e1f8e544f499eb05855d7fc29b3",
"refresh_token":"51feb32c590e42d4b92ab9d9935e1fe8",
"expires_in":86400,
"expires_time":1552370057
}
Secured by oidc_credentials
Headers
- Authorization: required(string)
Example:
Bearer ced168b33f624fef9c0b1d824a591c41
post
ユーザー情報取得
post /auth/userinfo
ユーザー情報取得
Secured by oidc_credentials
authentification with OpenID Connect 1.0 (Resource Owner Password Credentials)
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$id": "/auth/userinfo.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
}
}Example:
{
"username":"xxxxxxx",
"profile":"user",
"facility":"SPring-8",
"class_name":"xxxxxxx",
"email": "noreply@spring8.or.jp"
}Secured by oidc_credentials
Headers
- Authorization: required(string)
Example:
Bearer ced168b33f624fef9c0b1d824a591c41
/data
post
ディレクトリ検索
post /data/directories
ディレクトリ検索
Secured by oidc_credentials
authentification with OpenID Connect 1.0 (Resource Owner Password Credentials)
Body
Media type: application/x-www-form-urlencoded
Type: object
Properties- begindate: (string)
検索日時の始まり
Example:
2017-04-05 00:00:00 - enddate: (string)
検索日時の終わり
Example:
2017-07-25 00:00:00 - query: (string)
検索用クエリ
- size: (integer)
検索件数
- begin_from: (integer)
検索の始まりのID
- flag_own: (one of 0, 1 - default: 0)
自身の所属のデータのみ検索するかどうかのフラグ
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$id": "/data/directories.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
}
}Example:
{
"total_count":1,
"size":0,
"begin_from":0,
"register_name_list":[
"/SPring-8/BL14B2/data2/temp/Cu-K_Cu-foil_Si111_50ms_120613"
],
"directory_list":[
"/SPring-8/BL14B2/data2/temp",
"/SPring-8/BL14B2/data2/temp/Cu-K_Cu-foil_Si111_50ms_120613"
]
}
Secured by oidc_credentials
Headers
- Authorization: required(string)
Example:
Bearer ced168b33f624fef9c0b1d824a591c41
post
ファイル検索
post /data/files
ファイル検索
Secured by oidc_credentials
authentification with OpenID Connect 1.0 (Resource Owner Password Credentials)
Body
Media type: application/x-www-form-urlencoded
Type: object
Properties- register_name_list: (array)
登録名リスト
- file_list: (array)
ファイルまたはディレクトリリスト
- query: (string)
検索クエリ
- flag_recursive: required(one of 0, 1 - default: 0)
ディレクトリリスト指定時に下位ディレクトリを含めて検索するかどうかを示すフラグ
- flag_register_name: required(one of 0, 1 - default: 0)
出力に登録名も含むかどうかを示すフラグ
- size: required(integer)
検索件数
- begin_from: (integer)
検索の始まりのID
- flag_own: (one of 0, 1 - default: 0)
自身の所属のデータのみ検索するかどうかのフラグ
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$id": "/data/files.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
}
}Example:
{
"total_count":1,
"size":0,
"begin_from":0,
"file_list":[
{
"size":84,
"name":"/SPring-8/BL14B2/data2/temp/Cu-K_Cu-foil_Si111_50ms_120613.json",
"time":"2019-03-08 16:49:14",
"hash":"23da2952011c6b3c2ff2fe19e3b04b08",
"uuid_name":"ec2db1b7-d1c0-4494-b9b2-3eae3d0d851a",
"register_name":"/SPring-8/BL14B2/data2/temp/Cu-K_Cu-foil_Si111_50ms_120613"
},
{
"size":458,
"name":"/SPring-8/BL14B2/data2/temp/Cu-K_Cu-foil_Si111_50ms_120613.system.json",
"time":"2019-03-09 21:17:47",
"hash":"f5c1e6361041f0a776bc7fcc1d5559ad",
"uuid_name":"b2d2ceac-999f-4e0d-8de8-758a9771a7d6",
"register_name":"/SPring-8/BL14B2/data2/temp/Cu-K_Cu-foil_Si111_50ms_120613"
},
{
"size":250629,
"name":"/SPring-8/BL14B2/data2/temp/Cu-K_Cu-foil_Si111_50ms_120613/Cu-K_Cu-foil_Si111_50ms_120613.dat",
"time":"2013-01-26 08:54:37",
"hash":"6603fa8c31eea4f41bb54048a152c06b",
"uuid_name":"d3f88a8c-d1b1-417a-9ba5-5f12c4d9839c",
"register_name":"/SPring-8/BL14B2/data2/temp/Cu-K_Cu-foil_Si111_50ms_120613"
},
{
"size":15357,
"name":"/SPring-8/BL14B2/data2/temp/Cu-K_Cu-foil_Si111_50ms_120613/Cu-K_Cu-foil_Si111_50ms_120613.ex3",
"time":"2013-01-26 08:54:36",
"hash":"da87605ca96185f99bd577ee5fa5d8f7",
"uuid_name":"604fd7e7-78af-432c-bdc8-bae5eba40495",
"register_name":"/SPring-8/BL14B2/data2/temp/Cu-K_Cu-foil_Si111_50ms_120613"
},
{
"size":14977,
"name":"/SPring-8/BL14B2/data2/temp/Cu-K_Cu-foil_Si111_50ms_120613/Cu-K_Cu-foil_Si111_50ms_120613.txt",
"time":"2013-01-26 08:54:36",
"hash":"595f72c1168ba7271adf2855b79db00e",
"uuid_name":"9a9042b9-9789-4457-9af5-3e8748185808",
"register_name":"/SPring-8/BL14B2/data2/temp/Cu-K_Cu-foil_Si111_50ms_120613"
},
{
"size":535,
"name":"/SPring-8/BL14B2/data2/temp/Cu-K_Cu-foil_Si111_50ms_120613/README.csv",
"time":"2015-11-27 08:30:36",
"hash":"04fc584126773205d6b9d18e49cd90f0",
"uuid_name":"96358e20-da3b-4e1e-800e-c7f36d6a09c6",
"register_name":"/SPring-8/BL14B2/data2/temp/Cu-K_Cu-foil_Si111_50ms_120613"
}
]
}
Secured by oidc_credentials
Headers
- Authorization: required(string)
Example:
Bearer ced168b33f624fef9c0b1d824a591c41
post
レポジトリ上でregister_name検索
post /data/register_names
レポジトリ上でregister_name検索
Secured by oidc_credentials
authentification with OpenID Connect 1.0 (Resource Owner Password Credentials)
Body
Media type: application/x-www-form-urlencoded
Type: object
Properties- file_list: (array)
ファイルまたはディレクトリリスト
- query: (array)
ファイルまたはディレクトリリスト
- flag_recursive: required(one of 0, 1 - default: 0)
ディレクトリリスト指定時に下位ディレクトリを含めて検索するかどうかを示すフラグ
- size: (integer)
検索件数
- begin_from: (integer)
検索の始まりのID
- flag_own: (one of 0, 1 - default: 0)
自身の所属のデータのみ検索するかどうかのフラグ
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$id": "/data/register_names.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
}
}Example:
{
"total_count":1,
"size":0,
"begin_from":0,
"register_name_list":[
"/SPring-8/BL14B2/data2/temp/Cu-K_Cu-foil_Si111_50ms_120613"
]
}
Secured by oidc_credentials
Headers
- Authorization: required(string)
Example:
Bearer ced168b33f624fef9c0b1d824a591c41
post
レポジトリ上でメタデータ検索
post /data/metadata
レポジトリ上でメタデータ検索
Secured by oidc_credentials
authentification with OpenID Connect 1.0 (Resource Owner Password Credentials)
Body
Media type: application/x-www-form-urlencoded
Type: object
Properties- register_name: (string)
登録名
- file: (string)
ファイル名またはディレクトリ名
- pattern: (string)
メタデータ出力パターン
Secured by oidc_credentials
Headers
- Authorization: required(string)
Example:
Bearer ced168b33f624fef9c0b1d824a591c41
/metadata
post
メタデータのマッピング情報取得
post /metadata/mappings
メタデータのマッピング情報取得
Secured by oidc_credentials
authentification with OpenID Connect 1.0 (Resource Owner Password Credentials)
Body
Media type: application/x-www-form-urlencoded
Type: object
Properties- index_name: (string)
Elasticsearchのindex名
- facility_name: (string)
施設名
- division_name: (string)
Division名
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$id": "metadata/mappings.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
}
}Example:
{
"index_name":"spring8-bl14b2-2020.04.27",
"properties":{
"@data_info@access_rights":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"@data_info@additional_metadata":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
},
"@data_info@class_name":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"@data_info@contact_name@affiliation@organization":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"@data_info@contact_name@affiliation@sub_organization":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"@data_info@contact_name@identifier@ORCID":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"@data_info@contact_name@identifier@name":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"@data_info@contact_name@name":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"@data_info@contact_name@role":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"@data_info@data_depositor@affiliation@organization":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"@data_info@data_depositor@affiliation@sub_organization":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"@data_info@data_depositor@identifier@ORCID":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"@data_info@data_depositor@identifier@name":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"@data_info@data_depositor@name":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
},
"@data_info@data_origin":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"@data_info@date@create_time":{
"type":"date",
"format":"yyyy-MM-dd HH:mm:ss||yyyy/MM/dd HH:mm:ss||yyyy-MM-dd||yyyy/MM/dd||strict_date_optional_time||epoch_millis"
},
"@data_info@date@update_time":{
"type":"date",
"format":"yyyy-MM-dd HH:mm:ss||yyyy/MM/dd HH:mm:ss||yyyy-MM-dd||yyyy/MM/dd||strict_date_optional_time||epoch_millis"
},
"@data_info@disk_name":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"@data_info@facility":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"@data_info@identifier@doi":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"@data_info@identifier@others":{
"type":"nested",
"include_in_parent":true,
"properties":{
"project_id":{
"type":"keyword",
"copy_to":[
"sel"
]
}
}
},
"@data_info@identifier@pid":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"@data_info@identifier@previous":{
"type":"nested",
"include_in_parent":true,
"properties":{
"pid":{
"type":"keyword",
"copy_to":[
"sel"
]
}
}
},
"@data_info@identifier@proposal_number":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"@data_info@identifier@register_name":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"@data_info@identifier@related":{
"type":"nested",
"include_in_parent":true,
"properties":{
"pid":{
"type":"keyword",
"copy_to":[
"sel"
]
}
}
},
"@data_info@license@name":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"@data_info@title":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
},
"@data_info@title_ja":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
},
"@data_info@version@data_format":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"@dataset@directory_list":{
"type":"nested",
"include_in_parent":true,
"properties":{
"caption":{
"type":"text",
"analyzer":"kuromoji_analyzer"
},
"file_list":{
"type":"nested",
"include_in_parent":true,
"properties":{
"caption":{
"type":"text",
"analyzer":"kuromoji_analyzer"
},
"format":{
"type":"keyword"
},
"hash":{
"type":"keyword"
},
"name":{
"type":"keyword"
},
"size":{
"type":"long"
},
"time":{
"type":"date",
"format":"yyyy-MM-dd HH:mm:ss||yyyy/MM/dd HH:mm:ss||yyyy-MM-dd||yyyy/MM/dd||strict_date_optional_time||epoch_millis"
},
"uuid_name":{
"type":"keyword"
}
}
},
"name":{
"type":"keyword"
},
"time":{
"type":"date",
"format":"yyyy-MM-dd HH:mm:ss||yyyy/MM/dd HH:mm:ss||yyyy-MM-dd||yyyy/MM/dd||strict_date_optional_time||epoch_millis"
},
"uuid_name":{
"type":"keyword"
}
}
},
"@dataset@file_caption_list":{
"type":"text"
},
"@dataset@file_format_list":{
"type":"text"
},
"@facility@ring@end_current":{
"type":"double"
},
"@facility@ring@end_current_unit":{
"type":"keyword"
},
"@facility@ring@energy":{
"type":"double"
},
"@facility@ring@energy_unit":{
"type":"keyword"
},
"@facility@ring@filling_pattern":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"@facility@ring@filling_pattern_mode":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"@facility@ring@start_current":{
"type":"double"
},
"@facility@ring@start_current_unit":{
"type":"keyword"
},
"@instrument@analyzer@dwell_time":{
"type":"double"
},
"@instrument@analyzer@dwell_time_unit":{
"type":"keyword"
},
"@instrument@analyzer@pass_energy":{
"type":"double"
},
"@instrument@analyzer@pass_energy_unit":{
"type":"keyword"
},
"@instrument@counter":{
"type":"text"
},
"@instrument@counter@integral_time":{
"type":"double"
},
"@instrument@counter@integral_time_unit":{
"type":"keyword"
},
"@instrument@counter@model":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"@instrument@monochrometer@distance":{
"type":"double"
},
"@instrument@monochrometer@distance_unit":{
"type":"keyword"
},
"@instrument@monochrometer@net_plane":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
},
"@instrument@monochrometer@section":{
"type":"nested",
"include_in_parent":true,
"properties":{
"dwell_time":{
"type":"double"
},
"dwell_time_unit":{
"type":"keyword"
},
"end_energy":{
"type":"double"
},
"end_energy_unit":{
"type":"keyword"
},
"start_energy":{
"type":"double"
},
"start_energy_unit":{
"type":"keyword"
},
"step_energy":{
"type":"double"
},
"step_energy_unit":{
"type":"keyword"
}
}
},
"@instrument@slit":{
"type":"nested",
"include_in_parent":true,
"properties":{
"horizontal_size":{
"type":"double"
},
"horizontal_size_unit":{
"type":"keyword"
},
"name":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
},
"vertical_size":{
"type":"double"
},
"vertical_size_unit":{
"type":"keyword"
}
}
},
"@instrument@xafs@I0@element":{
"type":"nested",
"include_in_parent":true,
"properties":{
"HV":{
"type":"double"
},
"HV_unit":{
"type":"keyword"
},
"additional_metadata":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
},
"amp_gain":{
"type":"double"
},
"amp_gain_unit":{
"type":"keyword"
},
"gas":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
},
"type":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
}
}
},
"@instrument@xafs@I0@element_number":{
"type":"integer"
},
"@instrument@xafs@I1@element":{
"type":"nested",
"include_in_parent":true,
"properties":{
"HV":{
"type":"double"
},
"HV_unit":{
"type":"keyword"
},
"additional_metadata":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
},
"amp_gain":{
"type":"double"
},
"amp_gain_unit":{
"type":"keyword"
},
"gas":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
},
"type":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
}
}
},
"@instrument@xafs@I1@element_number":{
"type":"integer"
},
"@instrument@xafs@I2@element":{
"type":"nested",
"include_in_parent":true,
"properties":{
"HV":{
"type":"double"
},
"HV_unit":{
"type":"keyword"
},
"additional_metadata":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
},
"amp_gain":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
},
"amp_gain_unit":{
"type":"keyword"
},
"gas":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
},
"type":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
}
}
},
"@instrument@xafs@I2@element_number":{
"type":"integer"
},
"@measurement@atmosphare@sample@end_temperature_unit":{
"type":"keyword"
},
"@measurement@atmosphere@sample@end_temperature":{
"type":"double"
},
"@measurement@atmosphere@sample@gas":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
},
"@measurement@atmosphere@sample@start_temperature":{
"type":"double"
},
"@measurement@atmosphere@sample@start_temperature_unit":{
"type":"keyword"
},
"@measurement@date@end_time":{
"type":"date",
"format":"yyyy-MM-dd HH:mm:ss||yyyy/MM/dd HH:mm:ss||yyyy-MM-dd||yyyy/MM/dd||strict_date_optional_time||epoch_millis"
},
"@measurement@date@start_time":{
"type":"date",
"format":"yyyy-MM-dd HH:mm:ss||yyyy/MM/dd HH:mm:ss||yyyy-MM-dd||yyyy/MM/dd||strict_date_optional_time||epoch_millis"
},
"@measurement@holder_number":{
"type":"integer"
},
"@measurement@incident_photon@angle":{
"type":"double"
},
"@measurement@incident_photon@angle_unit":{
"type":"keyword"
},
"@measurement@incident_photon@energy":{
"type":"double"
},
"@measurement@incident_photon@energy_unit":{
"type":"keyword"
},
"@measurement@method@absorption_edge":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
},
"@measurement@method@category":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
},
"@measurement@method@detection":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
},
"@measurement@method@sub_category":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
},
"@measurement@number":{
"type":"integer"
},
"@measurement@photoelectron@energy_scale":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
},
"@measurement@photoelectron@spectral_line":{
"type":"nested",
"include_in_parent":true,
"properties":{
"element":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"name":{
"type":"keyword",
"copy_to":[
"sel"
]
}
}
},
"@measurement@photoelectron@take_off_angle":{
"type":"double"
},
"@measurement@photoelectron@take_off_angle_unit":{
"type":"keyword"
},
"@measurement@run_number":{
"type":"integer"
},
"@measurement@scan_mode":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
},
"@sample":{
"type":"nested",
"include_in_parent":true,
"properties":{
"additional_metadata":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
},
"chemical_formula":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
},
"element":{
"type":"nested",
"include_in_parent":true,
"properties":{
"name":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"suffix":{
"type":"keyword",
"copy_to":[
"sel"
]
}
}
},
"lot_number":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"model_number":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"name":{
"type":"text",
"copy_to":[
"sel"
],
"analyzer":"kuromoji_analyzer"
},
"supplier":{
"type":"keyword",
"copy_to":[
"sel"
]
},
"tag":{
"type":"keyword",
"copy_to":[
"sel"
]
}
}
},
"@system@parent_directory":{
"type":"keyword"
},
"@system@uuid_register_directory":{
"type":"keyword"
},
"@system@version@agent":{
"type":"keyword"
},
"@system@version@data_register":{
"type":"keyword"
},
"@system@version@metadata":{
"type":"keyword"
},
"sel":{
"type":"text",
"analyzer":"kuromoji_analyzer"
}
}
}Secured by oidc_credentials
Headers
- Authorization: required(string)
Example:
Bearer ced168b33f624fef9c0b1d824a591c41
post
メタデータのキーリスト取得
post /metadata/keys
メタデータのキーリスト取得
Secured by oidc_credentials
authentification with OpenID Connect 1.0 (Resource Owner Password Credentials)
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$id": "metadata/keys.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
}
}Example:
{
"index_name":"spring8-bl14b2-2020.04.27",
"list":[
"@data_info@access_rights",
"@data_info@additional_metadata",
"@data_info@class_name",
"@data_info@contact_name@affiliation@organization",
"@data_info@contact_name@affiliation@sub_organization",
"@data_info@contact_name@identifier@ORCID",
"@data_info@contact_name@identifier@name",
"@data_info@contact_name@name",
"@data_info@contact_name@role",
"@data_info@data_depositor@affiliation@organization",
"@data_info@data_depositor@affiliation@sub_organization",
"@data_info@data_depositor@identifier@ORCID",
"@data_info@data_depositor@identifier@name",
"@data_info@data_depositor@name",
"@data_info@data_origin",
"@data_info@date@create_time",
"@data_info@date@update_time",
"@data_info@disk_name",
"@data_info@facility",
"@data_info@identifier@doi",
"@data_info@identifier@others",
"@data_info@identifier@others.project_id",
"@data_info@identifier@pid",
"@data_info@identifier@previous",
"@data_info@identifier@previous.pid",
"@data_info@identifier@proposal_number",
"@data_info@identifier@register_name",
"@data_info@identifier@related",
"@data_info@identifier@related.pid",
"@data_info@license@name",
"@data_info@title",
"@data_info@title_ja",
"@data_info@version@data_format",
"@dataset@directory_list",
"@dataset@directory_list.caption",
"@dataset@directory_list.file_list",
"@dataset@directory_list.file_list.caption",
"@dataset@directory_list.file_list.format",
"@dataset@directory_list.file_list.hash",
"@dataset@directory_list.file_list.name",
"@dataset@directory_list.file_list.size",
"@dataset@directory_list.file_list.time",
"@dataset@directory_list.file_list.uuid_name",
"@dataset@directory_list.name",
"@dataset@directory_list.time",
"@dataset@directory_list.uuid_name",
"@dataset@file_caption_list",
"@dataset@file_format_list",
"@facility@ring@end_current",
"@facility@ring@end_current_unit",
"@facility@ring@energy",
"@facility@ring@energy_unit",
"@facility@ring@filling_pattern",
"@facility@ring@filling_pattern_mode",
"@facility@ring@start_current",
"@facility@ring@start_current_unit",
"@instrument@analyzer@dwell_time",
"@instrument@analyzer@dwell_time_unit",
"@instrument@analyzer@pass_energy",
"@instrument@analyzer@pass_energy_unit",
"@instrument@counter",
"@instrument@counter@integral_time",
"@instrument@counter@integral_time_unit",
"@instrument@counter@model",
"@instrument@monochrometer@distance",
"@instrument@monochrometer@distance_unit",
"@instrument@monochrometer@net_plane",
"@instrument@monochrometer@section",
"@instrument@monochrometer@section.dwell_time",
"@instrument@monochrometer@section.dwell_time_unit",
"@instrument@monochrometer@section.end_energy",
"@instrument@monochrometer@section.end_energy_unit",
"@instrument@monochrometer@section.start_energy",
"@instrument@monochrometer@section.start_energy_unit",
"@instrument@monochrometer@section.step_energy",
"@instrument@monochrometer@section.step_energy_unit",
"@instrument@slit",
"@instrument@slit.horizontal_size",
"@instrument@slit.horizontal_size_unit",
"@instrument@slit.name",
"@instrument@slit.vertical_size",
"@instrument@slit.vertical_size_unit",
"@instrument@xafs@I0@element",
"@instrument@xafs@I0@element.HV",
"@instrument@xafs@I0@element.HV_unit",
"@instrument@xafs@I0@element.additional_metadata",
"@instrument@xafs@I0@element.amp_gain",
"@instrument@xafs@I0@element.amp_gain_unit",
"@instrument@xafs@I0@element.gas",
"@instrument@xafs@I0@element.type",
"@instrument@xafs@I0@element_number",
"@instrument@xafs@I1@element",
"@instrument@xafs@I1@element.HV",
"@instrument@xafs@I1@element.HV_unit",
"@instrument@xafs@I1@element.additional_metadata",
"@instrument@xafs@I1@element.amp_gain",
"@instrument@xafs@I1@element.amp_gain_unit",
"@instrument@xafs@I1@element.gas",
"@instrument@xafs@I1@element.type",
"@instrument@xafs@I1@element_number",
"@instrument@xafs@I2@element",
"@instrument@xafs@I2@element.HV",
"@instrument@xafs@I2@element.HV_unit",
"@instrument@xafs@I2@element.additional_metadata",
"@instrument@xafs@I2@element.amp_gain",
"@instrument@xafs@I2@element.amp_gain_unit",
"@instrument@xafs@I2@element.gas",
"@instrument@xafs@I2@element.type",
"@instrument@xafs@I2@element_number",
"@measurement@atmosphare@sample@end_temperature_unit",
"@measurement@atmosphere@sample@end_temperature",
"@measurement@atmosphere@sample@gas",
"@measurement@atmosphere@sample@start_temperature",
"@measurement@atmosphere@sample@start_temperature_unit",
"@measurement@date@end_time",
"@measurement@date@start_time",
"@measurement@holder_number",
"@measurement@incident_photon@angle",
"@measurement@incident_photon@angle_unit",
"@measurement@incident_photon@energy",
"@measurement@incident_photon@energy_unit",
"@measurement@method@absorption_edge",
"@measurement@method@category",
"@measurement@method@detection",
"@measurement@method@sub_category",
"@measurement@number",
"@measurement@photoelectron@energy_scale",
"@measurement@photoelectron@spectral_line",
"@measurement@photoelectron@spectral_line.element",
"@measurement@photoelectron@spectral_line.name",
"@measurement@photoelectron@take_off_angle",
"@measurement@photoelectron@take_off_angle_unit",
"@measurement@run_number",
"@measurement@scan_mode",
"@sample",
"@sample.additional_metadata",
"@sample.chemical_formula",
"@sample.element",
"@sample.element.name",
"@sample.element.suffix",
"@sample.lot_number",
"@sample.model_number",
"@sample.name",
"@sample.supplier",
"@sample.tag",
"@system@parent_directory",
"@system@uuid_register_directory",
"@system@version@agent",
"@system@version@data_register",
"@system@version@metadata"
]
}Secured by oidc_credentials
Headers
- Authorization: required(string)
Example:
Bearer ced168b33f624fef9c0b1d824a591c41
/proposal
post
課題情報取得
post /proposal
課題情報取得
Secured by oidc_credentials
authentification with OpenID Connect 1.0 (Resource Owner Password Credentials)
Body
Media type: application/x-www-form-urlencoded
Type: object
Properties- begindate: (string)
検索日時の始まり
- enddate: (string)
検索日時の終わり
- facility: (string)
施設名
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$id": "proposal.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
}
}Example:
{
"list":[
"2014S0000"
]
}Secured by oidc_credentials
Headers
- Authorization: required(string)
Example:
Bearer ced168b33f624fef9c0b1d824a591c41
post
課題情報に関連したメタデータ情報取得
post /proposal/metadata
課題情報に関連したメタデータ情報取得
Secured by oidc_credentials
authentification with OpenID Connect 1.0 (Resource Owner Password Credentials)
Body
Media type: application/x-www-form-urlencoded
Type: object
Properties- facility: (string)
施設名
- proposal_number: (string)
課題情報番号
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$id": "proposal/metadata.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
}
}Example:
{
"found":true,
"metadata":{
"@data_info@facility":"SPring-8",
"@data_info@class_name":"BL14B2",
"@data_info@title_ja":"標準試料",
"@data_info@title":"Standard Sample",
"@data_info@identifier@proposal_number":"2014S0000",
"@data_info@contact_name@name":"Hironori Ofuchi",
"@data_info@contact_name@affiliation@organization":"（公財）高輝度光科学研究センター",
"@data_info@contact_name@role":"person",
"@data_info@contact_name@identifier@name":"0007719"
}
}Secured by oidc_credentials
Headers
- Authorization: required(string)
Example:
Bearer ced168b33f624fef9c0b1d824a591c41
/download
post
ZIP形式でのファイルダウンロード指令実行(非同期処理)
post /download
ZIP形式でのファイルダウンロード指令実行(非同期処理)
Secured by oidc_credentials
authentification with OpenID Connect 1.0 (Resource Owner Password Credentials)
Body
Media type: application/x-www-form-urlencoded
Type: object
Properties- register_name_list: (array)
登録名リスト
- flag_recursive: required(one of 0, 1 - default: 0)
ディレクトリリスト指定時に下位ディレクトリを含めてダウンロードするかどうかを示すフラグ
- flag_own: (one of 0, 1 - default: 0)
自身の所属のデータのみダウンロードするかどうかのフラグ
- mode: (string)
ZIP圧縮のモード
- file_list: (array)
ディレクトリ及びファイルリスト指定
- timeout: (integer)
タイムアウト値 (秒単位)
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$id": "download.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
}
}Example:
{
"status":"PENDING",
"uuid":"4f1e659b-8b84-469d-a1c5-5a5105fa5ebe"
}Secured by oidc_credentials
Headers
- Authorization: required(string)
Example:
Bearer ced168b33f624fef9c0b1d824a591c41
get
ZIPダウンロード処理状況確認
get /download/queue/{uuid}
ZIPダウンロード処理状況確認
URI Parameters
- uuid: required(string)
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$id": "download/queue.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
}
}Example:
{
"file_list":[
{
"size":44,
"name":"/SPring-8/BL14B2/test/test.json",
"time":"2018-08-15 18:14:05",
"hash":"4cdb2c555c08a9d787a2e61103dff0f8",
"uuid_name":"1464fd07-2a10-46ad-b341-6e31faa16b97"
},
{
"size":425,
"name":"/SPring-8/BL14B2/test/test.system.json",
"time":"2019-03-09 21:18:35",
"hash":"49b71db137ce7da3b8ce26f62f643722",
"uuid_name":"6ce8869e-6eca-4fd6-9f42-371a1055ee6c"
}
],
"status":"SUCCESS",
"uuid":"c36a27d2-c855-47d6-940e-56a7011129ee"
}
get
ZIPファイルダウンロード実行
get /download/file/{uuid}
ZIPファイルダウンロード実行
Secured by oidc_credentials
authentification with OpenID Connect 1.0 (Resource Owner Password Credentials)
URI Parameters
- uuid: required(string)
Secured by oidc_credentials
Headers
- Authorization: required(string)
Example:
Bearer ced168b33f624fef9c0b1d824a591c41
post
ファイルダウンロード実行
post /download/file
ファイルダウンロード実行
Secured by oidc_credentials
authentification with OpenID Connect 1.0 (Resource Owner Password Credentials)
Body
Media type: application/x-www-form-urlencoded
Type: object
Properties- file: required(string)
ファイル名
Secured by oidc_credentials
Headers
- Authorization: required(string)
Example:
Bearer ced168b33f624fef9c0b1d824a591c41
/register
post
メタデータ登録およびアップロードされたファイルのストレージへの登録
post /register/metadata
メタデータ登録およびアップロードされたファイルのストレージへの登録
Secured by oidc_credentials
authentification with OpenID Connect 1.0 (Resource Owner Password Credentials)
Body
Media type: application/x-www-form-urlencoded
Type: object
Properties- mode: (one of replace, update, create - default: replace)
登録モードの指定
- metadata_encode: required(string)
メタデータ (utf8 encoded)
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$id": "register/metadata.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
}
}Example:
{
"result_register":"created",
"result_file":"2 files are registered",
"mode":"replace",
"register_name":"/SPring-8/BL14B2/test/test"
}
Secured by oidc_credentials
Headers
- Authorization: required(string)
Example:
Bearer ced168b33f624fef9c0b1d824a591c41
post
ファイルアップロード実行
post /register/files
ファイルアップロード実行
Secured by oidc_credentials
authentification with OpenID Connect 1.0 (Resource Owner Password Credentials)
Body
Media type: application/x-www-form-urlencoded
Type: object
Properties- register_name: required(string)
登録名
- files_encode: required(string)
登録ファイル情報 (utf8 encoded)
Media type: multipart/form-data
Type: object
Properties- file: required(file)
The file to be uploaded
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$id": "register/files.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
}
}Example:
{
"file_list":[
{
"hash":"4cdb2c555c08a9d787a2e61103dff0f8",
"size":44,
"time":"2018-08-15 18:14:05",
"uuid_name":"faa56f96-8f1a-4bed-8bce-d0498b13c250",
"name":"/SPring-8/BL14B2/test/test.json"
},
{
"hash":"49b71db137ce7da3b8ce26f62f643722",
"size":425,
"time":"2019-03-09 21:18:35",
"uuid_name":"2ee3a7ca-b17a-4189-9941-c674ff6ef8cf",
"name":"/SPring-8/BL14B2/test/test.system.json"
}
],
}
Secured by oidc_credentials
Headers
- Authorization: required(string)
Example:
Bearer ced168b33f624fef9c0b1d824a591c41
post
ファイルアップロード処理リセット
post /register/reset
ファイルアップロード処理リセット
Secured by oidc_credentials
authentification with OpenID Connect 1.0 (Resource Owner Password Credentials)
Body
Media type: application/x-www-form-urlencoded
Type: object
Properties- register_name: required(string)
登録名
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$id": "register/reset.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
}
}Example:
{
"result":"reset",
"register_name":"/SPring-8/BL14B2/test/test"
}
Secured by oidc_credentials
Headers
- Authorization: required(string)
Example:
Bearer ced168b33f624fef9c0b1d824a591c41
/delete
post
データ削除
post /delete
データ削除
Secured by oidc_credentials
authentification with OpenID Connect 1.0 (Resource Owner Password Credentials)
Body
Media type: application/x-www-form-urlencoded
Type: object
Properties- register_name_list: (string)
登録名リスト
- file_list: (array)
ファイルまたはディレクトリリスト
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$id": "delete.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
}
}Example:
{
"register_name_list":[
"/SPring-8/BL14B2/test/test"
],
"file_list":[
{
"size":44,
"name":"/SPring-8/BL14B2/test/test.json",
"time":"2018-08-15 18:14:05",
"hash":"4cdb2c555c08a9d787a2e61103dff0f8",
"uuid_name":"bab29ba8-f5d2-45be-8e43-d7d9d750eae3"
},
{
"size":425,
"name":"/SPring-8/BL14B2/test/test.system.json",
"time":"2019-03-09 21:18:35",
"hash":"49b71db137ce7da3b8ce26f62f643722",
"uuid_name":"c393cc5d-2b03-4b1a-b6d3-8616ef28e687"
}
]
}
Secured by oidc_credentials
Headers
- Authorization: required(string)
Example:
Bearer ced168b33f624fef9c0b1d824a591c41