Skip to content

Latest commit

 

History

History
182 lines (146 loc) · 3.53 KB

items.md

File metadata and controls

182 lines (146 loc) · 3.53 KB

ブックマーク API

get /items/list

対象ユーザーのブックマークを取得

request

内容 値 説明
Authorization Bearer ヘッダに設定
latest yyyy-MM-dd HH:mm:ss 対象日時以降を取得（設定されていない場合は全件取得） 
http://127.0.0.1:8080/items/list?latest=2020-09-11 13:44:22

response

items 配下にリスト形式

内容 値 説明
remote_id 1 サーバー側の一意の ID
remote_parent_id 1 サーバー側の親としている item ID
name example 名称
url https://example.com URL（フォルダの場合は NULL）
orders 1 編集権限
owner_type 0 オーナータイプ
updated yyyy-MM-dd HH:mm:ss 更新日時
deleted false 削除フラグ 
{
    "items": [
        {
            "remote_id": 9,
            "remote_parent_id": 2,
            "name": "example 1",
            "url": "https://example.com",
            "orders": 2,
            "owner_type": 1,
            "updated": "2020-11-07 15:48:17",
            "deleted": false
        },
        {
            "remote_id": 129,
            "remote_parent_id": 8,
            "name": "example 2",
            "url": "https://example.com",
            "orders": 37,
            "owner_type": 1,
            "updated": "2020-11-07 15:50:59",
            "deleted": true
        }
    ]
}

post /items/save

ブックマークを登録してサーバー側の一意の ID を返す

request

内容 値 説明
local_id 1 端末での一意の ID
remote_id 1 サーバー側の一意の ID（サーバー側で保持していなければ null）
name example 名称
url https://example.com URL（フォルダの場合は NULL）
orders 1 編集権限
updated yyyy-MM-dd HH:mm:ss 更新日時 
http://127.0.0.1:8080/items/save -d '[
{
        "local_id": 1,
        "remote_id": null,
        "name": "example",
        "url": "https://example.com",
        "orders": 1,
        "updated": "2020-09-16 12:44:22"
    },
    {
        "local_id": 2,
        "remote_id": 4,
        "name": "example folder",
        "url": null,
        "orders": 2,
        "updated": "2020-09-16 13:44:22"
    }
]'

response

items 配下にリスト形式

内容 値 説明
local_id 1 端末での一意の ID（POST した ID）
remote_id 1 サーバー側の一意の ID 
{
    "items": [
        {
            "local_id": 1,
            "remote_id": 3
        },
        {
            "local_id": 2,
            "remote_id": 4
        }
    ]
}

put /items/parents

ブックマークの親情報を更新する

request

内容 値 説明
remote_id 1 対象ブックマーク ID
parent_id 1 親ブックマークの ID
is_share_folder true 共有されているフォルダであれば true 
http://127.0.0.1:8080/items/parents -d '[
    {"remote_id": 1, "parent_id", 2, false},
    {"remote_id": 3, "parent_id", 0, true}
]'

response

更新した件数を返す

内容 値 説明
result_count 4 更新した件数 
{
  "result_count" : 4
}

delete /items/delete

ブックマークを削除する

request

内容 値 説明
delete_id 1 サーバー側の一意の ID 
http://127.0.0.1:8080/items/delete -d '[
    {"delete_id": 1},
    {"delete_id": 2}
]'

response

削除した件数を返す

内容 値 説明
delete_count 4 削除した件数 
{
  "delete_count" : 4
}