Retrieve a component object's note

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/components/cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d/objects/a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e/notes/e7f9a1b3c5d74e9f8a2b4c6d8e0f1a3b" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = client.custom_components.get_component_object_note(
    "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d",
    "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
    "e7f9a1b3c5d74e9f8a2b4c6d8e0f1a3b",
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.customComponents.getComponentObjectNote(
    'cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d',
    'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
    'e7f9a1b3c5d74e9f8a2b4c6d8e0f1a3b',
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->customComponents->getComponentObjectNote(
    'cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d',
    'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
    'e7f9a1b3c5d74e9f8a2b4c6d8e0f1a3b',
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.custom_components.custom_components_dto.CustomComponentsDto.ComponentObjectNote;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<ComponentObjectNote> response = client.customComponents().getComponentObjectNote(
        "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d",
        "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
        "e7f9a1b3c5d74e9f8a2b4c6d8e0f1a3b");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CustomComponents.GetComponentObjectNoteAsync(
    "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d",
    "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
    "e7f9a1b3c5d74e9f8a2b4c6d8e0f1a3b");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.customComponents.getComponentObjectNote(
  'cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d',
  'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
  'e7f9a1b3c5d74e9f8a2b4c6d8e0f1a3b',
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.CustomComponents().GetComponentObjectNote(context.Background(), "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d", "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e", "e7f9a1b3c5d74e9f8a2b4c6d8e0f1a3b", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "note": {
    "object": "<string>",
    "id": "<string>",
    "content": "<string>",
    "custom_component_object": {
      "href": "<string>",
      "id": "<string>",
      "object": "<string>"
    },
    "group": "<unknown>",
    "user": "<unknown>",
    "attachments": [
      {
        "uuid": "<string>",
        "filename": "<string>",
        "content_type": "<string>",
        "size": 123,
        "href": "<string>"
      }
    ],
    "watchers": [
      {}
    ],
    "created_on": "<string>",
    "last_updated_on": "<string>",
    "created_by": {
      "name": "<string>",
      "object": "<string>"
    },
    "last_updated_by": {
      "name": "<string>",
      "object": "<string>"
    },
    "version": 123,
    "href": "<string>"
  }
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

GET

components

{component_uuid}

objects

{component_object_id}

notes

{note_id}

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/components/cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d/objects/a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e/notes/e7f9a1b3c5d74e9f8a2b4c6d8e0f1a3b" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = client.custom_components.get_component_object_note(
    "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d",
    "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
    "e7f9a1b3c5d74e9f8a2b4c6d8e0f1a3b",
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.customComponents.getComponentObjectNote(
    'cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d',
    'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
    'e7f9a1b3c5d74e9f8a2b4c6d8e0f1a3b',
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->customComponents->getComponentObjectNote(
    'cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d',
    'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
    'e7f9a1b3c5d74e9f8a2b4c6d8e0f1a3b',
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.custom_components.custom_components_dto.CustomComponentsDto.ComponentObjectNote;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<ComponentObjectNote> response = client.customComponents().getComponentObjectNote(
        "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d",
        "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
        "e7f9a1b3c5d74e9f8a2b4c6d8e0f1a3b");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CustomComponents.GetComponentObjectNoteAsync(
    "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d",
    "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
    "e7f9a1b3c5d74e9f8a2b4c6d8e0f1a3b");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.customComponents.getComponentObjectNote(
  'cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d',
  'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
  'e7f9a1b3c5d74e9f8a2b4c6d8e0f1a3b',
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.CustomComponents().GetComponentObjectNote(context.Background(), "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d", "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e", "e7f9a1b3c5d74e9f8a2b4c6d8e0f1a3b", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "note": {
    "object": "<string>",
    "id": "<string>",
    "content": "<string>",
    "custom_component_object": {
      "href": "<string>",
      "id": "<string>",
      "object": "<string>"
    },
    "group": "<unknown>",
    "user": "<unknown>",
    "attachments": [
      {
        "uuid": "<string>",
        "filename": "<string>",
        "content_type": "<string>",
        "size": 123,
        "href": "<string>"
      }
    ],
    "watchers": [
      {}
    ],
    "created_on": "<string>",
    "last_updated_on": "<string>",
    "created_by": {
      "name": "<string>",
      "object": "<string>"
    },
    "last_updated_by": {
      "name": "<string>",
      "object": "<string>"
    },
    "version": 123,
    "href": "<string>"
  }
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

Reads a single note by its id, with its content, attachments, author and the object it belongs to.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

component_uuid

string

required

The component definition's id, which starts with cmp_.

component_object_id

string

required

The component object's id, as returned when it is created or listed.

note_id

string

required

The note's id, as returned when it is created or listed.

Response

The note, under note.

note

object

Show child attributes

Guides

API reference

Retrieve a component object's note

Authorizations

Path Parameters

Response