Merge · Schema

CustomObjectClass

# The Custom Object Class Object ### Description The `Custom Object Class` object is used to represent a Custom Object Schema in the remote system. ### Usage Example TODO

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
id	string
remote_id	stringnull	The third-party API ID of the matching object.
created_at	string
modified_at	string
name	stringnull	The custom object class's name.
description	stringnull	The custom object class's description.
labels	object	The custom object class's singular and plural labels.
fields	array
association_types	arraynull	The types of associations with other models that the custom object class can have.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CustomObjectClass",
  "title": "CustomObjectClass",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "remote_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The third-party API ID of the matching object."
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "modified_at": {
      "type": "string",
      "format": "date-time"
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The custom object class's name."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "The custom object class's description."
    },
    "labels": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "The custom object class's singular and plural labels."
    },
    "fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RemoteFieldClassForCustomObjectClass"
      }
    },
    "association_types": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "object",
        "additionalProperties": {
          "description": "Any type"
        }
      },
      "description": "The types of associations with other models that the custom object class can have."
    }
  },
  "description": "# The Custom Object Class Object\n### Description\nThe `Custom Object Class` object is used to represent a Custom Object Schema in the remote system.\n### Usage Example\nTODO"
}