項目名情報取得

POST

/api_v1_system_itemname/info

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_itemname/info"

// POST /api_v1_system_itemname/info - 項目名情報取得
const params = new URLSearchParams({
  access_token: '<access_token>',
})
const res = await fetch('https://api.next-engine.org/api_v1_system_itemname/info', {
  method: 'POST',
  headers: { 'content-type': 'application/x-www-form-urlencoded' },
  body: params,
})
const json = await res.json()
if (json.result !== 'success') throw new Error(json.message ?? json.code)
console.log(json.data)

# POST /api_v1_system_itemname/info - 項目名情報取得
import requests

params = {
    'access_token': '<access_token>',
}
res = requests.post(
    'https://api.next-engine.org/api_v1_system_itemname/info',
    data=params,
)
json = res.json()
if json['result'] != 'success':
    raise RuntimeError(json.get('message') or json.get('code'))
print(json.get('data'))

Request Body^required

application/x-www-form-urlencoded

ネクストエンジン API 共通リクエストパラメータ

object

access_token

required

OAuth2 アクセストークン (必須)

string

refresh_token

OAuth2 リフレッシュトークン (access_token 期限切れ時の自動更新に使用)

string

wait_flag

同期実行フラグ。“1” 指定で処理完了を待つ

string

Allowed values: 0 1

fields

取得するフィールドをカンマ区切りで指定 (search 系のみ)

string

offset

検索開始位置 (search 系のみ)

integer

limit

取得件数 (search 系のみ)

integer

>= 1

Responses

200

実行結果 (result が success / error / redirect のいずれか)

application/json

object

result

required

実行結果ステータス

string

Allowed values: success error redirect

code

エラー時のエラーコード

string

message

One of:

string
Array<object>

string

access_token

更新後のアクセストークン

string

access_token_end_date

アクセストークン有効期限 (YYYY-MM-DD HH:MM:SS)

string

refresh_token

更新後のリフレッシュトークン

string

refresh_token_end_date

リフレッシュトークン有効期限

string

data

エンドポイント固有のレスポンスデータ

count

Count/search 系のヒット件数 (form-urlencoded レスポンスでは文字列で返ることがある)

integer | string

data

Array<object>

object

item_id

項目ID / 文字列型

string | integer | number | boolean | null

item_name

項目名 / 文字列型

string | integer | number | boolean | null

key

additional properties

any

Example

{
  "result": "success",
  "count": "30",
  "data": [
    {
      "item_id": "org1",
      "item_name": "項目１"
    },
    {
      "item_id": "org10",
      "item_name": "項目１０"
    },
    {
      "item_id": "org11",
      "item_name": "項目１１"
    },
    {
      "item_id": "org12",
      "item_name": "項目１２"
    },
    {
      "item_id": "org13",
      "item_name": "項目１３"
    },
    {
      "item_id": "org14",
      "item_name": "項目１４"
    },
    {
      "item_id": "org15",
      "item_name": "項目１５"
    },
    {
      "item_id": "org16",
      "item_name": "項目１６"
    },
    {
      "item_id": "org17",
      "item_name": "項目１７"
    },
    {
      "item_id": "org18",
      "item_name": "項目１８"
    },
    {
      "item_id": "org19",
      "item_name": "項目１９"
    },
    {
      "item_id": "org2",
      "item_name": "項目２"
    },
    {
      "item_id": "org20",
      "item_name": "項目２０"
    },
    {
      "item_id": "org3",
      "item_name": "項目３"
    },
    {
      "item_id": "org4",
      "item_name": "項目４"
    },
    {
      "item_id": "org5",
      "item_name": "項目５"
    },
    {
      "item_id": "org6",
      "item_name": "項目６"
    },
    {
      "item_id": "org7",
      "item_name": "項目７"
    },
    {
      "item_id": "org8",
      "item_name": "項目８"
    },
    {
      "item_id": "org9",
      "item_name": "項目９"
    },
    {
      "item_id": "org_select1",
      "item_name": "選択肢１"
    },
    {
      "item_id": "org_select10",
      "item_name": "選択肢１０"
    },
    {
      "item_id": "org_select2",
      "item_name": "選択肢２"
    },
    {
      "item_id": "org_select3",
      "item_name": "選択肢３"
    },
    {
      "item_id": "org_select4",
      "item_name": "選択肢４"
    },
    {
      "item_id": "org_select5",
      "item_name": "選択肢５"
    },
    {
      "item_id": "org_select6",
      "item_name": "選択肢６"
    },
    {
      "item_id": "org_select7",
      "item_name": "選択肢７"
    },
    {
      "item_id": "org_select8",
      "item_name": "選択肢８"
    },
    {
      "item_id": "org_select9",
      "item_name": "選択肢９"
    }
  ],
  "access_token": "xxxxxxxxxxx",
  "access_token_end_date": "2017-04-13 18:24:53",
  "refresh_token": "xxxxxxxxxxx",
  "refresh_token_end_date": "2017-04-15 18:24:53"
}

4XX

クライアントエラー (HTTP ステータス自体は 200 + result=error で返ることが多い)

application/json

object

result

required

実行結果ステータス

string

Allowed values: success error redirect

code

エラー時のエラーコード

string

message

One of:

string
Array<object>

string

access_token

更新後のアクセストークン

string

access_token_end_date

アクセストークン有効期限 (YYYY-MM-DD HH:MM:SS)

string

refresh_token

更新後のリフレッシュトークン

string

refresh_token_end_date

リフレッシュトークン有効期限

string

data

エンドポイント固有のレスポンスデータ

count

Count/search 系のヒット件数 (form-urlencoded レスポンスでは文字列で返ることがある)

integer | string

Example

{
  "result": "success"
}

項目名情報取得

Request Body required

Responses

200

Example

4XX

Example

Request Body^required