オブジェクトの読み取り

POST /obj/read

オブジェクトの読み取り

cURL

curl --request POST \
  --url https://api.example.com/obj/read \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "object_id": "<string>",
  "digest": "<string>",
  "metadata_only": false,
  "include_tags_and_aliases": false
}
'

200

{
  "obj": {
    "project_id": "<string>",
    "object_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "digest": "<string>",
    "version_index": 123,
    "is_latest": 123,
    "kind": "<string>",
    "base_object_class": "<string>",
    "val": "<unknown>",
    "deleted_at": "2023-11-07T05:31:56Z",
    "leaf_object_class": "<string>",
    "wb_user_id": "<string>",
    "size_bytes": 123,
    "tags": [
      "<string>"
    ],
    "aliases": [
      "<string>"
    ]
  }
}

承認

Authorization · string · header · 必須

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

ボディ

application/json

project_id · string · 必須

object_id · string · 必須

digest · string · 必須

metadata_only · boolean | null · デフォルト: false

true の場合、val 列はデータベースから読み取られず、空になります。その他のフィールドはすべて返されます。

include_tags_and_aliases · boolean | null · デフォルト: false

true の場合、タグとエイリアスを取得してレスポンスに含めます。

レスポンス

200

application/json

成功レスポンス

obj · ObjSchema · object · 必須

Show child attributes