Create a component object note

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/components/cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d/objects/a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e/notes" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --form-string 'note=<p>Renewal call booked for next week.</p>' \
  -F "file=@renewal-terms.pdf"

from exsited import build_client

client = build_client()

response = client.custom_components.create_component_object_note(
    "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d",
    "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
    "<p>Renewal call booked for next week.</p>",
    files={"file": open("renewal-terms.pdf", "rb")},
)
print(response.data)

import {readFileSync} from 'node:fs';
import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.customComponents.createComponentObjectNote(
    'cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d',
    'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
    '<p>Renewal call booked for next week.</p>',
    {files: {file: ['renewal-terms.pdf', readFileSync('renewal-terms.pdf')]}},
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->customComponents->createComponentObjectNote(
    'cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d',
    'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
    '<p>Renewal call booked for next week.</p>',
    ['file' => ['renewal-terms.pdf', fopen('renewal-terms.pdf', 'r')]],
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.client.RequestOptions;
import com.exsited.resources.custom_components.custom_components_dto.CustomComponentsDto.ComponentObjectNote;
import java.nio.file.Path;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<ComponentObjectNote> response = client.customComponents().createComponentObjectNote(
        "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d",
        "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
        "<p>Renewal call booked for next week.</p>",
        Map.of("file", Path.of("renewal-terms.pdf")),
        RequestOptions.none());
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CustomComponents.CreateComponentObjectNoteAsync(
    "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d",
    "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
    "<p>Renewal call booked for next week.</p>",
    new Dictionary<string, object?> { ["file"] = new object?[] { "renewal-terms.pdf", File.ReadAllBytes("renewal-terms.pdf") } });

Console.WriteLine(response.Json);

import 'dart:io';

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.customComponents.createComponentObjectNote(
  'cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d',
  'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
  '<p>Renewal call booked for next week.</p>',
  files: {
    'file': [
      'renewal-terms.pdf',
      File('renewal-terms.pdf').readAsBytesSync(),
    ],
  },
);
print(response.map);

import (
	"context"
	"fmt"
	"log"
	"os"

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

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

file, err := os.ReadFile("renewal-terms.pdf")
if err != nil {
	log.Fatal(err)
}
response, err := client.CustomComponents().CreateComponentObjectNote(context.Background(), "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d", "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e", "<p>Renewal call booked for next week.</p>", map[string]any{"file": []any{"renewal-terms.pdf", file}}, 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>"
  }
}

POST

components

{component_uuid}

objects

{component_object_id}

notes

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/components/cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d/objects/a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e/notes" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --form-string 'note=<p>Renewal call booked for next week.</p>' \
  -F "file=@renewal-terms.pdf"

from exsited import build_client

client = build_client()

response = client.custom_components.create_component_object_note(
    "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d",
    "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
    "<p>Renewal call booked for next week.</p>",
    files={"file": open("renewal-terms.pdf", "rb")},
)
print(response.data)

import {readFileSync} from 'node:fs';
import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.customComponents.createComponentObjectNote(
    'cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d',
    'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
    '<p>Renewal call booked for next week.</p>',
    {files: {file: ['renewal-terms.pdf', readFileSync('renewal-terms.pdf')]}},
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->customComponents->createComponentObjectNote(
    'cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d',
    'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
    '<p>Renewal call booked for next week.</p>',
    ['file' => ['renewal-terms.pdf', fopen('renewal-terms.pdf', 'r')]],
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.client.RequestOptions;
import com.exsited.resources.custom_components.custom_components_dto.CustomComponentsDto.ComponentObjectNote;
import java.nio.file.Path;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<ComponentObjectNote> response = client.customComponents().createComponentObjectNote(
        "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d",
        "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
        "<p>Renewal call booked for next week.</p>",
        Map.of("file", Path.of("renewal-terms.pdf")),
        RequestOptions.none());
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CustomComponents.CreateComponentObjectNoteAsync(
    "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d",
    "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
    "<p>Renewal call booked for next week.</p>",
    new Dictionary<string, object?> { ["file"] = new object?[] { "renewal-terms.pdf", File.ReadAllBytes("renewal-terms.pdf") } });

Console.WriteLine(response.Json);

import 'dart:io';

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.customComponents.createComponentObjectNote(
  'cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d',
  'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
  '<p>Renewal call booked for next week.</p>',
  files: {
    'file': [
      'renewal-terms.pdf',
      File('renewal-terms.pdf').readAsBytesSync(),
    ],
  },
);
print(response.map);

import (
	"context"
	"fmt"
	"log"
	"os"

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

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

file, err := os.ReadFile("renewal-terms.pdf")
if err != nil {
	log.Fatal(err)
}
response, err := client.CustomComponents().CreateComponentObjectNote(context.Background(), "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d", "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e", "<p>Renewal call booked for next week.</p>", map[string]any{"file": []any{"renewal-terms.pdf", file}}, 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>"
  }
}

Send a multipart form with the note’s text in the note field and any files beside it. The new note comes back with its id, its content and one entry in attachments for each file.

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.

Body

multipart/form-data

note

string

required

The note's text. HTML such as <p>...</p> is kept as sent.

file

A file to attach. Optional.

Response

201 - application/json

The new note, under note.

note

object

Show child attributes

Guides

API reference

Create a component object note

Authorizations

Path Parameters

Body

Response