APIエンドポイントやアクセストークンによる認証についてはファインアセットWebAPI概要をご確認ください。
目的
API連携キーよりアクセストークンを発行します。
パラメータ
Request body(Content-Type: application/json)
| フィールド | 必須 | 説明 |
|---|---|---|
| grant-type | 〇 | アクセストークン発行の手続き方法を指定します("client_credentials" を指定してください) |
| contract-id | 〇 | 契約IDを指定します |
| api-key | 〇 | Web画面にて発行したAPI連携キーを指定します |
レスポンス
| コード | 説明 |
|---|---|
| 200 |
|
目的
指定した資産管理番号の資産情報を取得します。
パラメータ
パスパラメータ(URLを書き換え)
| フィールド | 必須 | 説明 |
|---|---|---|
| assetNumber | 〇 | 資産管理番号を指定します |
レスポンス
| コード | 説明 |
|---|---|
| 200 |
本APIのレスポンスに含まれる value は、資産項目の形式(asset_item_format)によって返却形式が異なります。
・TEXT、TEXTAREA、DATE、NUMBER、MONEY の場合は文字列を返却します ・LIST の場合は、コードおよび名称を含むオブジェクトを返却します ・項目「使用者」の場合は、ログインIDおよび利用者名を含むオブジェクトを返却します ・FILE の場合は、ファイル情報を含むオブジェクトを返却します FILE形式の項目「画像」については、レスポンス内のfile にBase64エンコードした文字列を返却します。 画像以外のFILE形式の項目については、file に null を返却します。 ※ファイルデータを取得する場合は、「添付ファイル取得API」をご利用ください
|
エラーレスポンス
| コード | type | 説明 |
|---|---|---|
| 422 | unprocessable_entity |
・指定した資産管理番号の資産が未登録 |
目的
資産情報を新規登録します。
操作元は"WebAPI"として記録されます。
パラメータ
Request body(Content-Type: application/json)
| フィールド | 必須 | 説明 |
|---|---|---|
| item_values | 〇 |
資産項目および値を指定します List<T> 配列
|
| exec_user_login_id | 〇 | 資産登録を実施する利用者のログインIDを指定します |
| memo | 資産の登録理由を指定します |
レスポンス
| コード | 説明 |
|---|---|
| 200 |
本APIのレスポンスに含まれる value は、資産項目の形式(asset_item_format)によって返却形式が異なります。
・TEXT、TEXTAREA、DATE、NUMBER、MONEY の場合は文字列を返却します ・LIST の場合は、コードおよび名称を含むオブジェクトを返却します ・項目「使用者」の場合は、ログインIDおよび利用者名を含むオブジェクトを返却します ・FILE の場合は、ファイル情報を含むオブジェクトを返却します FILE形式の項目「画像」については、レスポンス内のfile にBase64エンコードした文字列を返却します。 画像以外のFILE形式の項目については、file に null を返却します。 ※ファイルデータを取得する場合は、「添付ファイル取得API」をご利用ください
|
エラーレスポンス
| コード | type | 説明 |
|---|---|---|
| 422 | unprocessable_entity |
・登録実施者として指定したログインIDの利用者が在籍していない、または未登録 ・資産登録の件数上限を超過 ・指定した項目値にてバリデーションエラー(validationにエラー原因を返します) ・資産管理番号の自動採番エラー(採番ルール未設定 / 採番ルールが未割当 / 連番桁数の上限超過) ・資産情報のインポート処理が実行中 |
目的
指定した資産管理番号の資産情報を更新します。
操作元は"WebAPI"として記録されます。
パラメータ
パスパラメータ(URLを書き換え)
| フィールド | 必須 | 説明 |
|---|---|---|
| assetNumber | 〇 | 資産管理番号を指定します |
Request body(Content-Type: application/json)
| フィールド | 必須 | 説明 |
|---|---|---|
| item_values | 〇 |
更新する資産項目および値を指定します List<T> 配列
|
| exec_user_login_id | 〇 | 資産更新を実施する利用者のログインIDを指定します |
| memo | 資産の更新理由を指定します |
レスポンス
| コード | 説明 |
|---|---|
| 200 |
本APIのレスポンスに含まれる value は、資産項目の形式(asset_item_format)によって返却形式が異なります。
・TEXT、TEXTAREA、DATE、NUMBER、MONEY の場合は文字列を返却します ・LIST の場合は、コードおよび名称を含むオブジェクトを返却します ・項目「使用者」の場合は、ログインIDおよび利用者名を含むオブジェクトを返却します ・FILE の場合は、ファイル情報を含むオブジェクトを返却します FILE形式の項目「画像」については、レスポンス内のfile にBase64エンコードした文字列を返却します。 画像以外のFILE形式の項目については、file に null を返却します。 ※ファイルデータを取得する場合は、「添付ファイル取得API」をご利用ください
|
エラーレスポンス
| コード | type | 説明 |
|---|---|---|
| 422 | unprocessable_entity |
・指定した資産管理番号の資産が未登録 ・指定した資産管理番号の資産が廃棄済み ・更新実施者として指定したログインIDの利用者が在籍していない、または未登録 ・資産情報の更新がない ・指定した項目値にてバリデーションエラー(validationにエラー原因を返します) ・資産情報のインポート処理が実行中 |
目的
指定した資産管理番号の資産情報を廃棄します。
操作元は"WebAPI"として記録されます。
パラメータ
パスパラメータ(URLを書き換え)
| フィールド | 必須 | 説明 |
|---|---|---|
| assetNumber | 〇 | 資産管理番号を指定します |
Request body(Content-Type: application/json)
| フィールド | 必須 | 説明 |
|---|---|---|
| exec_user_login_id | 〇 | 資産廃棄を実施する利用者のログインIDを指定します |
| memo | 資産の廃棄理由を指定します |
レスポンス
| コード | 説明 |
|---|---|
| 200 |
本APIのレスポンスに含まれる value は、資産項目の形式(asset_item_format)によって返却形式が異なります。
・TEXT、TEXTAREA、DATE、NUMBER、MONEY の場合は文字列を返却します ・LIST の場合は、コードおよび名称を含むオブジェクトを返却します ・項目「使用者」の場合は、ログインIDおよび利用者名を含むオブジェクトを返却します ・FILE の場合は、ファイル情報を含むオブジェクトを返却します FILE形式の項目「画像」については、レスポンス内のfile にBase64エンコードした文字列を返却します。 画像以外のFILE形式の項目については、file に null を返却します。 ※ファイルデータを取得する場合は、「添付ファイル取得API」をご利用ください
|
エラーレスポンス
| コード | type | 説明 |
|---|---|---|
| 422 | unprocessable_entity |
・指定した資産管理番号の資産が未登録 ・指定した資産管理番号の資産が廃棄済み ・指定した資産管理番号の資産が子資産 ・廃棄実施者として指定したログインIDの利用者が在籍していない、または未登録 ・資産情報のインポート処理が実行中 |
目的
指定した資産管理番号の資産情報の廃棄を取消しします。
操作元は"WebAPI"として記録されます。
パラメータ
パスパラメータ(URLを書き換え)
| フィールド | 必須 | 説明 |
|---|---|---|
| assetNumber | 〇 | 資産管理番号を指定します |
Request body(Content-Type: application/json)
| フィールド | 必須 | 説明 |
|---|---|---|
| exec_user_login_id | 〇 | 資産の廃棄取消しを実施する利用者のログインIDを指定します |
| memo | 資産の廃棄取消し理由を指定します |
レスポンス
| コード | 説明 |
|---|---|
| 200 |
本APIのレスポンスに含まれる value は、資産項目の形式(asset_item_format)によって返却形式が異なります。
・TEXT、TEXTAREA、DATE、NUMBER、MONEY の場合は文字列を返却します ・LIST の場合は、コードおよび名称を含むオブジェクトを返却します ・項目「使用者」の場合は、ログインIDおよび利用者名を含むオブジェクトを返却します ・FILE の場合は、ファイル情報を含むオブジェクトを返却します FILE形式の項目「画像」については、レスポンス内のfile にBase64エンコードした文字列を返却します。 画像以外のFILE形式の項目については、file に null を返却します。 ※ファイルデータを取得する場合は、「添付ファイル取得API」をご利用ください
|
エラーレスポンス
| コード | type | 説明 |
|---|---|---|
| 422 | unprocessable_entity |
・指定した資産管理番号の資産が未登録 ・指定した資産管理番号の資産が有効 ・指定した資産管理番号の資産が子資産 ・廃棄取消し実施者として指定したログインIDの利用者が在籍していない、または未登録 ・資産登録の件数上限を超過 ・資産情報のインポート処理が実行中 |
目的
指定した資産管理番号、資産項目コードの添付ファイルを取得します。
パラメータ
パスパラメータ(URLを書き換え)
| フィールド | 必須 | 説明 |
|---|---|---|
| assetNumber | 〇 | 資産管理番号を指定します |
| assetItemCode | 〇 | 資産項目コードを指定します |
レスポンス
| コード | 説明 |
|---|---|
| 200 |
|
エラーレスポンス
| コード | type | 説明 |
|---|---|---|
| 422 | unprocessable_entity |
・指定した資産管理番号の資産が未登録 ・指定した資産項目コードの資産項目が未登録 ・添付ファイルが未登録 |
目的
指定した資産管理番号の資産情報を棚卸します。
操作元は"WebAPI"として記録されます。
パラメータ
パスパラメータ(URLを書き換え)
| フィールド | 必須 | 説明 |
|---|---|---|
| assetNumber | 〇 | 資産管理番号を指定します |
Request body(Content-Type: application/json)
| フィールド | 必須 | 説明 |
|---|---|---|
| exec_user_login_id | 〇 | 棚卸を実施する利用者のログインIDを指定します |
| memo | 棚卸メモを指定します |
レスポンス
| コード | 説明 |
|---|---|
| 200 |
|
エラーレスポンス
| コード | type | 説明 |
|---|---|---|
| 422 | unprocessable_entity |
・指定した資産管理番号の資産が未登録 ・棚卸実施者として指定したログインIDの利用者が在籍していない、または未登録 |
目的
指定した資産管理番号の最新の棚卸履歴を取得します。
パラメータ
パスパラメータ(URLを書き換え)
| フィールド | 必須 | 説明 |
|---|---|---|
| assetNumber | 〇 | 資産管理番号を指定します |
レスポンス
| コード | 説明 |
|---|---|
| 200 |
|
エラーレスポンス
| コード | type | 説明 |
|---|---|---|
| 422 | unprocessable_entity |
・指定した資産管理番号の資産が未登録 |
目的
資産項目設定を取得します。
パラメータ
クエリパラメータ(URLに付与)
| フィールド | 必須 | 説明 |
|---|---|---|
| page | ページ数を指定します ※未指定の場合は1 |
|
| limit | 表示件数を1~100以内で指定します ※未指定の場合は10 |
レスポンス
| コード | 説明 |
|---|---|
| 200 |
本APIのレスポンスは登録されている全ての資産項目が返却されます。
レスポンス内の資産項目設定はWeb画面で設定された表示順で返却されます。 本APIのレスポンスに含まれる validatesオブジェクト は、資産項目の形式(asset_item_format)によって返却される項目が異なります。
|
エラーレスポンス
| コード | type | 説明 |
|---|---|---|
| 422 | unprocessable_entity |
・表示件数が1~100の範囲外 |
目的
区分設定および区分を取得します。
パラメータ
クエリパラメータ(URLに付与)
| フィールド | 必須 | 説明 |
|---|---|---|
| page | ページ数を指定します ※未指定の場合は1 |
|
| limit | 表示件数を1~100以内で指定します ※未指定の場合は10 |
レスポンス
| コード | 説明 |
|---|---|
| 200 |
レスポンス内の区分設定および区分はWeb画面で設定された表示順で返却されます。
|
エラーレスポンス
| コード | type | 説明 |
|---|---|---|
| 422 | unprocessable_entity |
・表示件数が1~100の範囲外 |
目的
部署区分設定を取得します。
パラメータ
クエリパラメータ(URLに付与)
| フィールド | 必須 | 説明 |
|---|---|---|
| page | ページ数を指定します ※未指定の場合は1 |
|
| limit | 表示件数を1~100以内で指定します ※未指定の場合は10 |
レスポンス
| コード | 説明 |
|---|---|
| 200 |
レスポンス内の部署区分設定はWeb画面で設定された表示順で返却されます。
|
エラーレスポンス
| コード | type | 説明 |
|---|---|---|
| 422 | unprocessable_entity |
・表示件数が1~100の範囲外 |