Obj Read

POST /obj/read

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
}
'

import requests

url = "https://api.example.com/obj/read"

payload = {
    "project_id": "<string>",
    "object_id": "<string>",
    "digest": "<string>",
    "metadata_only": False,
    "include_tags_and_aliases": False
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    project_id: '<string>',
    object_id: '<string>',
    digest: '<string>',
    metadata_only: false,
    include_tags_and_aliases: false
  })
};

fetch('https://api.example.com/obj/read', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/obj/read",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'project_id' => '<string>',
    'object_id' => '<string>',
    'digest' => '<string>',
    'metadata_only' => false,
    'include_tags_and_aliases' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/obj/read"

	payload := strings.NewReader("{\n  \"project_id\": \"<string>\",\n  \"object_id\": \"<string>\",\n  \"digest\": \"<string>\",\n  \"metadata_only\": false,\n  \"include_tags_and_aliases\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/obj/read")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"project_id\": \"<string>\",\n  \"object_id\": \"<string>\",\n  \"digest\": \"<string>\",\n  \"metadata_only\": false,\n  \"include_tags_and_aliases\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/obj/read")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"project_id\": \"<string>\",\n  \"object_id\": \"<string>\",\n  \"digest\": \"<string>\",\n  \"metadata_only\": false,\n  \"include_tags_and_aliases\": false\n}"

response = http.request(request)
puts response.read_body

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>"
    ]
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Body

application/json

project_id · string · required

object_id · string · required

digest · string · required

metadata_only · boolean | null · default: false

If true, the val column is not read from the database and is empty.All other fields are returned.

include_tags_and_aliases · boolean | null · default: false

If true, tags and aliases are fetched and included in the response.

Response

200

application/json

Successful Response

obj · ObjSchema · object · required

Show child attributes