sym_objects
Read private typed business records, immutable field definitions, limits and usage. Queries are bounded and do not expand references.
API 2.3.3 · Published service contract ↗
Permissions
Discovery scopes: objects:read. Subject to discoveryScopes; execution still checks actual grant, account, Pass and resource authority.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
| operation | schema | ✓ |
{
"type": "object",
"properties": {
"operation": {
"oneOf": [
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "limits"
}
},
"required": [
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "usage"
}
},
"required": [
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "list_types"
},
"cursor": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
},
"limit": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 50
}
},
"required": [
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "get_type"
},
"id": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
}
},
"required": [
"action",
"id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "list"
},
"cursor": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
},
"limit": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"type_id": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
}
},
"required": [
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "get"
},
"id": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
}
},
"required": [
"action",
"id"
],
"additionalProperties": false
}
]
}
},
"required": [
"operation"
],
"additionalProperties": false
}Returns
closed service envelope and typed action result; user-defined field values follow their stored schema
{
"type": "object",
"properties": {
"result": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "object_type"
},
"item": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
},
"owner_uid": {
"type": "string"
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"created_at": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"updated_at": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 240
},
"description": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,63}$"
},
"type": {
"type": "string",
"enum": [
"text",
"number",
"boolean",
"date",
"timestamp",
"enum",
"reference",
"references"
]
},
"required": {
"default": false,
"type": "boolean"
},
"choices": {
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"maxLength": 240
}
},
"reference_type_id": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
}
},
"required": [
"name",
"type",
"required"
],
"additionalProperties": false
}
},
"schema_version": {
"type": "number",
"const": 1
},
"object_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"type_reference_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"id",
"owner_uid",
"revision",
"created_at",
"updated_at",
"name",
"description",
"fields",
"schema_version",
"object_count",
"type_reference_count"
],
"additionalProperties": false
}
},
"required": [
"kind",
"item"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "object"
},
"item": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
},
"owner_uid": {
"type": "string"
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"created_at": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"updated_at": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"type_id": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 240
},
"values": {
"type": "object",
"propertyNames": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,63}$"
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
}
}
]
}
},
"source": {
"type": "object",
"properties": {
"system": {
"type": "string",
"maxLength": 100
},
"external_id": {
"type": "string",
"maxLength": 500
},
"url": {
"type": "string",
"maxLength": 2000,
"format": "uri"
},
"observed_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
}
},
"required": [
"system",
"external_id"
],
"additionalProperties": false
},
"reference_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
}
},
"reference_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"archived": {
"type": "boolean"
}
},
"required": [
"id",
"owner_uid",
"revision",
"created_at",
"updated_at",
"type_id",
"title",
"values",
"reference_ids",
"reference_count",
"archived"
],
"additionalProperties": false
}
},
"required": [
"kind",
"item"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "object_types"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
},
"owner_uid": {
"type": "string"
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"created_at": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"updated_at": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 240
},
"description": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,63}$"
},
"type": {
"type": "string",
"enum": [
"text",
"number",
"boolean",
"date",
"timestamp",
"enum",
"reference",
"references"
]
},
"required": {
"default": false,
"type": "boolean"
},
"choices": {
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"maxLength": 240
}
},
"reference_type_id": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
}
},
"required": [
"name",
"type",
"required"
],
"additionalProperties": false
}
},
"schema_version": {
"type": "number",
"const": 1
},
"object_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"type_reference_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"id",
"owner_uid",
"revision",
"created_at",
"updated_at",
"name",
"description",
"fields",
"schema_version",
"object_count",
"type_reference_count"
],
"additionalProperties": false
}
},
"next_cursor": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"items",
"next_cursor"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "objects"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
},
"owner_uid": {
"type": "string"
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"created_at": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"updated_at": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"type_id": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 240
},
"values": {
"type": "object",
"propertyNames": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,63}$"
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
}
}
]
}
},
"source": {
"type": "object",
"properties": {
"system": {
"type": "string",
"maxLength": 100
},
"external_id": {
"type": "string",
"maxLength": 500
},
"url": {
"type": "string",
"maxLength": 2000,
"format": "uri"
},
"observed_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
}
},
"required": [
"system",
"external_id"
],
"additionalProperties": false
},
"reference_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
}
},
"reference_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"archived": {
"type": "boolean"
}
},
"required": [
"id",
"owner_uid",
"revision",
"created_at",
"updated_at",
"type_id",
"title",
"values",
"reference_ids",
"reference_count",
"archived"
],
"additionalProperties": false
}
},
"next_cursor": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"items",
"next_cursor"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "limits"
},
"limits": {
"type": "object",
"properties": {
"object_types": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"objects": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"fields_per_type": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"record_bytes": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"text_bytes": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"references_per_record": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"page_default": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"page_max": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"read_requests_per_minute": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"write_requests_per_minute": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"object_types",
"objects",
"fields_per_type",
"record_bytes",
"text_bytes",
"references_per_record",
"page_default",
"page_max",
"read_requests_per_minute",
"write_requests_per_minute"
],
"additionalProperties": false
}
},
"required": [
"kind",
"limits"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "usage"
},
"usage": {
"type": "object",
"properties": {
"object_types": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"objects": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"object_types",
"objects"
],
"additionalProperties": false
},
"limits": {
"type": "object",
"properties": {
"object_types": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"objects": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"fields_per_type": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"record_bytes": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"text_bytes": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"references_per_record": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"page_default": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"page_max": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"read_requests_per_minute": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"write_requests_per_minute": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"object_types",
"objects",
"fields_per_type",
"record_bytes",
"text_bytes",
"references_per_record",
"page_default",
"page_max",
"read_requests_per_minute",
"write_requests_per_minute"
],
"additionalProperties": false
}
},
"required": [
"kind",
"usage",
"limits"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "deleted"
},
"deleted": {
"type": "boolean",
"const": true
},
"id": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
}
},
"required": [
"kind",
"deleted",
"id"
],
"additionalProperties": false
}
]
},
"error": {
"type": "string"
},
"status": {}
},
"additionalProperties": {},
"anyOf": [
{
"type": "object",
"properties": {
"result": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "object_type"
},
"item": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
},
"owner_uid": {
"type": "string"
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"created_at": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"updated_at": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 240
},
"description": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,63}$"
},
"type": {
"type": "string",
"enum": [
"text",
"number",
"boolean",
"date",
"timestamp",
"enum",
"reference",
"references"
]
},
"required": {
"default": false,
"type": "boolean"
},
"choices": {
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"maxLength": 240
}
},
"reference_type_id": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
}
},
"required": [
"name",
"type",
"required"
],
"additionalProperties": false
}
},
"schema_version": {
"type": "number",
"const": 1
},
"object_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"type_reference_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"id",
"owner_uid",
"revision",
"created_at",
"updated_at",
"name",
"description",
"fields",
"schema_version",
"object_count",
"type_reference_count"
],
"additionalProperties": false
}
},
"required": [
"kind",
"item"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "object"
},
"item": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
},
"owner_uid": {
"type": "string"
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"created_at": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"updated_at": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"type_id": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 240
},
"values": {
"type": "object",
"propertyNames": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,63}$"
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
}
}
]
}
},
"source": {
"type": "object",
"properties": {
"system": {
"type": "string",
"maxLength": 100
},
"external_id": {
"type": "string",
"maxLength": 500
},
"url": {
"type": "string",
"maxLength": 2000,
"format": "uri"
},
"observed_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
}
},
"required": [
"system",
"external_id"
],
"additionalProperties": false
},
"reference_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
}
},
"reference_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"archived": {
"type": "boolean"
}
},
"required": [
"id",
"owner_uid",
"revision",
"created_at",
"updated_at",
"type_id",
"title",
"values",
"reference_ids",
"reference_count",
"archived"
],
"additionalProperties": false
}
},
"required": [
"kind",
"item"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "object_types"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
},
"owner_uid": {
"type": "string"
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"created_at": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"updated_at": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 240
},
"description": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,63}$"
},
"type": {
"type": "string",
"enum": [
"text",
"number",
"boolean",
"date",
"timestamp",
"enum",
"reference",
"references"
]
},
"required": {
"default": false,
"type": "boolean"
},
"choices": {
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"maxLength": 240
}
},
"reference_type_id": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
}
},
"required": [
"name",
"type",
"required"
],
"additionalProperties": false
}
},
"schema_version": {
"type": "number",
"const": 1
},
"object_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"type_reference_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"id",
"owner_uid",
"revision",
"created_at",
"updated_at",
"name",
"description",
"fields",
"schema_version",
"object_count",
"type_reference_count"
],
"additionalProperties": false
}
},
"next_cursor": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"items",
"next_cursor"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "objects"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
},
"owner_uid": {
"type": "string"
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"created_at": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"updated_at": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"type_id": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 240
},
"values": {
"type": "object",
"propertyNames": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,63}$"
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
}
}
]
}
},
"source": {
"type": "object",
"properties": {
"system": {
"type": "string",
"maxLength": 100
},
"external_id": {
"type": "string",
"maxLength": 500
},
"url": {
"type": "string",
"maxLength": 2000,
"format": "uri"
},
"observed_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
}
},
"required": [
"system",
"external_id"
],
"additionalProperties": false
},
"reference_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
}
},
"reference_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"archived": {
"type": "boolean"
}
},
"required": [
"id",
"owner_uid",
"revision",
"created_at",
"updated_at",
"type_id",
"title",
"values",
"reference_ids",
"reference_count",
"archived"
],
"additionalProperties": false
}
},
"next_cursor": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"items",
"next_cursor"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "limits"
},
"limits": {
"type": "object",
"properties": {
"object_types": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"objects": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"fields_per_type": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"record_bytes": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"text_bytes": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"references_per_record": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"page_default": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"page_max": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"read_requests_per_minute": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"write_requests_per_minute": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"object_types",
"objects",
"fields_per_type",
"record_bytes",
"text_bytes",
"references_per_record",
"page_default",
"page_max",
"read_requests_per_minute",
"write_requests_per_minute"
],
"additionalProperties": false
}
},
"required": [
"kind",
"limits"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "usage"
},
"usage": {
"type": "object",
"properties": {
"object_types": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"objects": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"object_types",
"objects"
],
"additionalProperties": false
},
"limits": {
"type": "object",
"properties": {
"object_types": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"objects": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"fields_per_type": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"record_bytes": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"text_bytes": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"references_per_record": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"page_default": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"page_max": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"read_requests_per_minute": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"write_requests_per_minute": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"object_types",
"objects",
"fields_per_type",
"record_bytes",
"text_bytes",
"references_per_record",
"page_default",
"page_max",
"read_requests_per_minute",
"write_requests_per_minute"
],
"additionalProperties": false
}
},
"required": [
"kind",
"usage",
"limits"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "deleted"
},
"deleted": {
"type": "boolean",
"const": true
},
"id": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,95}$"
}
},
"required": [
"kind",
"deleted",
"id"
],
"additionalProperties": false
}
]
}
},
"required": [
"result"
],
"additionalProperties": false,
"not": {
"required": [
"error"
]
}
},
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"result": false
},
"required": [
"error",
"status"
],
"additionalProperties": {}
}
]
}REST equivalents
[
{
"method": "POST",
"path": "/v1/objects/read"
}
]