---
source_url: https://www.pubnub.com/docs/sdks/rest-api/get-users
title: Get users
---

# Get users

> For AI agents: documentation index at https://www.pubnub.com/llms-full.txt

Returns a paginated list of users.

| Path Parameters |
| --- |
| `subKey`string—**REQUIRED**Subscribe key identifying the keyset. |

| Query Parameters |
| --- |
| `entity_class`stringPossible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z][a-zA-Z0-9_-]*$Entity class name |
| `entity_class_version`integerPossible values: 1 ≤ valueVersion of the entity class. If not provided, the latest version is used. |
| `entity_class_level`stringPossible values: [Global, SubKey]The level at which a class is defined.Level of the entity class. |
| `cursor`stringOpaque cursor for pagination. Base64-encoded token representing the position in the result set. Omit or pass null for the first page. Use the cursor value from meta.next_cursor in the response to navigate to the next page.Example: TjA= |
| `limit`integerPossible values: 1 ≤ value ≤ 100Maximum number of items to return per page (default 20, max 100) |
| `filter_fast`stringFilter expression using AppContext Query Language against strongly consistent storage with limited number of conditions |
| `filter`stringFilter expression using AppContext Query Language against eventually consistent storage |
| `sort`stringComma-separated list of field names to sort by, each optionally suffixed with :desc (ascending by default).The built-in fields id, createdAt, and updatedAt are always sortable without declaring them in the class definition. status is also sortable by default, but can be restricted by projections: when a class declares it at /status, a PAM-authenticated request can use it only if every projection reachable by the token includes status.Payload properties need filtering of at least simple, or full when sort is combined with filter_advanced. |
| `auth`stringRequired unless you supply signature instead. An Access Manager token authorizing the operation. Use this for client-side callers.Supply either auth or signature, never both. Supplying neither returns 401 (DS-0203). Supplying both returns 403 (DS-0201).If the token cannot be decoded, or its projection does not permit the requested fields, the request fails with 403 (DS-0202, INVALID_TOKEN). |
| `signature`stringRequired unless you supply auth instead. A signature proving the request was signed with the secret key for this keyset. Use this for server-side callers.Supply either signature or auth, never both. Supplying neither returns 401 (DS-0203). Supplying both returns 403 (DS-0201).Refer to Signature generation for how to compute it. |

| Responses |
| --- |
| `200`Successful responseSchema — OPTIONALdata object[]Response data (specific type defined in extending schemas)payload objectNode — OPTIONALentityClass stringPossible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z][a-zA-Z0-9_-]*$Name of the entity class.entityClassVersion integerPossible values: 1 ≤ valueVersion of the entity class.entityClassLevel stringPossible values: [Global, SubKey]The level at which the entity class is defined.id string — OPTIONALPossible values: 1 ≤ length ≤ 255createdAt date-time — OPTIONALDate and time the entity was created.updatedAt date-time — OPTIONALDate and time the entity was last updated.eTag stringThe entity's content fingerprint used in conditional requests.status string — OPTIONALPossible values: 1 ≤ length ≤ 100Entity statusexpiresAt date-timeDate and time when the entity expires (will be deleted automatically).meta object — OPTIONALCursor-based pagination metadatanext_cursor string — OPTIONALOpaque cursor for the next page. Base64-encoded token. Use this value in the cursor query parameter to fetch the next page. Null if there are no more results (has_next is false).has_next booleanIndicates whether there are more results after this pagelimit integer — OPTIONALThe limit applied to this page (may differ from requested limit) | Schema—**OPTIONAL** | `data`object[]Response data (specific type defined in extending schemas)payload objectNode — OPTIONALentityClass stringPossible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z][a-zA-Z0-9_-]*$Name of the entity class.entityClassVersion integerPossible values: 1 ≤ valueVersion of the entity class.entityClassLevel stringPossible values: [Global, SubKey]The level at which the entity class is defined.id string — OPTIONALPossible values: 1 ≤ length ≤ 255createdAt date-time — OPTIONALDate and time the entity was created.updatedAt date-time — OPTIONALDate and time the entity was last updated.eTag stringThe entity's content fingerprint used in conditional requests.status string — OPTIONALPossible values: 1 ≤ length ≤ 100Entity statusexpiresAt date-timeDate and time when the entity expires (will be deleted automatically). | `payload`objectNode—**OPTIONAL** | `entityClass`stringPossible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z][a-zA-Z0-9_-]*$Name of the entity class. | `entityClassVersion`integerPossible values: 1 ≤ valueVersion of the entity class. | `entityClassLevel`stringPossible values: [Global, SubKey]The level at which the entity class is defined. | `id`string—**OPTIONAL**Possible values: 1 ≤ length ≤ 255 | `createdAt`date-time—**OPTIONAL**Date and time the entity was created. | `updatedAt`date-time—**OPTIONAL**Date and time the entity was last updated. | `eTag`stringThe entity's content fingerprint used in conditional requests. | `status`string—**OPTIONAL**Possible values: 1 ≤ length ≤ 100Entity status | `expiresAt`date-timeDate and time when the entity expires (will be deleted automatically). | `meta`object—**OPTIONAL**Cursor-based pagination metadatanext_cursor string — OPTIONALOpaque cursor for the next page. Base64-encoded token. Use this value in the cursor query parameter to fetch the next page. Null if there are no more results (has_next is false).has_next booleanIndicates whether there are more results after this pagelimit integer — OPTIONALThe limit applied to this page (may differ from requested limit) | `next_cursor`string—**OPTIONAL**Opaque cursor for the next page. Base64-encoded token. Use this value in the cursor query parameter to fetch the next page. Null if there are no more results (has_next is false). | `has_next`booleanIndicates whether there are more results after this page | `limit`integer—**OPTIONAL**The limit applied to this page (may differ from requested limit) |
| Schema—**OPTIONAL** |
| `data`object[]Response data (specific type defined in extending schemas)payload objectNode — OPTIONALentityClass stringPossible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z][a-zA-Z0-9_-]*$Name of the entity class.entityClassVersion integerPossible values: 1 ≤ valueVersion of the entity class.entityClassLevel stringPossible values: [Global, SubKey]The level at which the entity class is defined.id string — OPTIONALPossible values: 1 ≤ length ≤ 255createdAt date-time — OPTIONALDate and time the entity was created.updatedAt date-time — OPTIONALDate and time the entity was last updated.eTag stringThe entity's content fingerprint used in conditional requests.status string — OPTIONALPossible values: 1 ≤ length ≤ 100Entity statusexpiresAt date-timeDate and time when the entity expires (will be deleted automatically). | `payload`objectNode—**OPTIONAL** | `entityClass`stringPossible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z][a-zA-Z0-9_-]*$Name of the entity class. | `entityClassVersion`integerPossible values: 1 ≤ valueVersion of the entity class. | `entityClassLevel`stringPossible values: [Global, SubKey]The level at which the entity class is defined. | `id`string—**OPTIONAL**Possible values: 1 ≤ length ≤ 255 | `createdAt`date-time—**OPTIONAL**Date and time the entity was created. | `updatedAt`date-time—**OPTIONAL**Date and time the entity was last updated. | `eTag`stringThe entity's content fingerprint used in conditional requests. | `status`string—**OPTIONAL**Possible values: 1 ≤ length ≤ 100Entity status | `expiresAt`date-timeDate and time when the entity expires (will be deleted automatically). |
| `payload`objectNode—**OPTIONAL** |
| `entityClass`stringPossible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z][a-zA-Z0-9_-]*$Name of the entity class. |
| `entityClassVersion`integerPossible values: 1 ≤ valueVersion of the entity class. |
| `entityClassLevel`stringPossible values: [Global, SubKey]The level at which the entity class is defined. |
| `id`string—**OPTIONAL**Possible values: 1 ≤ length ≤ 255 |
| `createdAt`date-time—**OPTIONAL**Date and time the entity was created. |
| `updatedAt`date-time—**OPTIONAL**Date and time the entity was last updated. |
| `eTag`stringThe entity's content fingerprint used in conditional requests. |
| `status`string—**OPTIONAL**Possible values: 1 ≤ length ≤ 100Entity status |
| `expiresAt`date-timeDate and time when the entity expires (will be deleted automatically). |
| `meta`object—**OPTIONAL**Cursor-based pagination metadatanext_cursor string — OPTIONALOpaque cursor for the next page. Base64-encoded token. Use this value in the cursor query parameter to fetch the next page. Null if there are no more results (has_next is false).has_next booleanIndicates whether there are more results after this pagelimit integer — OPTIONALThe limit applied to this page (may differ from requested limit) | `next_cursor`string—**OPTIONAL**Opaque cursor for the next page. Base64-encoded token. Use this value in the cursor query parameter to fetch the next page. Null if there are no more results (has_next is false). | `has_next`booleanIndicates whether there are more results after this page | `limit`integer—**OPTIONAL**The limit applied to this page (may differ from requested limit) |
| `next_cursor`string—**OPTIONAL**Opaque cursor for the next page. Base64-encoded token. Use this value in the cursor query parameter to fetch the next page. Null if there are no more results (has_next is false). |
| `has_next`booleanIndicates whether there are more results after this page |
| `limit`integer—**OPTIONAL**The limit applied to this page (may differ from requested limit) |
| `400`Bad request. Adds the filter, sort and cursor errors specific to list operations.CodeConstantCauseDS-0002BAD_REQUESTRequired header or query parameter missing.DS-0004VALIDATION_ERRORPath variable or query parameter failed validation.DS-0005INVALID_FILTERfilter_fast / filter could not be parsed, references an unknown field, or compares a literal against an incompatible valueKind. path is always filter, including for filter_fast.DS-0006INVALID_ARGUMENTsort references a field that is not sortable in this request (path is sort), or cursor could not be decoded.The built-in fields id, createdAt, and updatedAt are always sortable. status is sortable by default, but can be restricted by projections when it is declared at /status: a PAM-authenticated request can use it only if every projection reachable by the token includes status. Payload properties additionally need filtering of at least simple — or full when filter_advanced is present, because that path resolves sorts in the search index, which only holds full properties.Schema — OPTIONALerrors object[] — OPTIONALerrorCode stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections.message stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it.path string — OPTIONALLocation of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). | Code | Constant | Cause | `DS-0002` | BAD_REQUEST | Required header or query parameter missing. | `DS-0004` | VALIDATION_ERROR | Path variable or query parameter failed validation. | `DS-0005` | INVALID_FILTER | `filter_fast` / `filter` could not be parsed, references an unknown field, or compares a literal against an incompatible `valueKind`. `path` is always `filter`, including for `filter_fast`. | `DS-0006` | INVALID_ARGUMENT | `sort` references a field that is not sortable in this request (`path` is `sort`), or `cursor` could not be decoded. | Schema—**OPTIONAL** | `errors`object[]—**OPTIONAL**errorCode stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections.message stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it.path string — OPTIONALLocation of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). | `errorCode`stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections. | Code | Constant | Status | Meaning | `DS-0000` | INTERNAL_SERVER_ERROR | 500 | Unhandled server error, or a server-side routing configuration problem. | `DS-0002` | BAD_REQUEST | 400 | Required header or query parameter missing, or request input otherwise unusable. | `DS-0003` | INVALID_JSON | 400 | Request body absent, empty, or not valid JSON. | `DS-0004` | VALIDATION_ERROR | 400 | Body, path variable or query parameter failed validation. One error item per violation. | `DS-0005` | INVALID_FILTER | 400 | `filter_fast` / `filter` could not be parsed or validated. | `DS-0006` | INVALID_ARGUMENT | 400 | An argument could not be used - a `sort` field that is not sortable in that request, undecodable `cursor`, malformed JSON Pointer, parameter type mismatch. | `DS-0007` | UNSUPPORTED_CONTENT_TYPE | 415 | Request `Content-Type` not supported. | `DS-0008` | UNEXPECTED_FILTERABLE_FIELD_VALUE | 400 | A declared class property's value does not match its `valueKind`. | `DS-0009` | SERVICE_UNAVAILABLE | 503 | A required dependency is unavailable, or the request could not be forwarded to its region. | `DS-0010` | NOT_ACCEPTABLE | 406 | *Reserved - not currently emitted.* 406 responses carry a `text/plain` body with no error code. | `DS-0011` | METHOD_NOT_ALLOWED | 405 | HTTP method not supported for this path. | Code | Constant | Status | Meaning | `DS-0100` | NOT_FOUND | 404 | The addressed resource does not exist. | Code | Constant | Status | Meaning | `DS-0200` | DATASYNC_NOT_ENABLED | 403 | Datasync is not enabled for this subscribe key. | `DS-0201` | ACCESS_DENIED | 403 | Access Manager not enabled, conflicting credentials supplied, or authorization check denied. | `DS-0202` | INVALID_TOKEN | 403 | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. | `DS-0203` | UNAUTHENTICATED | 401 | No credentials supplied. | Code | Constant | Status | Meaning | `DS-0300` | ETAG_MISMATCH | 412 | `If-Match` does not contain the resource's current ETag. | `DS-0301` | CONFLICT | 409 | A resource with the same identity already exists. | Code | Constant | Status | Meaning | `DS-0400` | CONTENT_TOO_LARGE | 413 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0500` | CUSTOM_NOT_SCALAR | 400 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0600` | CONFIG_NOT_FOUND | 404 | Subscribe key unknown to the configuration service, or its datasync region is not configured. | `DS-0602` | UNSUPPORTED_ENTITY_PROPERTY_TYPE | 400 | A declared property's path resolves to a non-scalar node (object or array). | `DS-0650` | NON_NULLABLE_PROPERTY | 400 | A property declared `nullable: false` is missing or explicitly `null`. | Code | Constant | Status | Meaning | `DS-0700` | IMMUTABLE_FIELD_MODIFICATION | 400 | A patch targets a pointer outside the mutable set. Patch only. | Code | Constant | Status | Meaning | `DS-0800` | WRONG_ENTITY_CLASS_TYPE | 400 | An endpoint entity's class does not satisfy the relationship class for that side. Create only. | `DS-0801` | CARDINALITY_VIOLATED | 409 | ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only. | Code | Constant | Status | Meaning | `DS-0900` | GLOBAL_CLASS_MODIFICATION | 403 | Global class definitions are read-only. Replace and delete only. | `DS-0901` | PROJECTION_LIMIT_EXCEEDED | 400 | Distinct projections across all properties exceed the per-class maximum. | `DS-0902` | INVALID_PROJECTION_NAME | 400 | Projection name too long or malformed, or a property declares an empty projection list. | `DS-0903` | INCOMPATIBLE_CHILD_PROPERTY | 400 | A redeclared inherited property differs from the parent in `path`, `valueKind`, or `nullable`. Entity classes only. | `DS-0904` | MISSING_PARENT_PROPERTY | 400 | *Reserved - not currently emitted.* Missing parent properties are inherited automatically. | `DS-0905` | CLASS_HAS_CHILDREN | 409 | The class still has subclasses and cannot be deleted. Entity classes only. | `DS-0906` | RESERVED_PROPERTY_NAME | 400 | A declared property uses the name of a built-in record field (`id`, `createdAt`, `updatedAt`, `status`). Only `status` may be re-declared, and only as `{name: "status", path: "/status"}` to control its projections. | `message`stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it. | `path`string—**OPTIONAL**Location of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). |
| Code | Constant | Cause |
| `DS-0002` | BAD_REQUEST | Required header or query parameter missing. |
| `DS-0004` | VALIDATION_ERROR | Path variable or query parameter failed validation. |
| `DS-0005` | INVALID_FILTER | `filter_fast` / `filter` could not be parsed, references an unknown field, or compares a literal against an incompatible `valueKind`. `path` is always `filter`, including for `filter_fast`. |
| `DS-0006` | INVALID_ARGUMENT | `sort` references a field that is not sortable in this request (`path` is `sort`), or `cursor` could not be decoded. |
| Schema—**OPTIONAL** |
| `errors`object[]—**OPTIONAL**errorCode stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections.message stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it.path string — OPTIONALLocation of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). | `errorCode`stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections. | Code | Constant | Status | Meaning | `DS-0000` | INTERNAL_SERVER_ERROR | 500 | Unhandled server error, or a server-side routing configuration problem. | `DS-0002` | BAD_REQUEST | 400 | Required header or query parameter missing, or request input otherwise unusable. | `DS-0003` | INVALID_JSON | 400 | Request body absent, empty, or not valid JSON. | `DS-0004` | VALIDATION_ERROR | 400 | Body, path variable or query parameter failed validation. One error item per violation. | `DS-0005` | INVALID_FILTER | 400 | `filter_fast` / `filter` could not be parsed or validated. | `DS-0006` | INVALID_ARGUMENT | 400 | An argument could not be used - a `sort` field that is not sortable in that request, undecodable `cursor`, malformed JSON Pointer, parameter type mismatch. | `DS-0007` | UNSUPPORTED_CONTENT_TYPE | 415 | Request `Content-Type` not supported. | `DS-0008` | UNEXPECTED_FILTERABLE_FIELD_VALUE | 400 | A declared class property's value does not match its `valueKind`. | `DS-0009` | SERVICE_UNAVAILABLE | 503 | A required dependency is unavailable, or the request could not be forwarded to its region. | `DS-0010` | NOT_ACCEPTABLE | 406 | *Reserved - not currently emitted.* 406 responses carry a `text/plain` body with no error code. | `DS-0011` | METHOD_NOT_ALLOWED | 405 | HTTP method not supported for this path. | Code | Constant | Status | Meaning | `DS-0100` | NOT_FOUND | 404 | The addressed resource does not exist. | Code | Constant | Status | Meaning | `DS-0200` | DATASYNC_NOT_ENABLED | 403 | Datasync is not enabled for this subscribe key. | `DS-0201` | ACCESS_DENIED | 403 | Access Manager not enabled, conflicting credentials supplied, or authorization check denied. | `DS-0202` | INVALID_TOKEN | 403 | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. | `DS-0203` | UNAUTHENTICATED | 401 | No credentials supplied. | Code | Constant | Status | Meaning | `DS-0300` | ETAG_MISMATCH | 412 | `If-Match` does not contain the resource's current ETag. | `DS-0301` | CONFLICT | 409 | A resource with the same identity already exists. | Code | Constant | Status | Meaning | `DS-0400` | CONTENT_TOO_LARGE | 413 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0500` | CUSTOM_NOT_SCALAR | 400 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0600` | CONFIG_NOT_FOUND | 404 | Subscribe key unknown to the configuration service, or its datasync region is not configured. | `DS-0602` | UNSUPPORTED_ENTITY_PROPERTY_TYPE | 400 | A declared property's path resolves to a non-scalar node (object or array). | `DS-0650` | NON_NULLABLE_PROPERTY | 400 | A property declared `nullable: false` is missing or explicitly `null`. | Code | Constant | Status | Meaning | `DS-0700` | IMMUTABLE_FIELD_MODIFICATION | 400 | A patch targets a pointer outside the mutable set. Patch only. | Code | Constant | Status | Meaning | `DS-0800` | WRONG_ENTITY_CLASS_TYPE | 400 | An endpoint entity's class does not satisfy the relationship class for that side. Create only. | `DS-0801` | CARDINALITY_VIOLATED | 409 | ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only. | Code | Constant | Status | Meaning | `DS-0900` | GLOBAL_CLASS_MODIFICATION | 403 | Global class definitions are read-only. Replace and delete only. | `DS-0901` | PROJECTION_LIMIT_EXCEEDED | 400 | Distinct projections across all properties exceed the per-class maximum. | `DS-0902` | INVALID_PROJECTION_NAME | 400 | Projection name too long or malformed, or a property declares an empty projection list. | `DS-0903` | INCOMPATIBLE_CHILD_PROPERTY | 400 | A redeclared inherited property differs from the parent in `path`, `valueKind`, or `nullable`. Entity classes only. | `DS-0904` | MISSING_PARENT_PROPERTY | 400 | *Reserved - not currently emitted.* Missing parent properties are inherited automatically. | `DS-0905` | CLASS_HAS_CHILDREN | 409 | The class still has subclasses and cannot be deleted. Entity classes only. | `DS-0906` | RESERVED_PROPERTY_NAME | 400 | A declared property uses the name of a built-in record field (`id`, `createdAt`, `updatedAt`, `status`). Only `status` may be re-declared, and only as `{name: "status", path: "/status"}` to control its projections. | `message`stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it. | `path`string—**OPTIONAL**Location of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). |
| `errorCode`stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections. | Code | Constant | Status | Meaning | `DS-0000` | INTERNAL_SERVER_ERROR | 500 | Unhandled server error, or a server-side routing configuration problem. | `DS-0002` | BAD_REQUEST | 400 | Required header or query parameter missing, or request input otherwise unusable. | `DS-0003` | INVALID_JSON | 400 | Request body absent, empty, or not valid JSON. | `DS-0004` | VALIDATION_ERROR | 400 | Body, path variable or query parameter failed validation. One error item per violation. | `DS-0005` | INVALID_FILTER | 400 | `filter_fast` / `filter` could not be parsed or validated. | `DS-0006` | INVALID_ARGUMENT | 400 | An argument could not be used - a `sort` field that is not sortable in that request, undecodable `cursor`, malformed JSON Pointer, parameter type mismatch. | `DS-0007` | UNSUPPORTED_CONTENT_TYPE | 415 | Request `Content-Type` not supported. | `DS-0008` | UNEXPECTED_FILTERABLE_FIELD_VALUE | 400 | A declared class property's value does not match its `valueKind`. | `DS-0009` | SERVICE_UNAVAILABLE | 503 | A required dependency is unavailable, or the request could not be forwarded to its region. | `DS-0010` | NOT_ACCEPTABLE | 406 | *Reserved - not currently emitted.* 406 responses carry a `text/plain` body with no error code. | `DS-0011` | METHOD_NOT_ALLOWED | 405 | HTTP method not supported for this path. | Code | Constant | Status | Meaning | `DS-0100` | NOT_FOUND | 404 | The addressed resource does not exist. | Code | Constant | Status | Meaning | `DS-0200` | DATASYNC_NOT_ENABLED | 403 | Datasync is not enabled for this subscribe key. | `DS-0201` | ACCESS_DENIED | 403 | Access Manager not enabled, conflicting credentials supplied, or authorization check denied. | `DS-0202` | INVALID_TOKEN | 403 | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. | `DS-0203` | UNAUTHENTICATED | 401 | No credentials supplied. | Code | Constant | Status | Meaning | `DS-0300` | ETAG_MISMATCH | 412 | `If-Match` does not contain the resource's current ETag. | `DS-0301` | CONFLICT | 409 | A resource with the same identity already exists. | Code | Constant | Status | Meaning | `DS-0400` | CONTENT_TOO_LARGE | 413 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0500` | CUSTOM_NOT_SCALAR | 400 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0600` | CONFIG_NOT_FOUND | 404 | Subscribe key unknown to the configuration service, or its datasync region is not configured. | `DS-0602` | UNSUPPORTED_ENTITY_PROPERTY_TYPE | 400 | A declared property's path resolves to a non-scalar node (object or array). | `DS-0650` | NON_NULLABLE_PROPERTY | 400 | A property declared `nullable: false` is missing or explicitly `null`. | Code | Constant | Status | Meaning | `DS-0700` | IMMUTABLE_FIELD_MODIFICATION | 400 | A patch targets a pointer outside the mutable set. Patch only. | Code | Constant | Status | Meaning | `DS-0800` | WRONG_ENTITY_CLASS_TYPE | 400 | An endpoint entity's class does not satisfy the relationship class for that side. Create only. | `DS-0801` | CARDINALITY_VIOLATED | 409 | ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only. | Code | Constant | Status | Meaning | `DS-0900` | GLOBAL_CLASS_MODIFICATION | 403 | Global class definitions are read-only. Replace and delete only. | `DS-0901` | PROJECTION_LIMIT_EXCEEDED | 400 | Distinct projections across all properties exceed the per-class maximum. | `DS-0902` | INVALID_PROJECTION_NAME | 400 | Projection name too long or malformed, or a property declares an empty projection list. | `DS-0903` | INCOMPATIBLE_CHILD_PROPERTY | 400 | A redeclared inherited property differs from the parent in `path`, `valueKind`, or `nullable`. Entity classes only. | `DS-0904` | MISSING_PARENT_PROPERTY | 400 | *Reserved - not currently emitted.* Missing parent properties are inherited automatically. | `DS-0905` | CLASS_HAS_CHILDREN | 409 | The class still has subclasses and cannot be deleted. Entity classes only. | `DS-0906` | RESERVED_PROPERTY_NAME | 400 | A declared property uses the name of a built-in record field (`id`, `createdAt`, `updatedAt`, `status`). Only `status` may be re-declared, and only as `{name: "status", path: "/status"}` to control its projections. |
| Code | Constant | Status | Meaning |
| `DS-0000` | INTERNAL_SERVER_ERROR | 500 | Unhandled server error, or a server-side routing configuration problem. |
| `DS-0002` | BAD_REQUEST | 400 | Required header or query parameter missing, or request input otherwise unusable. |
| `DS-0003` | INVALID_JSON | 400 | Request body absent, empty, or not valid JSON. |
| `DS-0004` | VALIDATION_ERROR | 400 | Body, path variable or query parameter failed validation. One error item per violation. |
| `DS-0005` | INVALID_FILTER | 400 | `filter_fast` / `filter` could not be parsed or validated. |
| `DS-0006` | INVALID_ARGUMENT | 400 | An argument could not be used - a `sort` field that is not sortable in that request, undecodable `cursor`, malformed JSON Pointer, parameter type mismatch. |
| `DS-0007` | UNSUPPORTED_CONTENT_TYPE | 415 | Request `Content-Type` not supported. |
| `DS-0008` | UNEXPECTED_FILTERABLE_FIELD_VALUE | 400 | A declared class property's value does not match its `valueKind`. |
| `DS-0009` | SERVICE_UNAVAILABLE | 503 | A required dependency is unavailable, or the request could not be forwarded to its region. |
| `DS-0010` | NOT_ACCEPTABLE | 406 | *Reserved - not currently emitted.* 406 responses carry a `text/plain` body with no error code. |
| `DS-0011` | METHOD_NOT_ALLOWED | 405 | HTTP method not supported for this path. |
| Code | Constant | Status | Meaning |
| `DS-0100` | NOT_FOUND | 404 | The addressed resource does not exist. |
| Code | Constant | Status | Meaning |
| `DS-0200` | DATASYNC_NOT_ENABLED | 403 | Datasync is not enabled for this subscribe key. |
| `DS-0201` | ACCESS_DENIED | 403 | Access Manager not enabled, conflicting credentials supplied, or authorization check denied. |
| `DS-0202` | INVALID_TOKEN | 403 | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. |
| `DS-0203` | UNAUTHENTICATED | 401 | No credentials supplied. |
| Code | Constant | Status | Meaning |
| `DS-0300` | ETAG_MISMATCH | 412 | `If-Match` does not contain the resource's current ETag. |
| `DS-0301` | CONFLICT | 409 | A resource with the same identity already exists. |
| Code | Constant | Status | Meaning |
| `DS-0400` | CONTENT_TOO_LARGE | 413 | *Reserved - not currently emitted.* |
| Code | Constant | Status | Meaning |
| `DS-0500` | CUSTOM_NOT_SCALAR | 400 | *Reserved - not currently emitted.* |
| Code | Constant | Status | Meaning |
| `DS-0600` | CONFIG_NOT_FOUND | 404 | Subscribe key unknown to the configuration service, or its datasync region is not configured. |
| `DS-0602` | UNSUPPORTED_ENTITY_PROPERTY_TYPE | 400 | A declared property's path resolves to a non-scalar node (object or array). |
| `DS-0650` | NON_NULLABLE_PROPERTY | 400 | A property declared `nullable: false` is missing or explicitly `null`. |
| Code | Constant | Status | Meaning |
| `DS-0700` | IMMUTABLE_FIELD_MODIFICATION | 400 | A patch targets a pointer outside the mutable set. Patch only. |
| Code | Constant | Status | Meaning |
| `DS-0800` | WRONG_ENTITY_CLASS_TYPE | 400 | An endpoint entity's class does not satisfy the relationship class for that side. Create only. |
| `DS-0801` | CARDINALITY_VIOLATED | 409 | ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only. |
| Code | Constant | Status | Meaning |
| `DS-0900` | GLOBAL_CLASS_MODIFICATION | 403 | Global class definitions are read-only. Replace and delete only. |
| `DS-0901` | PROJECTION_LIMIT_EXCEEDED | 400 | Distinct projections across all properties exceed the per-class maximum. |
| `DS-0902` | INVALID_PROJECTION_NAME | 400 | Projection name too long or malformed, or a property declares an empty projection list. |
| `DS-0903` | INCOMPATIBLE_CHILD_PROPERTY | 400 | A redeclared inherited property differs from the parent in `path`, `valueKind`, or `nullable`. Entity classes only. |
| `DS-0904` | MISSING_PARENT_PROPERTY | 400 | *Reserved - not currently emitted.* Missing parent properties are inherited automatically. |
| `DS-0905` | CLASS_HAS_CHILDREN | 409 | The class still has subclasses and cannot be deleted. Entity classes only. |
| `DS-0906` | RESERVED_PROPERTY_NAME | 400 | A declared property uses the name of a built-in record field (`id`, `createdAt`, `updatedAt`, `status`). Only `status` may be re-declared, and only as `{name: "status", path: "/status"}` to control its projections. |
| `message`stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it. |
| `path`string—**OPTIONAL**Location of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). |
| `401`Unauthorized - no usable credentials were supplied.CodeConstantCauseDS-0203UNAUTHENTICATEDNeither a PAM token (auth) nor a request signature was supplied, or the portal session token is missing.Schema — OPTIONALerrors object[] — OPTIONALerrorCode stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections.message stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it.path string — OPTIONALLocation of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). | Code | Constant | Cause | `DS-0203` | UNAUTHENTICATED | Neither a PAM token (`auth`) nor a request `signature` was supplied, or the portal session token is missing. | Schema—**OPTIONAL** | `errors`object[]—**OPTIONAL**errorCode stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections.message stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it.path string — OPTIONALLocation of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). | `errorCode`stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections. | Code | Constant | Status | Meaning | `DS-0000` | INTERNAL_SERVER_ERROR | 500 | Unhandled server error, or a server-side routing configuration problem. | `DS-0002` | BAD_REQUEST | 400 | Required header or query parameter missing, or request input otherwise unusable. | `DS-0003` | INVALID_JSON | 400 | Request body absent, empty, or not valid JSON. | `DS-0004` | VALIDATION_ERROR | 400 | Body, path variable or query parameter failed validation. One error item per violation. | `DS-0005` | INVALID_FILTER | 400 | `filter_fast` / `filter` could not be parsed or validated. | `DS-0006` | INVALID_ARGUMENT | 400 | An argument could not be used - a `sort` field that is not sortable in that request, undecodable `cursor`, malformed JSON Pointer, parameter type mismatch. | `DS-0007` | UNSUPPORTED_CONTENT_TYPE | 415 | Request `Content-Type` not supported. | `DS-0008` | UNEXPECTED_FILTERABLE_FIELD_VALUE | 400 | A declared class property's value does not match its `valueKind`. | `DS-0009` | SERVICE_UNAVAILABLE | 503 | A required dependency is unavailable, or the request could not be forwarded to its region. | `DS-0010` | NOT_ACCEPTABLE | 406 | *Reserved - not currently emitted.* 406 responses carry a `text/plain` body with no error code. | `DS-0011` | METHOD_NOT_ALLOWED | 405 | HTTP method not supported for this path. | Code | Constant | Status | Meaning | `DS-0100` | NOT_FOUND | 404 | The addressed resource does not exist. | Code | Constant | Status | Meaning | `DS-0200` | DATASYNC_NOT_ENABLED | 403 | Datasync is not enabled for this subscribe key. | `DS-0201` | ACCESS_DENIED | 403 | Access Manager not enabled, conflicting credentials supplied, or authorization check denied. | `DS-0202` | INVALID_TOKEN | 403 | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. | `DS-0203` | UNAUTHENTICATED | 401 | No credentials supplied. | Code | Constant | Status | Meaning | `DS-0300` | ETAG_MISMATCH | 412 | `If-Match` does not contain the resource's current ETag. | `DS-0301` | CONFLICT | 409 | A resource with the same identity already exists. | Code | Constant | Status | Meaning | `DS-0400` | CONTENT_TOO_LARGE | 413 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0500` | CUSTOM_NOT_SCALAR | 400 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0600` | CONFIG_NOT_FOUND | 404 | Subscribe key unknown to the configuration service, or its datasync region is not configured. | `DS-0602` | UNSUPPORTED_ENTITY_PROPERTY_TYPE | 400 | A declared property's path resolves to a non-scalar node (object or array). | `DS-0650` | NON_NULLABLE_PROPERTY | 400 | A property declared `nullable: false` is missing or explicitly `null`. | Code | Constant | Status | Meaning | `DS-0700` | IMMUTABLE_FIELD_MODIFICATION | 400 | A patch targets a pointer outside the mutable set. Patch only. | Code | Constant | Status | Meaning | `DS-0800` | WRONG_ENTITY_CLASS_TYPE | 400 | An endpoint entity's class does not satisfy the relationship class for that side. Create only. | `DS-0801` | CARDINALITY_VIOLATED | 409 | ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only. | Code | Constant | Status | Meaning | `DS-0900` | GLOBAL_CLASS_MODIFICATION | 403 | Global class definitions are read-only. Replace and delete only. | `DS-0901` | PROJECTION_LIMIT_EXCEEDED | 400 | Distinct projections across all properties exceed the per-class maximum. | `DS-0902` | INVALID_PROJECTION_NAME | 400 | Projection name too long or malformed, or a property declares an empty projection list. | `DS-0903` | INCOMPATIBLE_CHILD_PROPERTY | 400 | A redeclared inherited property differs from the parent in `path`, `valueKind`, or `nullable`. Entity classes only. | `DS-0904` | MISSING_PARENT_PROPERTY | 400 | *Reserved - not currently emitted.* Missing parent properties are inherited automatically. | `DS-0905` | CLASS_HAS_CHILDREN | 409 | The class still has subclasses and cannot be deleted. Entity classes only. | `DS-0906` | RESERVED_PROPERTY_NAME | 400 | A declared property uses the name of a built-in record field (`id`, `createdAt`, `updatedAt`, `status`). Only `status` may be re-declared, and only as `{name: "status", path: "/status"}` to control its projections. | `message`stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it. | `path`string—**OPTIONAL**Location of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). |
| Code | Constant | Cause |
| `DS-0203` | UNAUTHENTICATED | Neither a PAM token (`auth`) nor a request `signature` was supplied, or the portal session token is missing. |
| Schema—**OPTIONAL** |
| `errors`object[]—**OPTIONAL**errorCode stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections.message stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it.path string — OPTIONALLocation of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). | `errorCode`stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections. | Code | Constant | Status | Meaning | `DS-0000` | INTERNAL_SERVER_ERROR | 500 | Unhandled server error, or a server-side routing configuration problem. | `DS-0002` | BAD_REQUEST | 400 | Required header or query parameter missing, or request input otherwise unusable. | `DS-0003` | INVALID_JSON | 400 | Request body absent, empty, or not valid JSON. | `DS-0004` | VALIDATION_ERROR | 400 | Body, path variable or query parameter failed validation. One error item per violation. | `DS-0005` | INVALID_FILTER | 400 | `filter_fast` / `filter` could not be parsed or validated. | `DS-0006` | INVALID_ARGUMENT | 400 | An argument could not be used - a `sort` field that is not sortable in that request, undecodable `cursor`, malformed JSON Pointer, parameter type mismatch. | `DS-0007` | UNSUPPORTED_CONTENT_TYPE | 415 | Request `Content-Type` not supported. | `DS-0008` | UNEXPECTED_FILTERABLE_FIELD_VALUE | 400 | A declared class property's value does not match its `valueKind`. | `DS-0009` | SERVICE_UNAVAILABLE | 503 | A required dependency is unavailable, or the request could not be forwarded to its region. | `DS-0010` | NOT_ACCEPTABLE | 406 | *Reserved - not currently emitted.* 406 responses carry a `text/plain` body with no error code. | `DS-0011` | METHOD_NOT_ALLOWED | 405 | HTTP method not supported for this path. | Code | Constant | Status | Meaning | `DS-0100` | NOT_FOUND | 404 | The addressed resource does not exist. | Code | Constant | Status | Meaning | `DS-0200` | DATASYNC_NOT_ENABLED | 403 | Datasync is not enabled for this subscribe key. | `DS-0201` | ACCESS_DENIED | 403 | Access Manager not enabled, conflicting credentials supplied, or authorization check denied. | `DS-0202` | INVALID_TOKEN | 403 | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. | `DS-0203` | UNAUTHENTICATED | 401 | No credentials supplied. | Code | Constant | Status | Meaning | `DS-0300` | ETAG_MISMATCH | 412 | `If-Match` does not contain the resource's current ETag. | `DS-0301` | CONFLICT | 409 | A resource with the same identity already exists. | Code | Constant | Status | Meaning | `DS-0400` | CONTENT_TOO_LARGE | 413 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0500` | CUSTOM_NOT_SCALAR | 400 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0600` | CONFIG_NOT_FOUND | 404 | Subscribe key unknown to the configuration service, or its datasync region is not configured. | `DS-0602` | UNSUPPORTED_ENTITY_PROPERTY_TYPE | 400 | A declared property's path resolves to a non-scalar node (object or array). | `DS-0650` | NON_NULLABLE_PROPERTY | 400 | A property declared `nullable: false` is missing or explicitly `null`. | Code | Constant | Status | Meaning | `DS-0700` | IMMUTABLE_FIELD_MODIFICATION | 400 | A patch targets a pointer outside the mutable set. Patch only. | Code | Constant | Status | Meaning | `DS-0800` | WRONG_ENTITY_CLASS_TYPE | 400 | An endpoint entity's class does not satisfy the relationship class for that side. Create only. | `DS-0801` | CARDINALITY_VIOLATED | 409 | ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only. | Code | Constant | Status | Meaning | `DS-0900` | GLOBAL_CLASS_MODIFICATION | 403 | Global class definitions are read-only. Replace and delete only. | `DS-0901` | PROJECTION_LIMIT_EXCEEDED | 400 | Distinct projections across all properties exceed the per-class maximum. | `DS-0902` | INVALID_PROJECTION_NAME | 400 | Projection name too long or malformed, or a property declares an empty projection list. | `DS-0903` | INCOMPATIBLE_CHILD_PROPERTY | 400 | A redeclared inherited property differs from the parent in `path`, `valueKind`, or `nullable`. Entity classes only. | `DS-0904` | MISSING_PARENT_PROPERTY | 400 | *Reserved - not currently emitted.* Missing parent properties are inherited automatically. | `DS-0905` | CLASS_HAS_CHILDREN | 409 | The class still has subclasses and cannot be deleted. Entity classes only. | `DS-0906` | RESERVED_PROPERTY_NAME | 400 | A declared property uses the name of a built-in record field (`id`, `createdAt`, `updatedAt`, `status`). Only `status` may be re-declared, and only as `{name: "status", path: "/status"}` to control its projections. | `message`stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it. | `path`string—**OPTIONAL**Location of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). |
| `errorCode`stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections. | Code | Constant | Status | Meaning | `DS-0000` | INTERNAL_SERVER_ERROR | 500 | Unhandled server error, or a server-side routing configuration problem. | `DS-0002` | BAD_REQUEST | 400 | Required header or query parameter missing, or request input otherwise unusable. | `DS-0003` | INVALID_JSON | 400 | Request body absent, empty, or not valid JSON. | `DS-0004` | VALIDATION_ERROR | 400 | Body, path variable or query parameter failed validation. One error item per violation. | `DS-0005` | INVALID_FILTER | 400 | `filter_fast` / `filter` could not be parsed or validated. | `DS-0006` | INVALID_ARGUMENT | 400 | An argument could not be used - a `sort` field that is not sortable in that request, undecodable `cursor`, malformed JSON Pointer, parameter type mismatch. | `DS-0007` | UNSUPPORTED_CONTENT_TYPE | 415 | Request `Content-Type` not supported. | `DS-0008` | UNEXPECTED_FILTERABLE_FIELD_VALUE | 400 | A declared class property's value does not match its `valueKind`. | `DS-0009` | SERVICE_UNAVAILABLE | 503 | A required dependency is unavailable, or the request could not be forwarded to its region. | `DS-0010` | NOT_ACCEPTABLE | 406 | *Reserved - not currently emitted.* 406 responses carry a `text/plain` body with no error code. | `DS-0011` | METHOD_NOT_ALLOWED | 405 | HTTP method not supported for this path. | Code | Constant | Status | Meaning | `DS-0100` | NOT_FOUND | 404 | The addressed resource does not exist. | Code | Constant | Status | Meaning | `DS-0200` | DATASYNC_NOT_ENABLED | 403 | Datasync is not enabled for this subscribe key. | `DS-0201` | ACCESS_DENIED | 403 | Access Manager not enabled, conflicting credentials supplied, or authorization check denied. | `DS-0202` | INVALID_TOKEN | 403 | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. | `DS-0203` | UNAUTHENTICATED | 401 | No credentials supplied. | Code | Constant | Status | Meaning | `DS-0300` | ETAG_MISMATCH | 412 | `If-Match` does not contain the resource's current ETag. | `DS-0301` | CONFLICT | 409 | A resource with the same identity already exists. | Code | Constant | Status | Meaning | `DS-0400` | CONTENT_TOO_LARGE | 413 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0500` | CUSTOM_NOT_SCALAR | 400 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0600` | CONFIG_NOT_FOUND | 404 | Subscribe key unknown to the configuration service, or its datasync region is not configured. | `DS-0602` | UNSUPPORTED_ENTITY_PROPERTY_TYPE | 400 | A declared property's path resolves to a non-scalar node (object or array). | `DS-0650` | NON_NULLABLE_PROPERTY | 400 | A property declared `nullable: false` is missing or explicitly `null`. | Code | Constant | Status | Meaning | `DS-0700` | IMMUTABLE_FIELD_MODIFICATION | 400 | A patch targets a pointer outside the mutable set. Patch only. | Code | Constant | Status | Meaning | `DS-0800` | WRONG_ENTITY_CLASS_TYPE | 400 | An endpoint entity's class does not satisfy the relationship class for that side. Create only. | `DS-0801` | CARDINALITY_VIOLATED | 409 | ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only. | Code | Constant | Status | Meaning | `DS-0900` | GLOBAL_CLASS_MODIFICATION | 403 | Global class definitions are read-only. Replace and delete only. | `DS-0901` | PROJECTION_LIMIT_EXCEEDED | 400 | Distinct projections across all properties exceed the per-class maximum. | `DS-0902` | INVALID_PROJECTION_NAME | 400 | Projection name too long or malformed, or a property declares an empty projection list. | `DS-0903` | INCOMPATIBLE_CHILD_PROPERTY | 400 | A redeclared inherited property differs from the parent in `path`, `valueKind`, or `nullable`. Entity classes only. | `DS-0904` | MISSING_PARENT_PROPERTY | 400 | *Reserved - not currently emitted.* Missing parent properties are inherited automatically. | `DS-0905` | CLASS_HAS_CHILDREN | 409 | The class still has subclasses and cannot be deleted. Entity classes only. | `DS-0906` | RESERVED_PROPERTY_NAME | 400 | A declared property uses the name of a built-in record field (`id`, `createdAt`, `updatedAt`, `status`). Only `status` may be re-declared, and only as `{name: "status", path: "/status"}` to control its projections. |
| Code | Constant | Status | Meaning |
| `DS-0000` | INTERNAL_SERVER_ERROR | 500 | Unhandled server error, or a server-side routing configuration problem. |
| `DS-0002` | BAD_REQUEST | 400 | Required header or query parameter missing, or request input otherwise unusable. |
| `DS-0003` | INVALID_JSON | 400 | Request body absent, empty, or not valid JSON. |
| `DS-0004` | VALIDATION_ERROR | 400 | Body, path variable or query parameter failed validation. One error item per violation. |
| `DS-0005` | INVALID_FILTER | 400 | `filter_fast` / `filter` could not be parsed or validated. |
| `DS-0006` | INVALID_ARGUMENT | 400 | An argument could not be used - a `sort` field that is not sortable in that request, undecodable `cursor`, malformed JSON Pointer, parameter type mismatch. |
| `DS-0007` | UNSUPPORTED_CONTENT_TYPE | 415 | Request `Content-Type` not supported. |
| `DS-0008` | UNEXPECTED_FILTERABLE_FIELD_VALUE | 400 | A declared class property's value does not match its `valueKind`. |
| `DS-0009` | SERVICE_UNAVAILABLE | 503 | A required dependency is unavailable, or the request could not be forwarded to its region. |
| `DS-0010` | NOT_ACCEPTABLE | 406 | *Reserved - not currently emitted.* 406 responses carry a `text/plain` body with no error code. |
| `DS-0011` | METHOD_NOT_ALLOWED | 405 | HTTP method not supported for this path. |
| Code | Constant | Status | Meaning |
| `DS-0100` | NOT_FOUND | 404 | The addressed resource does not exist. |
| Code | Constant | Status | Meaning |
| `DS-0200` | DATASYNC_NOT_ENABLED | 403 | Datasync is not enabled for this subscribe key. |
| `DS-0201` | ACCESS_DENIED | 403 | Access Manager not enabled, conflicting credentials supplied, or authorization check denied. |
| `DS-0202` | INVALID_TOKEN | 403 | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. |
| `DS-0203` | UNAUTHENTICATED | 401 | No credentials supplied. |
| Code | Constant | Status | Meaning |
| `DS-0300` | ETAG_MISMATCH | 412 | `If-Match` does not contain the resource's current ETag. |
| `DS-0301` | CONFLICT | 409 | A resource with the same identity already exists. |
| Code | Constant | Status | Meaning |
| `DS-0400` | CONTENT_TOO_LARGE | 413 | *Reserved - not currently emitted.* |
| Code | Constant | Status | Meaning |
| `DS-0500` | CUSTOM_NOT_SCALAR | 400 | *Reserved - not currently emitted.* |
| Code | Constant | Status | Meaning |
| `DS-0600` | CONFIG_NOT_FOUND | 404 | Subscribe key unknown to the configuration service, or its datasync region is not configured. |
| `DS-0602` | UNSUPPORTED_ENTITY_PROPERTY_TYPE | 400 | A declared property's path resolves to a non-scalar node (object or array). |
| `DS-0650` | NON_NULLABLE_PROPERTY | 400 | A property declared `nullable: false` is missing or explicitly `null`. |
| Code | Constant | Status | Meaning |
| `DS-0700` | IMMUTABLE_FIELD_MODIFICATION | 400 | A patch targets a pointer outside the mutable set. Patch only. |
| Code | Constant | Status | Meaning |
| `DS-0800` | WRONG_ENTITY_CLASS_TYPE | 400 | An endpoint entity's class does not satisfy the relationship class for that side. Create only. |
| `DS-0801` | CARDINALITY_VIOLATED | 409 | ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only. |
| Code | Constant | Status | Meaning |
| `DS-0900` | GLOBAL_CLASS_MODIFICATION | 403 | Global class definitions are read-only. Replace and delete only. |
| `DS-0901` | PROJECTION_LIMIT_EXCEEDED | 400 | Distinct projections across all properties exceed the per-class maximum. |
| `DS-0902` | INVALID_PROJECTION_NAME | 400 | Projection name too long or malformed, or a property declares an empty projection list. |
| `DS-0903` | INCOMPATIBLE_CHILD_PROPERTY | 400 | A redeclared inherited property differs from the parent in `path`, `valueKind`, or `nullable`. Entity classes only. |
| `DS-0904` | MISSING_PARENT_PROPERTY | 400 | *Reserved - not currently emitted.* Missing parent properties are inherited automatically. |
| `DS-0905` | CLASS_HAS_CHILDREN | 409 | The class still has subclasses and cannot be deleted. Entity classes only. |
| `DS-0906` | RESERVED_PROPERTY_NAME | 400 | A declared property uses the name of a built-in record field (`id`, `createdAt`, `updatedAt`, `status`). Only `status` may be re-declared, and only as `{name: "status", path: "/status"}` to control its projections. |
| `message`stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it. |
| `path`string—**OPTIONAL**Location of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). |
| `403`Forbidden - credentials were recognised but the request is not permitted.CodeConstantCauseDS-0200DATASYNC_NOT_ENABLEDDatasync is not enabled for this subscribe key.DS-0201ACCESS_DENIEDAccess Manager is not enabled for the keyset, auth and signature were both supplied, or the portal authorization check denied the request.DS-0202INVALID_TOKENThe auth PAM token could not be decoded, or its projection does not permit the requested fields.Schema — OPTIONALerrors object[] — OPTIONALerrorCode stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections.message stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it.path string — OPTIONALLocation of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). | Code | Constant | Cause | `DS-0200` | DATASYNC_NOT_ENABLED | Datasync is not enabled for this subscribe key. | `DS-0201` | ACCESS_DENIED | Access Manager is not enabled for the keyset, `auth` and `signature` were both supplied, or the portal authorization check denied the request. | `DS-0202` | INVALID_TOKEN | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. | Schema—**OPTIONAL** | `errors`object[]—**OPTIONAL**errorCode stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections.message stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it.path string — OPTIONALLocation of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). | `errorCode`stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections. | Code | Constant | Status | Meaning | `DS-0000` | INTERNAL_SERVER_ERROR | 500 | Unhandled server error, or a server-side routing configuration problem. | `DS-0002` | BAD_REQUEST | 400 | Required header or query parameter missing, or request input otherwise unusable. | `DS-0003` | INVALID_JSON | 400 | Request body absent, empty, or not valid JSON. | `DS-0004` | VALIDATION_ERROR | 400 | Body, path variable or query parameter failed validation. One error item per violation. | `DS-0005` | INVALID_FILTER | 400 | `filter_fast` / `filter` could not be parsed or validated. | `DS-0006` | INVALID_ARGUMENT | 400 | An argument could not be used - a `sort` field that is not sortable in that request, undecodable `cursor`, malformed JSON Pointer, parameter type mismatch. | `DS-0007` | UNSUPPORTED_CONTENT_TYPE | 415 | Request `Content-Type` not supported. | `DS-0008` | UNEXPECTED_FILTERABLE_FIELD_VALUE | 400 | A declared class property's value does not match its `valueKind`. | `DS-0009` | SERVICE_UNAVAILABLE | 503 | A required dependency is unavailable, or the request could not be forwarded to its region. | `DS-0010` | NOT_ACCEPTABLE | 406 | *Reserved - not currently emitted.* 406 responses carry a `text/plain` body with no error code. | `DS-0011` | METHOD_NOT_ALLOWED | 405 | HTTP method not supported for this path. | Code | Constant | Status | Meaning | `DS-0100` | NOT_FOUND | 404 | The addressed resource does not exist. | Code | Constant | Status | Meaning | `DS-0200` | DATASYNC_NOT_ENABLED | 403 | Datasync is not enabled for this subscribe key. | `DS-0201` | ACCESS_DENIED | 403 | Access Manager not enabled, conflicting credentials supplied, or authorization check denied. | `DS-0202` | INVALID_TOKEN | 403 | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. | `DS-0203` | UNAUTHENTICATED | 401 | No credentials supplied. | Code | Constant | Status | Meaning | `DS-0300` | ETAG_MISMATCH | 412 | `If-Match` does not contain the resource's current ETag. | `DS-0301` | CONFLICT | 409 | A resource with the same identity already exists. | Code | Constant | Status | Meaning | `DS-0400` | CONTENT_TOO_LARGE | 413 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0500` | CUSTOM_NOT_SCALAR | 400 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0600` | CONFIG_NOT_FOUND | 404 | Subscribe key unknown to the configuration service, or its datasync region is not configured. | `DS-0602` | UNSUPPORTED_ENTITY_PROPERTY_TYPE | 400 | A declared property's path resolves to a non-scalar node (object or array). | `DS-0650` | NON_NULLABLE_PROPERTY | 400 | A property declared `nullable: false` is missing or explicitly `null`. | Code | Constant | Status | Meaning | `DS-0700` | IMMUTABLE_FIELD_MODIFICATION | 400 | A patch targets a pointer outside the mutable set. Patch only. | Code | Constant | Status | Meaning | `DS-0800` | WRONG_ENTITY_CLASS_TYPE | 400 | An endpoint entity's class does not satisfy the relationship class for that side. Create only. | `DS-0801` | CARDINALITY_VIOLATED | 409 | ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only. | Code | Constant | Status | Meaning | `DS-0900` | GLOBAL_CLASS_MODIFICATION | 403 | Global class definitions are read-only. Replace and delete only. | `DS-0901` | PROJECTION_LIMIT_EXCEEDED | 400 | Distinct projections across all properties exceed the per-class maximum. | `DS-0902` | INVALID_PROJECTION_NAME | 400 | Projection name too long or malformed, or a property declares an empty projection list. | `DS-0903` | INCOMPATIBLE_CHILD_PROPERTY | 400 | A redeclared inherited property differs from the parent in `path`, `valueKind`, or `nullable`. Entity classes only. | `DS-0904` | MISSING_PARENT_PROPERTY | 400 | *Reserved - not currently emitted.* Missing parent properties are inherited automatically. | `DS-0905` | CLASS_HAS_CHILDREN | 409 | The class still has subclasses and cannot be deleted. Entity classes only. | `DS-0906` | RESERVED_PROPERTY_NAME | 400 | A declared property uses the name of a built-in record field (`id`, `createdAt`, `updatedAt`, `status`). Only `status` may be re-declared, and only as `{name: "status", path: "/status"}` to control its projections. | `message`stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it. | `path`string—**OPTIONAL**Location of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). |
| Code | Constant | Cause |
| `DS-0200` | DATASYNC_NOT_ENABLED | Datasync is not enabled for this subscribe key. |
| `DS-0201` | ACCESS_DENIED | Access Manager is not enabled for the keyset, `auth` and `signature` were both supplied, or the portal authorization check denied the request. |
| `DS-0202` | INVALID_TOKEN | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. |
| Schema—**OPTIONAL** |
| `errors`object[]—**OPTIONAL**errorCode stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections.message stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it.path string — OPTIONALLocation of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). | `errorCode`stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections. | Code | Constant | Status | Meaning | `DS-0000` | INTERNAL_SERVER_ERROR | 500 | Unhandled server error, or a server-side routing configuration problem. | `DS-0002` | BAD_REQUEST | 400 | Required header or query parameter missing, or request input otherwise unusable. | `DS-0003` | INVALID_JSON | 400 | Request body absent, empty, or not valid JSON. | `DS-0004` | VALIDATION_ERROR | 400 | Body, path variable or query parameter failed validation. One error item per violation. | `DS-0005` | INVALID_FILTER | 400 | `filter_fast` / `filter` could not be parsed or validated. | `DS-0006` | INVALID_ARGUMENT | 400 | An argument could not be used - a `sort` field that is not sortable in that request, undecodable `cursor`, malformed JSON Pointer, parameter type mismatch. | `DS-0007` | UNSUPPORTED_CONTENT_TYPE | 415 | Request `Content-Type` not supported. | `DS-0008` | UNEXPECTED_FILTERABLE_FIELD_VALUE | 400 | A declared class property's value does not match its `valueKind`. | `DS-0009` | SERVICE_UNAVAILABLE | 503 | A required dependency is unavailable, or the request could not be forwarded to its region. | `DS-0010` | NOT_ACCEPTABLE | 406 | *Reserved - not currently emitted.* 406 responses carry a `text/plain` body with no error code. | `DS-0011` | METHOD_NOT_ALLOWED | 405 | HTTP method not supported for this path. | Code | Constant | Status | Meaning | `DS-0100` | NOT_FOUND | 404 | The addressed resource does not exist. | Code | Constant | Status | Meaning | `DS-0200` | DATASYNC_NOT_ENABLED | 403 | Datasync is not enabled for this subscribe key. | `DS-0201` | ACCESS_DENIED | 403 | Access Manager not enabled, conflicting credentials supplied, or authorization check denied. | `DS-0202` | INVALID_TOKEN | 403 | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. | `DS-0203` | UNAUTHENTICATED | 401 | No credentials supplied. | Code | Constant | Status | Meaning | `DS-0300` | ETAG_MISMATCH | 412 | `If-Match` does not contain the resource's current ETag. | `DS-0301` | CONFLICT | 409 | A resource with the same identity already exists. | Code | Constant | Status | Meaning | `DS-0400` | CONTENT_TOO_LARGE | 413 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0500` | CUSTOM_NOT_SCALAR | 400 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0600` | CONFIG_NOT_FOUND | 404 | Subscribe key unknown to the configuration service, or its datasync region is not configured. | `DS-0602` | UNSUPPORTED_ENTITY_PROPERTY_TYPE | 400 | A declared property's path resolves to a non-scalar node (object or array). | `DS-0650` | NON_NULLABLE_PROPERTY | 400 | A property declared `nullable: false` is missing or explicitly `null`. | Code | Constant | Status | Meaning | `DS-0700` | IMMUTABLE_FIELD_MODIFICATION | 400 | A patch targets a pointer outside the mutable set. Patch only. | Code | Constant | Status | Meaning | `DS-0800` | WRONG_ENTITY_CLASS_TYPE | 400 | An endpoint entity's class does not satisfy the relationship class for that side. Create only. | `DS-0801` | CARDINALITY_VIOLATED | 409 | ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only. | Code | Constant | Status | Meaning | `DS-0900` | GLOBAL_CLASS_MODIFICATION | 403 | Global class definitions are read-only. Replace and delete only. | `DS-0901` | PROJECTION_LIMIT_EXCEEDED | 400 | Distinct projections across all properties exceed the per-class maximum. | `DS-0902` | INVALID_PROJECTION_NAME | 400 | Projection name too long or malformed, or a property declares an empty projection list. | `DS-0903` | INCOMPATIBLE_CHILD_PROPERTY | 400 | A redeclared inherited property differs from the parent in `path`, `valueKind`, or `nullable`. Entity classes only. | `DS-0904` | MISSING_PARENT_PROPERTY | 400 | *Reserved - not currently emitted.* Missing parent properties are inherited automatically. | `DS-0905` | CLASS_HAS_CHILDREN | 409 | The class still has subclasses and cannot be deleted. Entity classes only. | `DS-0906` | RESERVED_PROPERTY_NAME | 400 | A declared property uses the name of a built-in record field (`id`, `createdAt`, `updatedAt`, `status`). Only `status` may be re-declared, and only as `{name: "status", path: "/status"}` to control its projections. | `message`stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it. | `path`string—**OPTIONAL**Location of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). |
| `errorCode`stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections. | Code | Constant | Status | Meaning | `DS-0000` | INTERNAL_SERVER_ERROR | 500 | Unhandled server error, or a server-side routing configuration problem. | `DS-0002` | BAD_REQUEST | 400 | Required header or query parameter missing, or request input otherwise unusable. | `DS-0003` | INVALID_JSON | 400 | Request body absent, empty, or not valid JSON. | `DS-0004` | VALIDATION_ERROR | 400 | Body, path variable or query parameter failed validation. One error item per violation. | `DS-0005` | INVALID_FILTER | 400 | `filter_fast` / `filter` could not be parsed or validated. | `DS-0006` | INVALID_ARGUMENT | 400 | An argument could not be used - a `sort` field that is not sortable in that request, undecodable `cursor`, malformed JSON Pointer, parameter type mismatch. | `DS-0007` | UNSUPPORTED_CONTENT_TYPE | 415 | Request `Content-Type` not supported. | `DS-0008` | UNEXPECTED_FILTERABLE_FIELD_VALUE | 400 | A declared class property's value does not match its `valueKind`. | `DS-0009` | SERVICE_UNAVAILABLE | 503 | A required dependency is unavailable, or the request could not be forwarded to its region. | `DS-0010` | NOT_ACCEPTABLE | 406 | *Reserved - not currently emitted.* 406 responses carry a `text/plain` body with no error code. | `DS-0011` | METHOD_NOT_ALLOWED | 405 | HTTP method not supported for this path. | Code | Constant | Status | Meaning | `DS-0100` | NOT_FOUND | 404 | The addressed resource does not exist. | Code | Constant | Status | Meaning | `DS-0200` | DATASYNC_NOT_ENABLED | 403 | Datasync is not enabled for this subscribe key. | `DS-0201` | ACCESS_DENIED | 403 | Access Manager not enabled, conflicting credentials supplied, or authorization check denied. | `DS-0202` | INVALID_TOKEN | 403 | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. | `DS-0203` | UNAUTHENTICATED | 401 | No credentials supplied. | Code | Constant | Status | Meaning | `DS-0300` | ETAG_MISMATCH | 412 | `If-Match` does not contain the resource's current ETag. | `DS-0301` | CONFLICT | 409 | A resource with the same identity already exists. | Code | Constant | Status | Meaning | `DS-0400` | CONTENT_TOO_LARGE | 413 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0500` | CUSTOM_NOT_SCALAR | 400 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0600` | CONFIG_NOT_FOUND | 404 | Subscribe key unknown to the configuration service, or its datasync region is not configured. | `DS-0602` | UNSUPPORTED_ENTITY_PROPERTY_TYPE | 400 | A declared property's path resolves to a non-scalar node (object or array). | `DS-0650` | NON_NULLABLE_PROPERTY | 400 | A property declared `nullable: false` is missing or explicitly `null`. | Code | Constant | Status | Meaning | `DS-0700` | IMMUTABLE_FIELD_MODIFICATION | 400 | A patch targets a pointer outside the mutable set. Patch only. | Code | Constant | Status | Meaning | `DS-0800` | WRONG_ENTITY_CLASS_TYPE | 400 | An endpoint entity's class does not satisfy the relationship class for that side. Create only. | `DS-0801` | CARDINALITY_VIOLATED | 409 | ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only. | Code | Constant | Status | Meaning | `DS-0900` | GLOBAL_CLASS_MODIFICATION | 403 | Global class definitions are read-only. Replace and delete only. | `DS-0901` | PROJECTION_LIMIT_EXCEEDED | 400 | Distinct projections across all properties exceed the per-class maximum. | `DS-0902` | INVALID_PROJECTION_NAME | 400 | Projection name too long or malformed, or a property declares an empty projection list. | `DS-0903` | INCOMPATIBLE_CHILD_PROPERTY | 400 | A redeclared inherited property differs from the parent in `path`, `valueKind`, or `nullable`. Entity classes only. | `DS-0904` | MISSING_PARENT_PROPERTY | 400 | *Reserved - not currently emitted.* Missing parent properties are inherited automatically. | `DS-0905` | CLASS_HAS_CHILDREN | 409 | The class still has subclasses and cannot be deleted. Entity classes only. | `DS-0906` | RESERVED_PROPERTY_NAME | 400 | A declared property uses the name of a built-in record field (`id`, `createdAt`, `updatedAt`, `status`). Only `status` may be re-declared, and only as `{name: "status", path: "/status"}` to control its projections. |
| Code | Constant | Status | Meaning |
| `DS-0000` | INTERNAL_SERVER_ERROR | 500 | Unhandled server error, or a server-side routing configuration problem. |
| `DS-0002` | BAD_REQUEST | 400 | Required header or query parameter missing, or request input otherwise unusable. |
| `DS-0003` | INVALID_JSON | 400 | Request body absent, empty, or not valid JSON. |
| `DS-0004` | VALIDATION_ERROR | 400 | Body, path variable or query parameter failed validation. One error item per violation. |
| `DS-0005` | INVALID_FILTER | 400 | `filter_fast` / `filter` could not be parsed or validated. |
| `DS-0006` | INVALID_ARGUMENT | 400 | An argument could not be used - a `sort` field that is not sortable in that request, undecodable `cursor`, malformed JSON Pointer, parameter type mismatch. |
| `DS-0007` | UNSUPPORTED_CONTENT_TYPE | 415 | Request `Content-Type` not supported. |
| `DS-0008` | UNEXPECTED_FILTERABLE_FIELD_VALUE | 400 | A declared class property's value does not match its `valueKind`. |
| `DS-0009` | SERVICE_UNAVAILABLE | 503 | A required dependency is unavailable, or the request could not be forwarded to its region. |
| `DS-0010` | NOT_ACCEPTABLE | 406 | *Reserved - not currently emitted.* 406 responses carry a `text/plain` body with no error code. |
| `DS-0011` | METHOD_NOT_ALLOWED | 405 | HTTP method not supported for this path. |
| Code | Constant | Status | Meaning |
| `DS-0100` | NOT_FOUND | 404 | The addressed resource does not exist. |
| Code | Constant | Status | Meaning |
| `DS-0200` | DATASYNC_NOT_ENABLED | 403 | Datasync is not enabled for this subscribe key. |
| `DS-0201` | ACCESS_DENIED | 403 | Access Manager not enabled, conflicting credentials supplied, or authorization check denied. |
| `DS-0202` | INVALID_TOKEN | 403 | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. |
| `DS-0203` | UNAUTHENTICATED | 401 | No credentials supplied. |
| Code | Constant | Status | Meaning |
| `DS-0300` | ETAG_MISMATCH | 412 | `If-Match` does not contain the resource's current ETag. |
| `DS-0301` | CONFLICT | 409 | A resource with the same identity already exists. |
| Code | Constant | Status | Meaning |
| `DS-0400` | CONTENT_TOO_LARGE | 413 | *Reserved - not currently emitted.* |
| Code | Constant | Status | Meaning |
| `DS-0500` | CUSTOM_NOT_SCALAR | 400 | *Reserved - not currently emitted.* |
| Code | Constant | Status | Meaning |
| `DS-0600` | CONFIG_NOT_FOUND | 404 | Subscribe key unknown to the configuration service, or its datasync region is not configured. |
| `DS-0602` | UNSUPPORTED_ENTITY_PROPERTY_TYPE | 400 | A declared property's path resolves to a non-scalar node (object or array). |
| `DS-0650` | NON_NULLABLE_PROPERTY | 400 | A property declared `nullable: false` is missing or explicitly `null`. |
| Code | Constant | Status | Meaning |
| `DS-0700` | IMMUTABLE_FIELD_MODIFICATION | 400 | A patch targets a pointer outside the mutable set. Patch only. |
| Code | Constant | Status | Meaning |
| `DS-0800` | WRONG_ENTITY_CLASS_TYPE | 400 | An endpoint entity's class does not satisfy the relationship class for that side. Create only. |
| `DS-0801` | CARDINALITY_VIOLATED | 409 | ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only. |
| Code | Constant | Status | Meaning |
| `DS-0900` | GLOBAL_CLASS_MODIFICATION | 403 | Global class definitions are read-only. Replace and delete only. |
| `DS-0901` | PROJECTION_LIMIT_EXCEEDED | 400 | Distinct projections across all properties exceed the per-class maximum. |
| `DS-0902` | INVALID_PROJECTION_NAME | 400 | Projection name too long or malformed, or a property declares an empty projection list. |
| `DS-0903` | INCOMPATIBLE_CHILD_PROPERTY | 400 | A redeclared inherited property differs from the parent in `path`, `valueKind`, or `nullable`. Entity classes only. |
| `DS-0904` | MISSING_PARENT_PROPERTY | 400 | *Reserved - not currently emitted.* Missing parent properties are inherited automatically. |
| `DS-0905` | CLASS_HAS_CHILDREN | 409 | The class still has subclasses and cannot be deleted. Entity classes only. |
| `DS-0906` | RESERVED_PROPERTY_NAME | 400 | A declared property uses the name of a built-in record field (`id`, `createdAt`, `updatedAt`, `status`). Only `status` may be re-declared, and only as `{name: "status", path: "/status"}` to control its projections. |
| `message`stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it. |
| `path`string—**OPTIONAL**Location of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). |
| `406`Not Acceptable - the Accept header does not contain a supported value.This response carries a text/plain body and no error code.Schema — OPTIONAL string | Schema—**OPTIONAL** | string |
| Schema—**OPTIONAL** |
| string |
| `429`Too Many Requests - rate limit exceeded.Rate limiting is applied by the edge in front of this service; the service itself defines no error code for this status. Clients should not rely on an error code being present.Schema — OPTIONALerrors object[] — OPTIONALerrorCode stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections.message stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it.path string — OPTIONALLocation of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). | Schema—**OPTIONAL** | `errors`object[]—**OPTIONAL**errorCode stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections.message stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it.path string — OPTIONALLocation of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). | `errorCode`stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections. | Code | Constant | Status | Meaning | `DS-0000` | INTERNAL_SERVER_ERROR | 500 | Unhandled server error, or a server-side routing configuration problem. | `DS-0002` | BAD_REQUEST | 400 | Required header or query parameter missing, or request input otherwise unusable. | `DS-0003` | INVALID_JSON | 400 | Request body absent, empty, or not valid JSON. | `DS-0004` | VALIDATION_ERROR | 400 | Body, path variable or query parameter failed validation. One error item per violation. | `DS-0005` | INVALID_FILTER | 400 | `filter_fast` / `filter` could not be parsed or validated. | `DS-0006` | INVALID_ARGUMENT | 400 | An argument could not be used - a `sort` field that is not sortable in that request, undecodable `cursor`, malformed JSON Pointer, parameter type mismatch. | `DS-0007` | UNSUPPORTED_CONTENT_TYPE | 415 | Request `Content-Type` not supported. | `DS-0008` | UNEXPECTED_FILTERABLE_FIELD_VALUE | 400 | A declared class property's value does not match its `valueKind`. | `DS-0009` | SERVICE_UNAVAILABLE | 503 | A required dependency is unavailable, or the request could not be forwarded to its region. | `DS-0010` | NOT_ACCEPTABLE | 406 | *Reserved - not currently emitted.* 406 responses carry a `text/plain` body with no error code. | `DS-0011` | METHOD_NOT_ALLOWED | 405 | HTTP method not supported for this path. | Code | Constant | Status | Meaning | `DS-0100` | NOT_FOUND | 404 | The addressed resource does not exist. | Code | Constant | Status | Meaning | `DS-0200` | DATASYNC_NOT_ENABLED | 403 | Datasync is not enabled for this subscribe key. | `DS-0201` | ACCESS_DENIED | 403 | Access Manager not enabled, conflicting credentials supplied, or authorization check denied. | `DS-0202` | INVALID_TOKEN | 403 | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. | `DS-0203` | UNAUTHENTICATED | 401 | No credentials supplied. | Code | Constant | Status | Meaning | `DS-0300` | ETAG_MISMATCH | 412 | `If-Match` does not contain the resource's current ETag. | `DS-0301` | CONFLICT | 409 | A resource with the same identity already exists. | Code | Constant | Status | Meaning | `DS-0400` | CONTENT_TOO_LARGE | 413 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0500` | CUSTOM_NOT_SCALAR | 400 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0600` | CONFIG_NOT_FOUND | 404 | Subscribe key unknown to the configuration service, or its datasync region is not configured. | `DS-0602` | UNSUPPORTED_ENTITY_PROPERTY_TYPE | 400 | A declared property's path resolves to a non-scalar node (object or array). | `DS-0650` | NON_NULLABLE_PROPERTY | 400 | A property declared `nullable: false` is missing or explicitly `null`. | Code | Constant | Status | Meaning | `DS-0700` | IMMUTABLE_FIELD_MODIFICATION | 400 | A patch targets a pointer outside the mutable set. Patch only. | Code | Constant | Status | Meaning | `DS-0800` | WRONG_ENTITY_CLASS_TYPE | 400 | An endpoint entity's class does not satisfy the relationship class for that side. Create only. | `DS-0801` | CARDINALITY_VIOLATED | 409 | ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only. | Code | Constant | Status | Meaning | `DS-0900` | GLOBAL_CLASS_MODIFICATION | 403 | Global class definitions are read-only. Replace and delete only. | `DS-0901` | PROJECTION_LIMIT_EXCEEDED | 400 | Distinct projections across all properties exceed the per-class maximum. | `DS-0902` | INVALID_PROJECTION_NAME | 400 | Projection name too long or malformed, or a property declares an empty projection list. | `DS-0903` | INCOMPATIBLE_CHILD_PROPERTY | 400 | A redeclared inherited property differs from the parent in `path`, `valueKind`, or `nullable`. Entity classes only. | `DS-0904` | MISSING_PARENT_PROPERTY | 400 | *Reserved - not currently emitted.* Missing parent properties are inherited automatically. | `DS-0905` | CLASS_HAS_CHILDREN | 409 | The class still has subclasses and cannot be deleted. Entity classes only. | `DS-0906` | RESERVED_PROPERTY_NAME | 400 | A declared property uses the name of a built-in record field (`id`, `createdAt`, `updatedAt`, `status`). Only `status` may be re-declared, and only as `{name: "status", path: "/status"}` to control its projections. | `message`stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it. | `path`string—**OPTIONAL**Location of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). |
| Schema—**OPTIONAL** |
| `errors`object[]—**OPTIONAL**errorCode stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections.message stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it.path string — OPTIONALLocation of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). | `errorCode`stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections. | Code | Constant | Status | Meaning | `DS-0000` | INTERNAL_SERVER_ERROR | 500 | Unhandled server error, or a server-side routing configuration problem. | `DS-0002` | BAD_REQUEST | 400 | Required header or query parameter missing, or request input otherwise unusable. | `DS-0003` | INVALID_JSON | 400 | Request body absent, empty, or not valid JSON. | `DS-0004` | VALIDATION_ERROR | 400 | Body, path variable or query parameter failed validation. One error item per violation. | `DS-0005` | INVALID_FILTER | 400 | `filter_fast` / `filter` could not be parsed or validated. | `DS-0006` | INVALID_ARGUMENT | 400 | An argument could not be used - a `sort` field that is not sortable in that request, undecodable `cursor`, malformed JSON Pointer, parameter type mismatch. | `DS-0007` | UNSUPPORTED_CONTENT_TYPE | 415 | Request `Content-Type` not supported. | `DS-0008` | UNEXPECTED_FILTERABLE_FIELD_VALUE | 400 | A declared class property's value does not match its `valueKind`. | `DS-0009` | SERVICE_UNAVAILABLE | 503 | A required dependency is unavailable, or the request could not be forwarded to its region. | `DS-0010` | NOT_ACCEPTABLE | 406 | *Reserved - not currently emitted.* 406 responses carry a `text/plain` body with no error code. | `DS-0011` | METHOD_NOT_ALLOWED | 405 | HTTP method not supported for this path. | Code | Constant | Status | Meaning | `DS-0100` | NOT_FOUND | 404 | The addressed resource does not exist. | Code | Constant | Status | Meaning | `DS-0200` | DATASYNC_NOT_ENABLED | 403 | Datasync is not enabled for this subscribe key. | `DS-0201` | ACCESS_DENIED | 403 | Access Manager not enabled, conflicting credentials supplied, or authorization check denied. | `DS-0202` | INVALID_TOKEN | 403 | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. | `DS-0203` | UNAUTHENTICATED | 401 | No credentials supplied. | Code | Constant | Status | Meaning | `DS-0300` | ETAG_MISMATCH | 412 | `If-Match` does not contain the resource's current ETag. | `DS-0301` | CONFLICT | 409 | A resource with the same identity already exists. | Code | Constant | Status | Meaning | `DS-0400` | CONTENT_TOO_LARGE | 413 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0500` | CUSTOM_NOT_SCALAR | 400 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0600` | CONFIG_NOT_FOUND | 404 | Subscribe key unknown to the configuration service, or its datasync region is not configured. | `DS-0602` | UNSUPPORTED_ENTITY_PROPERTY_TYPE | 400 | A declared property's path resolves to a non-scalar node (object or array). | `DS-0650` | NON_NULLABLE_PROPERTY | 400 | A property declared `nullable: false` is missing or explicitly `null`. | Code | Constant | Status | Meaning | `DS-0700` | IMMUTABLE_FIELD_MODIFICATION | 400 | A patch targets a pointer outside the mutable set. Patch only. | Code | Constant | Status | Meaning | `DS-0800` | WRONG_ENTITY_CLASS_TYPE | 400 | An endpoint entity's class does not satisfy the relationship class for that side. Create only. | `DS-0801` | CARDINALITY_VIOLATED | 409 | ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only. | Code | Constant | Status | Meaning | `DS-0900` | GLOBAL_CLASS_MODIFICATION | 403 | Global class definitions are read-only. Replace and delete only. | `DS-0901` | PROJECTION_LIMIT_EXCEEDED | 400 | Distinct projections across all properties exceed the per-class maximum. | `DS-0902` | INVALID_PROJECTION_NAME | 400 | Projection name too long or malformed, or a property declares an empty projection list. | `DS-0903` | INCOMPATIBLE_CHILD_PROPERTY | 400 | A redeclared inherited property differs from the parent in `path`, `valueKind`, or `nullable`. Entity classes only. | `DS-0904` | MISSING_PARENT_PROPERTY | 400 | *Reserved - not currently emitted.* Missing parent properties are inherited automatically. | `DS-0905` | CLASS_HAS_CHILDREN | 409 | The class still has subclasses and cannot be deleted. Entity classes only. | `DS-0906` | RESERVED_PROPERTY_NAME | 400 | A declared property uses the name of a built-in record field (`id`, `createdAt`, `updatedAt`, `status`). Only `status` may be re-declared, and only as `{name: "status", path: "/status"}` to control its projections. | `message`stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it. | `path`string—**OPTIONAL**Location of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). |
| `errorCode`stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections. | Code | Constant | Status | Meaning | `DS-0000` | INTERNAL_SERVER_ERROR | 500 | Unhandled server error, or a server-side routing configuration problem. | `DS-0002` | BAD_REQUEST | 400 | Required header or query parameter missing, or request input otherwise unusable. | `DS-0003` | INVALID_JSON | 400 | Request body absent, empty, or not valid JSON. | `DS-0004` | VALIDATION_ERROR | 400 | Body, path variable or query parameter failed validation. One error item per violation. | `DS-0005` | INVALID_FILTER | 400 | `filter_fast` / `filter` could not be parsed or validated. | `DS-0006` | INVALID_ARGUMENT | 400 | An argument could not be used - a `sort` field that is not sortable in that request, undecodable `cursor`, malformed JSON Pointer, parameter type mismatch. | `DS-0007` | UNSUPPORTED_CONTENT_TYPE | 415 | Request `Content-Type` not supported. | `DS-0008` | UNEXPECTED_FILTERABLE_FIELD_VALUE | 400 | A declared class property's value does not match its `valueKind`. | `DS-0009` | SERVICE_UNAVAILABLE | 503 | A required dependency is unavailable, or the request could not be forwarded to its region. | `DS-0010` | NOT_ACCEPTABLE | 406 | *Reserved - not currently emitted.* 406 responses carry a `text/plain` body with no error code. | `DS-0011` | METHOD_NOT_ALLOWED | 405 | HTTP method not supported for this path. | Code | Constant | Status | Meaning | `DS-0100` | NOT_FOUND | 404 | The addressed resource does not exist. | Code | Constant | Status | Meaning | `DS-0200` | DATASYNC_NOT_ENABLED | 403 | Datasync is not enabled for this subscribe key. | `DS-0201` | ACCESS_DENIED | 403 | Access Manager not enabled, conflicting credentials supplied, or authorization check denied. | `DS-0202` | INVALID_TOKEN | 403 | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. | `DS-0203` | UNAUTHENTICATED | 401 | No credentials supplied. | Code | Constant | Status | Meaning | `DS-0300` | ETAG_MISMATCH | 412 | `If-Match` does not contain the resource's current ETag. | `DS-0301` | CONFLICT | 409 | A resource with the same identity already exists. | Code | Constant | Status | Meaning | `DS-0400` | CONTENT_TOO_LARGE | 413 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0500` | CUSTOM_NOT_SCALAR | 400 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0600` | CONFIG_NOT_FOUND | 404 | Subscribe key unknown to the configuration service, or its datasync region is not configured. | `DS-0602` | UNSUPPORTED_ENTITY_PROPERTY_TYPE | 400 | A declared property's path resolves to a non-scalar node (object or array). | `DS-0650` | NON_NULLABLE_PROPERTY | 400 | A property declared `nullable: false` is missing or explicitly `null`. | Code | Constant | Status | Meaning | `DS-0700` | IMMUTABLE_FIELD_MODIFICATION | 400 | A patch targets a pointer outside the mutable set. Patch only. | Code | Constant | Status | Meaning | `DS-0800` | WRONG_ENTITY_CLASS_TYPE | 400 | An endpoint entity's class does not satisfy the relationship class for that side. Create only. | `DS-0801` | CARDINALITY_VIOLATED | 409 | ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only. | Code | Constant | Status | Meaning | `DS-0900` | GLOBAL_CLASS_MODIFICATION | 403 | Global class definitions are read-only. Replace and delete only. | `DS-0901` | PROJECTION_LIMIT_EXCEEDED | 400 | Distinct projections across all properties exceed the per-class maximum. | `DS-0902` | INVALID_PROJECTION_NAME | 400 | Projection name too long or malformed, or a property declares an empty projection list. | `DS-0903` | INCOMPATIBLE_CHILD_PROPERTY | 400 | A redeclared inherited property differs from the parent in `path`, `valueKind`, or `nullable`. Entity classes only. | `DS-0904` | MISSING_PARENT_PROPERTY | 400 | *Reserved - not currently emitted.* Missing parent properties are inherited automatically. | `DS-0905` | CLASS_HAS_CHILDREN | 409 | The class still has subclasses and cannot be deleted. Entity classes only. | `DS-0906` | RESERVED_PROPERTY_NAME | 400 | A declared property uses the name of a built-in record field (`id`, `createdAt`, `updatedAt`, `status`). Only `status` may be re-declared, and only as `{name: "status", path: "/status"}` to control its projections. |
| Code | Constant | Status | Meaning |
| `DS-0000` | INTERNAL_SERVER_ERROR | 500 | Unhandled server error, or a server-side routing configuration problem. |
| `DS-0002` | BAD_REQUEST | 400 | Required header or query parameter missing, or request input otherwise unusable. |
| `DS-0003` | INVALID_JSON | 400 | Request body absent, empty, or not valid JSON. |
| `DS-0004` | VALIDATION_ERROR | 400 | Body, path variable or query parameter failed validation. One error item per violation. |
| `DS-0005` | INVALID_FILTER | 400 | `filter_fast` / `filter` could not be parsed or validated. |
| `DS-0006` | INVALID_ARGUMENT | 400 | An argument could not be used - a `sort` field that is not sortable in that request, undecodable `cursor`, malformed JSON Pointer, parameter type mismatch. |
| `DS-0007` | UNSUPPORTED_CONTENT_TYPE | 415 | Request `Content-Type` not supported. |
| `DS-0008` | UNEXPECTED_FILTERABLE_FIELD_VALUE | 400 | A declared class property's value does not match its `valueKind`. |
| `DS-0009` | SERVICE_UNAVAILABLE | 503 | A required dependency is unavailable, or the request could not be forwarded to its region. |
| `DS-0010` | NOT_ACCEPTABLE | 406 | *Reserved - not currently emitted.* 406 responses carry a `text/plain` body with no error code. |
| `DS-0011` | METHOD_NOT_ALLOWED | 405 | HTTP method not supported for this path. |
| Code | Constant | Status | Meaning |
| `DS-0100` | NOT_FOUND | 404 | The addressed resource does not exist. |
| Code | Constant | Status | Meaning |
| `DS-0200` | DATASYNC_NOT_ENABLED | 403 | Datasync is not enabled for this subscribe key. |
| `DS-0201` | ACCESS_DENIED | 403 | Access Manager not enabled, conflicting credentials supplied, or authorization check denied. |
| `DS-0202` | INVALID_TOKEN | 403 | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. |
| `DS-0203` | UNAUTHENTICATED | 401 | No credentials supplied. |
| Code | Constant | Status | Meaning |
| `DS-0300` | ETAG_MISMATCH | 412 | `If-Match` does not contain the resource's current ETag. |
| `DS-0301` | CONFLICT | 409 | A resource with the same identity already exists. |
| Code | Constant | Status | Meaning |
| `DS-0400` | CONTENT_TOO_LARGE | 413 | *Reserved - not currently emitted.* |
| Code | Constant | Status | Meaning |
| `DS-0500` | CUSTOM_NOT_SCALAR | 400 | *Reserved - not currently emitted.* |
| Code | Constant | Status | Meaning |
| `DS-0600` | CONFIG_NOT_FOUND | 404 | Subscribe key unknown to the configuration service, or its datasync region is not configured. |
| `DS-0602` | UNSUPPORTED_ENTITY_PROPERTY_TYPE | 400 | A declared property's path resolves to a non-scalar node (object or array). |
| `DS-0650` | NON_NULLABLE_PROPERTY | 400 | A property declared `nullable: false` is missing or explicitly `null`. |
| Code | Constant | Status | Meaning |
| `DS-0700` | IMMUTABLE_FIELD_MODIFICATION | 400 | A patch targets a pointer outside the mutable set. Patch only. |
| Code | Constant | Status | Meaning |
| `DS-0800` | WRONG_ENTITY_CLASS_TYPE | 400 | An endpoint entity's class does not satisfy the relationship class for that side. Create only. |
| `DS-0801` | CARDINALITY_VIOLATED | 409 | ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only. |
| Code | Constant | Status | Meaning |
| `DS-0900` | GLOBAL_CLASS_MODIFICATION | 403 | Global class definitions are read-only. Replace and delete only. |
| `DS-0901` | PROJECTION_LIMIT_EXCEEDED | 400 | Distinct projections across all properties exceed the per-class maximum. |
| `DS-0902` | INVALID_PROJECTION_NAME | 400 | Projection name too long or malformed, or a property declares an empty projection list. |
| `DS-0903` | INCOMPATIBLE_CHILD_PROPERTY | 400 | A redeclared inherited property differs from the parent in `path`, `valueKind`, or `nullable`. Entity classes only. |
| `DS-0904` | MISSING_PARENT_PROPERTY | 400 | *Reserved - not currently emitted.* Missing parent properties are inherited automatically. |
| `DS-0905` | CLASS_HAS_CHILDREN | 409 | The class still has subclasses and cannot be deleted. Entity classes only. |
| `DS-0906` | RESERVED_PROPERTY_NAME | 400 | A declared property uses the name of a built-in record field (`id`, `createdAt`, `updatedAt`, `status`). Only `status` may be re-declared, and only as `{name: "status", path: "/status"}` to control its projections. |
| `message`stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it. |
| `path`string—**OPTIONAL**Location of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). |
| `500`Internal server error.CodeConstantCauseDS-0000INTERNAL_SERVER_ERRORAn unhandled error occurred, or the request could not be routed because of a server-side configuration problem.Schema — OPTIONALerrors object[] — OPTIONALerrorCode stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections.message stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it.path string — OPTIONALLocation of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). | Code | Constant | Cause | `DS-0000` | INTERNAL_SERVER_ERROR | An unhandled error occurred, or the request could not be routed because of a server-side configuration problem. | Schema—**OPTIONAL** | `errors`object[]—**OPTIONAL**errorCode stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections.message stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it.path string — OPTIONALLocation of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). | `errorCode`stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections. | Code | Constant | Status | Meaning | `DS-0000` | INTERNAL_SERVER_ERROR | 500 | Unhandled server error, or a server-side routing configuration problem. | `DS-0002` | BAD_REQUEST | 400 | Required header or query parameter missing, or request input otherwise unusable. | `DS-0003` | INVALID_JSON | 400 | Request body absent, empty, or not valid JSON. | `DS-0004` | VALIDATION_ERROR | 400 | Body, path variable or query parameter failed validation. One error item per violation. | `DS-0005` | INVALID_FILTER | 400 | `filter_fast` / `filter` could not be parsed or validated. | `DS-0006` | INVALID_ARGUMENT | 400 | An argument could not be used - a `sort` field that is not sortable in that request, undecodable `cursor`, malformed JSON Pointer, parameter type mismatch. | `DS-0007` | UNSUPPORTED_CONTENT_TYPE | 415 | Request `Content-Type` not supported. | `DS-0008` | UNEXPECTED_FILTERABLE_FIELD_VALUE | 400 | A declared class property's value does not match its `valueKind`. | `DS-0009` | SERVICE_UNAVAILABLE | 503 | A required dependency is unavailable, or the request could not be forwarded to its region. | `DS-0010` | NOT_ACCEPTABLE | 406 | *Reserved - not currently emitted.* 406 responses carry a `text/plain` body with no error code. | `DS-0011` | METHOD_NOT_ALLOWED | 405 | HTTP method not supported for this path. | Code | Constant | Status | Meaning | `DS-0100` | NOT_FOUND | 404 | The addressed resource does not exist. | Code | Constant | Status | Meaning | `DS-0200` | DATASYNC_NOT_ENABLED | 403 | Datasync is not enabled for this subscribe key. | `DS-0201` | ACCESS_DENIED | 403 | Access Manager not enabled, conflicting credentials supplied, or authorization check denied. | `DS-0202` | INVALID_TOKEN | 403 | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. | `DS-0203` | UNAUTHENTICATED | 401 | No credentials supplied. | Code | Constant | Status | Meaning | `DS-0300` | ETAG_MISMATCH | 412 | `If-Match` does not contain the resource's current ETag. | `DS-0301` | CONFLICT | 409 | A resource with the same identity already exists. | Code | Constant | Status | Meaning | `DS-0400` | CONTENT_TOO_LARGE | 413 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0500` | CUSTOM_NOT_SCALAR | 400 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0600` | CONFIG_NOT_FOUND | 404 | Subscribe key unknown to the configuration service, or its datasync region is not configured. | `DS-0602` | UNSUPPORTED_ENTITY_PROPERTY_TYPE | 400 | A declared property's path resolves to a non-scalar node (object or array). | `DS-0650` | NON_NULLABLE_PROPERTY | 400 | A property declared `nullable: false` is missing or explicitly `null`. | Code | Constant | Status | Meaning | `DS-0700` | IMMUTABLE_FIELD_MODIFICATION | 400 | A patch targets a pointer outside the mutable set. Patch only. | Code | Constant | Status | Meaning | `DS-0800` | WRONG_ENTITY_CLASS_TYPE | 400 | An endpoint entity's class does not satisfy the relationship class for that side. Create only. | `DS-0801` | CARDINALITY_VIOLATED | 409 | ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only. | Code | Constant | Status | Meaning | `DS-0900` | GLOBAL_CLASS_MODIFICATION | 403 | Global class definitions are read-only. Replace and delete only. | `DS-0901` | PROJECTION_LIMIT_EXCEEDED | 400 | Distinct projections across all properties exceed the per-class maximum. | `DS-0902` | INVALID_PROJECTION_NAME | 400 | Projection name too long or malformed, or a property declares an empty projection list. | `DS-0903` | INCOMPATIBLE_CHILD_PROPERTY | 400 | A redeclared inherited property differs from the parent in `path`, `valueKind`, or `nullable`. Entity classes only. | `DS-0904` | MISSING_PARENT_PROPERTY | 400 | *Reserved - not currently emitted.* Missing parent properties are inherited automatically. | `DS-0905` | CLASS_HAS_CHILDREN | 409 | The class still has subclasses and cannot be deleted. Entity classes only. | `DS-0906` | RESERVED_PROPERTY_NAME | 400 | A declared property uses the name of a built-in record field (`id`, `createdAt`, `updatedAt`, `status`). Only `status` may be re-declared, and only as `{name: "status", path: "/status"}` to control its projections. | `message`stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it. | `path`string—**OPTIONAL**Location of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). |
| Code | Constant | Cause |
| `DS-0000` | INTERNAL_SERVER_ERROR | An unhandled error occurred, or the request could not be routed because of a server-side configuration problem. |
| Schema—**OPTIONAL** |
| `errors`object[]—**OPTIONAL**errorCode stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections.message stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it.path string — OPTIONALLocation of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). | `errorCode`stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections. | Code | Constant | Status | Meaning | `DS-0000` | INTERNAL_SERVER_ERROR | 500 | Unhandled server error, or a server-side routing configuration problem. | `DS-0002` | BAD_REQUEST | 400 | Required header or query parameter missing, or request input otherwise unusable. | `DS-0003` | INVALID_JSON | 400 | Request body absent, empty, or not valid JSON. | `DS-0004` | VALIDATION_ERROR | 400 | Body, path variable or query parameter failed validation. One error item per violation. | `DS-0005` | INVALID_FILTER | 400 | `filter_fast` / `filter` could not be parsed or validated. | `DS-0006` | INVALID_ARGUMENT | 400 | An argument could not be used - a `sort` field that is not sortable in that request, undecodable `cursor`, malformed JSON Pointer, parameter type mismatch. | `DS-0007` | UNSUPPORTED_CONTENT_TYPE | 415 | Request `Content-Type` not supported. | `DS-0008` | UNEXPECTED_FILTERABLE_FIELD_VALUE | 400 | A declared class property's value does not match its `valueKind`. | `DS-0009` | SERVICE_UNAVAILABLE | 503 | A required dependency is unavailable, or the request could not be forwarded to its region. | `DS-0010` | NOT_ACCEPTABLE | 406 | *Reserved - not currently emitted.* 406 responses carry a `text/plain` body with no error code. | `DS-0011` | METHOD_NOT_ALLOWED | 405 | HTTP method not supported for this path. | Code | Constant | Status | Meaning | `DS-0100` | NOT_FOUND | 404 | The addressed resource does not exist. | Code | Constant | Status | Meaning | `DS-0200` | DATASYNC_NOT_ENABLED | 403 | Datasync is not enabled for this subscribe key. | `DS-0201` | ACCESS_DENIED | 403 | Access Manager not enabled, conflicting credentials supplied, or authorization check denied. | `DS-0202` | INVALID_TOKEN | 403 | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. | `DS-0203` | UNAUTHENTICATED | 401 | No credentials supplied. | Code | Constant | Status | Meaning | `DS-0300` | ETAG_MISMATCH | 412 | `If-Match` does not contain the resource's current ETag. | `DS-0301` | CONFLICT | 409 | A resource with the same identity already exists. | Code | Constant | Status | Meaning | `DS-0400` | CONTENT_TOO_LARGE | 413 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0500` | CUSTOM_NOT_SCALAR | 400 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0600` | CONFIG_NOT_FOUND | 404 | Subscribe key unknown to the configuration service, or its datasync region is not configured. | `DS-0602` | UNSUPPORTED_ENTITY_PROPERTY_TYPE | 400 | A declared property's path resolves to a non-scalar node (object or array). | `DS-0650` | NON_NULLABLE_PROPERTY | 400 | A property declared `nullable: false` is missing or explicitly `null`. | Code | Constant | Status | Meaning | `DS-0700` | IMMUTABLE_FIELD_MODIFICATION | 400 | A patch targets a pointer outside the mutable set. Patch only. | Code | Constant | Status | Meaning | `DS-0800` | WRONG_ENTITY_CLASS_TYPE | 400 | An endpoint entity's class does not satisfy the relationship class for that side. Create only. | `DS-0801` | CARDINALITY_VIOLATED | 409 | ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only. | Code | Constant | Status | Meaning | `DS-0900` | GLOBAL_CLASS_MODIFICATION | 403 | Global class definitions are read-only. Replace and delete only. | `DS-0901` | PROJECTION_LIMIT_EXCEEDED | 400 | Distinct projections across all properties exceed the per-class maximum. | `DS-0902` | INVALID_PROJECTION_NAME | 400 | Projection name too long or malformed, or a property declares an empty projection list. | `DS-0903` | INCOMPATIBLE_CHILD_PROPERTY | 400 | A redeclared inherited property differs from the parent in `path`, `valueKind`, or `nullable`. Entity classes only. | `DS-0904` | MISSING_PARENT_PROPERTY | 400 | *Reserved - not currently emitted.* Missing parent properties are inherited automatically. | `DS-0905` | CLASS_HAS_CHILDREN | 409 | The class still has subclasses and cannot be deleted. Entity classes only. | `DS-0906` | RESERVED_PROPERTY_NAME | 400 | A declared property uses the name of a built-in record field (`id`, `createdAt`, `updatedAt`, `status`). Only `status` may be re-declared, and only as `{name: "status", path: "/status"}` to control its projections. | `message`stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it. | `path`string—**OPTIONAL**Location of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). |
| `errorCode`stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections. | Code | Constant | Status | Meaning | `DS-0000` | INTERNAL_SERVER_ERROR | 500 | Unhandled server error, or a server-side routing configuration problem. | `DS-0002` | BAD_REQUEST | 400 | Required header or query parameter missing, or request input otherwise unusable. | `DS-0003` | INVALID_JSON | 400 | Request body absent, empty, or not valid JSON. | `DS-0004` | VALIDATION_ERROR | 400 | Body, path variable or query parameter failed validation. One error item per violation. | `DS-0005` | INVALID_FILTER | 400 | `filter_fast` / `filter` could not be parsed or validated. | `DS-0006` | INVALID_ARGUMENT | 400 | An argument could not be used - a `sort` field that is not sortable in that request, undecodable `cursor`, malformed JSON Pointer, parameter type mismatch. | `DS-0007` | UNSUPPORTED_CONTENT_TYPE | 415 | Request `Content-Type` not supported. | `DS-0008` | UNEXPECTED_FILTERABLE_FIELD_VALUE | 400 | A declared class property's value does not match its `valueKind`. | `DS-0009` | SERVICE_UNAVAILABLE | 503 | A required dependency is unavailable, or the request could not be forwarded to its region. | `DS-0010` | NOT_ACCEPTABLE | 406 | *Reserved - not currently emitted.* 406 responses carry a `text/plain` body with no error code. | `DS-0011` | METHOD_NOT_ALLOWED | 405 | HTTP method not supported for this path. | Code | Constant | Status | Meaning | `DS-0100` | NOT_FOUND | 404 | The addressed resource does not exist. | Code | Constant | Status | Meaning | `DS-0200` | DATASYNC_NOT_ENABLED | 403 | Datasync is not enabled for this subscribe key. | `DS-0201` | ACCESS_DENIED | 403 | Access Manager not enabled, conflicting credentials supplied, or authorization check denied. | `DS-0202` | INVALID_TOKEN | 403 | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. | `DS-0203` | UNAUTHENTICATED | 401 | No credentials supplied. | Code | Constant | Status | Meaning | `DS-0300` | ETAG_MISMATCH | 412 | `If-Match` does not contain the resource's current ETag. | `DS-0301` | CONFLICT | 409 | A resource with the same identity already exists. | Code | Constant | Status | Meaning | `DS-0400` | CONTENT_TOO_LARGE | 413 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0500` | CUSTOM_NOT_SCALAR | 400 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0600` | CONFIG_NOT_FOUND | 404 | Subscribe key unknown to the configuration service, or its datasync region is not configured. | `DS-0602` | UNSUPPORTED_ENTITY_PROPERTY_TYPE | 400 | A declared property's path resolves to a non-scalar node (object or array). | `DS-0650` | NON_NULLABLE_PROPERTY | 400 | A property declared `nullable: false` is missing or explicitly `null`. | Code | Constant | Status | Meaning | `DS-0700` | IMMUTABLE_FIELD_MODIFICATION | 400 | A patch targets a pointer outside the mutable set. Patch only. | Code | Constant | Status | Meaning | `DS-0800` | WRONG_ENTITY_CLASS_TYPE | 400 | An endpoint entity's class does not satisfy the relationship class for that side. Create only. | `DS-0801` | CARDINALITY_VIOLATED | 409 | ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only. | Code | Constant | Status | Meaning | `DS-0900` | GLOBAL_CLASS_MODIFICATION | 403 | Global class definitions are read-only. Replace and delete only. | `DS-0901` | PROJECTION_LIMIT_EXCEEDED | 400 | Distinct projections across all properties exceed the per-class maximum. | `DS-0902` | INVALID_PROJECTION_NAME | 400 | Projection name too long or malformed, or a property declares an empty projection list. | `DS-0903` | INCOMPATIBLE_CHILD_PROPERTY | 400 | A redeclared inherited property differs from the parent in `path`, `valueKind`, or `nullable`. Entity classes only. | `DS-0904` | MISSING_PARENT_PROPERTY | 400 | *Reserved - not currently emitted.* Missing parent properties are inherited automatically. | `DS-0905` | CLASS_HAS_CHILDREN | 409 | The class still has subclasses and cannot be deleted. Entity classes only. | `DS-0906` | RESERVED_PROPERTY_NAME | 400 | A declared property uses the name of a built-in record field (`id`, `createdAt`, `updatedAt`, `status`). Only `status` may be re-declared, and only as `{name: "status", path: "/status"}` to control its projections. |
| Code | Constant | Status | Meaning |
| `DS-0000` | INTERNAL_SERVER_ERROR | 500 | Unhandled server error, or a server-side routing configuration problem. |
| `DS-0002` | BAD_REQUEST | 400 | Required header or query parameter missing, or request input otherwise unusable. |
| `DS-0003` | INVALID_JSON | 400 | Request body absent, empty, or not valid JSON. |
| `DS-0004` | VALIDATION_ERROR | 400 | Body, path variable or query parameter failed validation. One error item per violation. |
| `DS-0005` | INVALID_FILTER | 400 | `filter_fast` / `filter` could not be parsed or validated. |
| `DS-0006` | INVALID_ARGUMENT | 400 | An argument could not be used - a `sort` field that is not sortable in that request, undecodable `cursor`, malformed JSON Pointer, parameter type mismatch. |
| `DS-0007` | UNSUPPORTED_CONTENT_TYPE | 415 | Request `Content-Type` not supported. |
| `DS-0008` | UNEXPECTED_FILTERABLE_FIELD_VALUE | 400 | A declared class property's value does not match its `valueKind`. |
| `DS-0009` | SERVICE_UNAVAILABLE | 503 | A required dependency is unavailable, or the request could not be forwarded to its region. |
| `DS-0010` | NOT_ACCEPTABLE | 406 | *Reserved - not currently emitted.* 406 responses carry a `text/plain` body with no error code. |
| `DS-0011` | METHOD_NOT_ALLOWED | 405 | HTTP method not supported for this path. |
| Code | Constant | Status | Meaning |
| `DS-0100` | NOT_FOUND | 404 | The addressed resource does not exist. |
| Code | Constant | Status | Meaning |
| `DS-0200` | DATASYNC_NOT_ENABLED | 403 | Datasync is not enabled for this subscribe key. |
| `DS-0201` | ACCESS_DENIED | 403 | Access Manager not enabled, conflicting credentials supplied, or authorization check denied. |
| `DS-0202` | INVALID_TOKEN | 403 | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. |
| `DS-0203` | UNAUTHENTICATED | 401 | No credentials supplied. |
| Code | Constant | Status | Meaning |
| `DS-0300` | ETAG_MISMATCH | 412 | `If-Match` does not contain the resource's current ETag. |
| `DS-0301` | CONFLICT | 409 | A resource with the same identity already exists. |
| Code | Constant | Status | Meaning |
| `DS-0400` | CONTENT_TOO_LARGE | 413 | *Reserved - not currently emitted.* |
| Code | Constant | Status | Meaning |
| `DS-0500` | CUSTOM_NOT_SCALAR | 400 | *Reserved - not currently emitted.* |
| Code | Constant | Status | Meaning |
| `DS-0600` | CONFIG_NOT_FOUND | 404 | Subscribe key unknown to the configuration service, or its datasync region is not configured. |
| `DS-0602` | UNSUPPORTED_ENTITY_PROPERTY_TYPE | 400 | A declared property's path resolves to a non-scalar node (object or array). |
| `DS-0650` | NON_NULLABLE_PROPERTY | 400 | A property declared `nullable: false` is missing or explicitly `null`. |
| Code | Constant | Status | Meaning |
| `DS-0700` | IMMUTABLE_FIELD_MODIFICATION | 400 | A patch targets a pointer outside the mutable set. Patch only. |
| Code | Constant | Status | Meaning |
| `DS-0800` | WRONG_ENTITY_CLASS_TYPE | 400 | An endpoint entity's class does not satisfy the relationship class for that side. Create only. |
| `DS-0801` | CARDINALITY_VIOLATED | 409 | ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only. |
| Code | Constant | Status | Meaning |
| `DS-0900` | GLOBAL_CLASS_MODIFICATION | 403 | Global class definitions are read-only. Replace and delete only. |
| `DS-0901` | PROJECTION_LIMIT_EXCEEDED | 400 | Distinct projections across all properties exceed the per-class maximum. |
| `DS-0902` | INVALID_PROJECTION_NAME | 400 | Projection name too long or malformed, or a property declares an empty projection list. |
| `DS-0903` | INCOMPATIBLE_CHILD_PROPERTY | 400 | A redeclared inherited property differs from the parent in `path`, `valueKind`, or `nullable`. Entity classes only. |
| `DS-0904` | MISSING_PARENT_PROPERTY | 400 | *Reserved - not currently emitted.* Missing parent properties are inherited automatically. |
| `DS-0905` | CLASS_HAS_CHILDREN | 409 | The class still has subclasses and cannot be deleted. Entity classes only. |
| `DS-0906` | RESERVED_PROPERTY_NAME | 400 | A declared property uses the name of a built-in record field (`id`, `createdAt`, `updatedAt`, `status`). Only `status` may be re-declared, and only as `{name: "status", path: "/status"}` to control its projections. |
| `message`stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it. |
| `path`string—**OPTIONAL**Location of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). |
| `503`Service Unavailable.CodeConstantCauseDS-0009SERVICE_UNAVAILABLEA dependency required to serve the request is unavailable, or the request could not be forwarded to its target region. A Retry-After header may be present.Schema — OPTIONALerrors object[] — OPTIONALerrorCode stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections.message stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it.path string — OPTIONALLocation of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). | Code | Constant | Cause | `DS-0009` | SERVICE_UNAVAILABLE | A dependency required to serve the request is unavailable, or the request could not be forwarded to its target region. A `Retry-After` header may be present. | Schema—**OPTIONAL** | `errors`object[]—**OPTIONAL**errorCode stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections.message stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it.path string — OPTIONALLocation of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). | `errorCode`stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections. | Code | Constant | Status | Meaning | `DS-0000` | INTERNAL_SERVER_ERROR | 500 | Unhandled server error, or a server-side routing configuration problem. | `DS-0002` | BAD_REQUEST | 400 | Required header or query parameter missing, or request input otherwise unusable. | `DS-0003` | INVALID_JSON | 400 | Request body absent, empty, or not valid JSON. | `DS-0004` | VALIDATION_ERROR | 400 | Body, path variable or query parameter failed validation. One error item per violation. | `DS-0005` | INVALID_FILTER | 400 | `filter_fast` / `filter` could not be parsed or validated. | `DS-0006` | INVALID_ARGUMENT | 400 | An argument could not be used - a `sort` field that is not sortable in that request, undecodable `cursor`, malformed JSON Pointer, parameter type mismatch. | `DS-0007` | UNSUPPORTED_CONTENT_TYPE | 415 | Request `Content-Type` not supported. | `DS-0008` | UNEXPECTED_FILTERABLE_FIELD_VALUE | 400 | A declared class property's value does not match its `valueKind`. | `DS-0009` | SERVICE_UNAVAILABLE | 503 | A required dependency is unavailable, or the request could not be forwarded to its region. | `DS-0010` | NOT_ACCEPTABLE | 406 | *Reserved - not currently emitted.* 406 responses carry a `text/plain` body with no error code. | `DS-0011` | METHOD_NOT_ALLOWED | 405 | HTTP method not supported for this path. | Code | Constant | Status | Meaning | `DS-0100` | NOT_FOUND | 404 | The addressed resource does not exist. | Code | Constant | Status | Meaning | `DS-0200` | DATASYNC_NOT_ENABLED | 403 | Datasync is not enabled for this subscribe key. | `DS-0201` | ACCESS_DENIED | 403 | Access Manager not enabled, conflicting credentials supplied, or authorization check denied. | `DS-0202` | INVALID_TOKEN | 403 | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. | `DS-0203` | UNAUTHENTICATED | 401 | No credentials supplied. | Code | Constant | Status | Meaning | `DS-0300` | ETAG_MISMATCH | 412 | `If-Match` does not contain the resource's current ETag. | `DS-0301` | CONFLICT | 409 | A resource with the same identity already exists. | Code | Constant | Status | Meaning | `DS-0400` | CONTENT_TOO_LARGE | 413 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0500` | CUSTOM_NOT_SCALAR | 400 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0600` | CONFIG_NOT_FOUND | 404 | Subscribe key unknown to the configuration service, or its datasync region is not configured. | `DS-0602` | UNSUPPORTED_ENTITY_PROPERTY_TYPE | 400 | A declared property's path resolves to a non-scalar node (object or array). | `DS-0650` | NON_NULLABLE_PROPERTY | 400 | A property declared `nullable: false` is missing or explicitly `null`. | Code | Constant | Status | Meaning | `DS-0700` | IMMUTABLE_FIELD_MODIFICATION | 400 | A patch targets a pointer outside the mutable set. Patch only. | Code | Constant | Status | Meaning | `DS-0800` | WRONG_ENTITY_CLASS_TYPE | 400 | An endpoint entity's class does not satisfy the relationship class for that side. Create only. | `DS-0801` | CARDINALITY_VIOLATED | 409 | ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only. | Code | Constant | Status | Meaning | `DS-0900` | GLOBAL_CLASS_MODIFICATION | 403 | Global class definitions are read-only. Replace and delete only. | `DS-0901` | PROJECTION_LIMIT_EXCEEDED | 400 | Distinct projections across all properties exceed the per-class maximum. | `DS-0902` | INVALID_PROJECTION_NAME | 400 | Projection name too long or malformed, or a property declares an empty projection list. | `DS-0903` | INCOMPATIBLE_CHILD_PROPERTY | 400 | A redeclared inherited property differs from the parent in `path`, `valueKind`, or `nullable`. Entity classes only. | `DS-0904` | MISSING_PARENT_PROPERTY | 400 | *Reserved - not currently emitted.* Missing parent properties are inherited automatically. | `DS-0905` | CLASS_HAS_CHILDREN | 409 | The class still has subclasses and cannot be deleted. Entity classes only. | `DS-0906` | RESERVED_PROPERTY_NAME | 400 | A declared property uses the name of a built-in record field (`id`, `createdAt`, `updatedAt`, `status`). Only `status` may be re-declared, and only as `{name: "status", path: "/status"}` to control its projections. | `message`stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it. | `path`string—**OPTIONAL**Location of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). |
| Code | Constant | Cause |
| `DS-0009` | SERVICE_UNAVAILABLE | A dependency required to serve the request is unavailable, or the request could not be forwarded to its target region. A `Retry-After` header may be present. |
| Schema—**OPTIONAL** |
| `errors`object[]—**OPTIONAL**errorCode stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections.message stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it.path string — OPTIONALLocation of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). | `errorCode`stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections. | Code | Constant | Status | Meaning | `DS-0000` | INTERNAL_SERVER_ERROR | 500 | Unhandled server error, or a server-side routing configuration problem. | `DS-0002` | BAD_REQUEST | 400 | Required header or query parameter missing, or request input otherwise unusable. | `DS-0003` | INVALID_JSON | 400 | Request body absent, empty, or not valid JSON. | `DS-0004` | VALIDATION_ERROR | 400 | Body, path variable or query parameter failed validation. One error item per violation. | `DS-0005` | INVALID_FILTER | 400 | `filter_fast` / `filter` could not be parsed or validated. | `DS-0006` | INVALID_ARGUMENT | 400 | An argument could not be used - a `sort` field that is not sortable in that request, undecodable `cursor`, malformed JSON Pointer, parameter type mismatch. | `DS-0007` | UNSUPPORTED_CONTENT_TYPE | 415 | Request `Content-Type` not supported. | `DS-0008` | UNEXPECTED_FILTERABLE_FIELD_VALUE | 400 | A declared class property's value does not match its `valueKind`. | `DS-0009` | SERVICE_UNAVAILABLE | 503 | A required dependency is unavailable, or the request could not be forwarded to its region. | `DS-0010` | NOT_ACCEPTABLE | 406 | *Reserved - not currently emitted.* 406 responses carry a `text/plain` body with no error code. | `DS-0011` | METHOD_NOT_ALLOWED | 405 | HTTP method not supported for this path. | Code | Constant | Status | Meaning | `DS-0100` | NOT_FOUND | 404 | The addressed resource does not exist. | Code | Constant | Status | Meaning | `DS-0200` | DATASYNC_NOT_ENABLED | 403 | Datasync is not enabled for this subscribe key. | `DS-0201` | ACCESS_DENIED | 403 | Access Manager not enabled, conflicting credentials supplied, or authorization check denied. | `DS-0202` | INVALID_TOKEN | 403 | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. | `DS-0203` | UNAUTHENTICATED | 401 | No credentials supplied. | Code | Constant | Status | Meaning | `DS-0300` | ETAG_MISMATCH | 412 | `If-Match` does not contain the resource's current ETag. | `DS-0301` | CONFLICT | 409 | A resource with the same identity already exists. | Code | Constant | Status | Meaning | `DS-0400` | CONTENT_TOO_LARGE | 413 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0500` | CUSTOM_NOT_SCALAR | 400 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0600` | CONFIG_NOT_FOUND | 404 | Subscribe key unknown to the configuration service, or its datasync region is not configured. | `DS-0602` | UNSUPPORTED_ENTITY_PROPERTY_TYPE | 400 | A declared property's path resolves to a non-scalar node (object or array). | `DS-0650` | NON_NULLABLE_PROPERTY | 400 | A property declared `nullable: false` is missing or explicitly `null`. | Code | Constant | Status | Meaning | `DS-0700` | IMMUTABLE_FIELD_MODIFICATION | 400 | A patch targets a pointer outside the mutable set. Patch only. | Code | Constant | Status | Meaning | `DS-0800` | WRONG_ENTITY_CLASS_TYPE | 400 | An endpoint entity's class does not satisfy the relationship class for that side. Create only. | `DS-0801` | CARDINALITY_VIOLATED | 409 | ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only. | Code | Constant | Status | Meaning | `DS-0900` | GLOBAL_CLASS_MODIFICATION | 403 | Global class definitions are read-only. Replace and delete only. | `DS-0901` | PROJECTION_LIMIT_EXCEEDED | 400 | Distinct projections across all properties exceed the per-class maximum. | `DS-0902` | INVALID_PROJECTION_NAME | 400 | Projection name too long or malformed, or a property declares an empty projection list. | `DS-0903` | INCOMPATIBLE_CHILD_PROPERTY | 400 | A redeclared inherited property differs from the parent in `path`, `valueKind`, or `nullable`. Entity classes only. | `DS-0904` | MISSING_PARENT_PROPERTY | 400 | *Reserved - not currently emitted.* Missing parent properties are inherited automatically. | `DS-0905` | CLASS_HAS_CHILDREN | 409 | The class still has subclasses and cannot be deleted. Entity classes only. | `DS-0906` | RESERVED_PROPERTY_NAME | 400 | A declared property uses the name of a built-in record field (`id`, `createdAt`, `updatedAt`, `status`). Only `status` may be re-declared, and only as `{name: "status", path: "/status"}` to control its projections. | `message`stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it. | `path`string—**OPTIONAL**Location of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). |
| `errorCode`stringA machine-readable error code. Stable across releases - use this, not message, for programmatic branching. The HTTP status for a given code is fixed.Codes are grouped by range. Not every code can occur on every operation; each response documents the subset it can return.GenericCodeConstantStatusMeaningDS-0000INTERNAL_SERVER_ERROR500Unhandled server error, or a server-side routing configuration problem.DS-0002BAD_REQUEST400Required header or query parameter missing, or request input otherwise unusable.DS-0003INVALID_JSON400Request body absent, empty, or not valid JSON.DS-0004VALIDATION_ERROR400Body, path variable or query parameter failed validation. One error item per violation.DS-0005INVALID_FILTER400filter_fast / filter could not be parsed or validated.DS-0006INVALID_ARGUMENT400An argument could not be used - a sort field that is not sortable in that request, undecodable cursor, malformed JSON Pointer, parameter type mismatch.DS-0007UNSUPPORTED_CONTENT_TYPE415Request Content-Type not supported.DS-0008UNEXPECTED_FILTERABLE_FIELD_VALUE400A declared class property's value does not match its valueKind.DS-0009SERVICE_UNAVAILABLE503A required dependency is unavailable, or the request could not be forwarded to its region.DS-0010NOT_ACCEPTABLE406Reserved - not currently emitted. 406 responses carry a text/plain body with no error code.DS-0011METHOD_NOT_ALLOWED405HTTP method not supported for this path.Resource (01xx)CodeConstantStatusMeaningDS-0100NOT_FOUND404The addressed resource does not exist.Authorization (02xx)CodeConstantStatusMeaningDS-0200DATASYNC_NOT_ENABLED403Datasync is not enabled for this subscribe key.DS-0201ACCESS_DENIED403Access Manager not enabled, conflicting credentials supplied, or authorization check denied.DS-0202INVALID_TOKEN403The auth PAM token could not be decoded, or its projection does not permit the requested fields.DS-0203UNAUTHENTICATED401No credentials supplied.State (03xx)CodeConstantStatusMeaningDS-0300ETAG_MISMATCH412If-Match does not contain the resource's current ETag.DS-0301CONFLICT409A resource with the same identity already exists.Size limits (04xx)CodeConstantStatusMeaningDS-0400CONTENT_TOO_LARGE413Reserved - not currently emitted.Custom fields (05xx)CodeConstantStatusMeaningDS-0500CUSTOM_NOT_SCALAR400Reserved - not currently emitted.Configuration (06xx)CodeConstantStatusMeaningDS-0600CONFIG_NOT_FOUND404Subscribe key unknown to the configuration service, or its datasync region is not configured.DS-0602UNSUPPORTED_ENTITY_PROPERTY_TYPE400A declared property's path resolves to a non-scalar node (object or array).DS-0650NON_NULLABLE_PROPERTY400A property declared nullable: false is missing or explicitly null.Patch (07xx)CodeConstantStatusMeaningDS-0700IMMUTABLE_FIELD_MODIFICATION400A patch targets a pointer outside the mutable set. Patch only.Relationships (08xx)CodeConstantStatusMeaningDS-0800WRONG_ENTITY_CLASS_TYPE400An endpoint entity's class does not satisfy the relationship class for that side. Create only.DS-0801CARDINALITY_VIOLATED409ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only.Class management (09xx)CodeConstantStatusMeaningDS-0900GLOBAL_CLASS_MODIFICATION403Global class definitions are read-only. Replace and delete only.DS-0901PROJECTION_LIMIT_EXCEEDED400Distinct projections across all properties exceed the per-class maximum.DS-0902INVALID_PROJECTION_NAME400Projection name too long or malformed, or a property declares an empty projection list.DS-0903INCOMPATIBLE_CHILD_PROPERTY400A redeclared inherited property differs from the parent in path, valueKind, or nullable. Entity classes only.DS-0904MISSING_PARENT_PROPERTY400Reserved - not currently emitted. Missing parent properties are inherited automatically.DS-0905CLASS_HAS_CHILDREN409The class still has subclasses and cannot be deleted. Entity classes only.DS-0906RESERVED_PROPERTY_NAME400A declared property uses the name of a built-in record field (id, createdAt, updatedAt, status). Only status may be re-declared, and only as {name: "status", path: "/status"} to control its projections. | Code | Constant | Status | Meaning | `DS-0000` | INTERNAL_SERVER_ERROR | 500 | Unhandled server error, or a server-side routing configuration problem. | `DS-0002` | BAD_REQUEST | 400 | Required header or query parameter missing, or request input otherwise unusable. | `DS-0003` | INVALID_JSON | 400 | Request body absent, empty, or not valid JSON. | `DS-0004` | VALIDATION_ERROR | 400 | Body, path variable or query parameter failed validation. One error item per violation. | `DS-0005` | INVALID_FILTER | 400 | `filter_fast` / `filter` could not be parsed or validated. | `DS-0006` | INVALID_ARGUMENT | 400 | An argument could not be used - a `sort` field that is not sortable in that request, undecodable `cursor`, malformed JSON Pointer, parameter type mismatch. | `DS-0007` | UNSUPPORTED_CONTENT_TYPE | 415 | Request `Content-Type` not supported. | `DS-0008` | UNEXPECTED_FILTERABLE_FIELD_VALUE | 400 | A declared class property's value does not match its `valueKind`. | `DS-0009` | SERVICE_UNAVAILABLE | 503 | A required dependency is unavailable, or the request could not be forwarded to its region. | `DS-0010` | NOT_ACCEPTABLE | 406 | *Reserved - not currently emitted.* 406 responses carry a `text/plain` body with no error code. | `DS-0011` | METHOD_NOT_ALLOWED | 405 | HTTP method not supported for this path. | Code | Constant | Status | Meaning | `DS-0100` | NOT_FOUND | 404 | The addressed resource does not exist. | Code | Constant | Status | Meaning | `DS-0200` | DATASYNC_NOT_ENABLED | 403 | Datasync is not enabled for this subscribe key. | `DS-0201` | ACCESS_DENIED | 403 | Access Manager not enabled, conflicting credentials supplied, or authorization check denied. | `DS-0202` | INVALID_TOKEN | 403 | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. | `DS-0203` | UNAUTHENTICATED | 401 | No credentials supplied. | Code | Constant | Status | Meaning | `DS-0300` | ETAG_MISMATCH | 412 | `If-Match` does not contain the resource's current ETag. | `DS-0301` | CONFLICT | 409 | A resource with the same identity already exists. | Code | Constant | Status | Meaning | `DS-0400` | CONTENT_TOO_LARGE | 413 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0500` | CUSTOM_NOT_SCALAR | 400 | *Reserved - not currently emitted.* | Code | Constant | Status | Meaning | `DS-0600` | CONFIG_NOT_FOUND | 404 | Subscribe key unknown to the configuration service, or its datasync region is not configured. | `DS-0602` | UNSUPPORTED_ENTITY_PROPERTY_TYPE | 400 | A declared property's path resolves to a non-scalar node (object or array). | `DS-0650` | NON_NULLABLE_PROPERTY | 400 | A property declared `nullable: false` is missing or explicitly `null`. | Code | Constant | Status | Meaning | `DS-0700` | IMMUTABLE_FIELD_MODIFICATION | 400 | A patch targets a pointer outside the mutable set. Patch only. | Code | Constant | Status | Meaning | `DS-0800` | WRONG_ENTITY_CLASS_TYPE | 400 | An endpoint entity's class does not satisfy the relationship class for that side. Create only. | `DS-0801` | CARDINALITY_VIOLATED | 409 | ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only. | Code | Constant | Status | Meaning | `DS-0900` | GLOBAL_CLASS_MODIFICATION | 403 | Global class definitions are read-only. Replace and delete only. | `DS-0901` | PROJECTION_LIMIT_EXCEEDED | 400 | Distinct projections across all properties exceed the per-class maximum. | `DS-0902` | INVALID_PROJECTION_NAME | 400 | Projection name too long or malformed, or a property declares an empty projection list. | `DS-0903` | INCOMPATIBLE_CHILD_PROPERTY | 400 | A redeclared inherited property differs from the parent in `path`, `valueKind`, or `nullable`. Entity classes only. | `DS-0904` | MISSING_PARENT_PROPERTY | 400 | *Reserved - not currently emitted.* Missing parent properties are inherited automatically. | `DS-0905` | CLASS_HAS_CHILDREN | 409 | The class still has subclasses and cannot be deleted. Entity classes only. | `DS-0906` | RESERVED_PROPERTY_NAME | 400 | A declared property uses the name of a built-in record field (`id`, `createdAt`, `updatedAt`, `status`). Only `status` may be re-declared, and only as `{name: "status", path: "/status"}` to control its projections. |
| Code | Constant | Status | Meaning |
| `DS-0000` | INTERNAL_SERVER_ERROR | 500 | Unhandled server error, or a server-side routing configuration problem. |
| `DS-0002` | BAD_REQUEST | 400 | Required header or query parameter missing, or request input otherwise unusable. |
| `DS-0003` | INVALID_JSON | 400 | Request body absent, empty, or not valid JSON. |
| `DS-0004` | VALIDATION_ERROR | 400 | Body, path variable or query parameter failed validation. One error item per violation. |
| `DS-0005` | INVALID_FILTER | 400 | `filter_fast` / `filter` could not be parsed or validated. |
| `DS-0006` | INVALID_ARGUMENT | 400 | An argument could not be used - a `sort` field that is not sortable in that request, undecodable `cursor`, malformed JSON Pointer, parameter type mismatch. |
| `DS-0007` | UNSUPPORTED_CONTENT_TYPE | 415 | Request `Content-Type` not supported. |
| `DS-0008` | UNEXPECTED_FILTERABLE_FIELD_VALUE | 400 | A declared class property's value does not match its `valueKind`. |
| `DS-0009` | SERVICE_UNAVAILABLE | 503 | A required dependency is unavailable, or the request could not be forwarded to its region. |
| `DS-0010` | NOT_ACCEPTABLE | 406 | *Reserved - not currently emitted.* 406 responses carry a `text/plain` body with no error code. |
| `DS-0011` | METHOD_NOT_ALLOWED | 405 | HTTP method not supported for this path. |
| Code | Constant | Status | Meaning |
| `DS-0100` | NOT_FOUND | 404 | The addressed resource does not exist. |
| Code | Constant | Status | Meaning |
| `DS-0200` | DATASYNC_NOT_ENABLED | 403 | Datasync is not enabled for this subscribe key. |
| `DS-0201` | ACCESS_DENIED | 403 | Access Manager not enabled, conflicting credentials supplied, or authorization check denied. |
| `DS-0202` | INVALID_TOKEN | 403 | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. |
| `DS-0203` | UNAUTHENTICATED | 401 | No credentials supplied. |
| Code | Constant | Status | Meaning |
| `DS-0300` | ETAG_MISMATCH | 412 | `If-Match` does not contain the resource's current ETag. |
| `DS-0301` | CONFLICT | 409 | A resource with the same identity already exists. |
| Code | Constant | Status | Meaning |
| `DS-0400` | CONTENT_TOO_LARGE | 413 | *Reserved - not currently emitted.* |
| Code | Constant | Status | Meaning |
| `DS-0500` | CUSTOM_NOT_SCALAR | 400 | *Reserved - not currently emitted.* |
| Code | Constant | Status | Meaning |
| `DS-0600` | CONFIG_NOT_FOUND | 404 | Subscribe key unknown to the configuration service, or its datasync region is not configured. |
| `DS-0602` | UNSUPPORTED_ENTITY_PROPERTY_TYPE | 400 | A declared property's path resolves to a non-scalar node (object or array). |
| `DS-0650` | NON_NULLABLE_PROPERTY | 400 | A property declared `nullable: false` is missing or explicitly `null`. |
| Code | Constant | Status | Meaning |
| `DS-0700` | IMMUTABLE_FIELD_MODIFICATION | 400 | A patch targets a pointer outside the mutable set. Patch only. |
| Code | Constant | Status | Meaning |
| `DS-0800` | WRONG_ENTITY_CLASS_TYPE | 400 | An endpoint entity's class does not satisfy the relationship class for that side. Create only. |
| `DS-0801` | CARDINALITY_VIOLATED | 409 | ONE-TO-ONE or ONE-TO-MANY cardinality already satisfied. Create only. |
| Code | Constant | Status | Meaning |
| `DS-0900` | GLOBAL_CLASS_MODIFICATION | 403 | Global class definitions are read-only. Replace and delete only. |
| `DS-0901` | PROJECTION_LIMIT_EXCEEDED | 400 | Distinct projections across all properties exceed the per-class maximum. |
| `DS-0902` | INVALID_PROJECTION_NAME | 400 | Projection name too long or malformed, or a property declares an empty projection list. |
| `DS-0903` | INCOMPATIBLE_CHILD_PROPERTY | 400 | A redeclared inherited property differs from the parent in `path`, `valueKind`, or `nullable`. Entity classes only. |
| `DS-0904` | MISSING_PARENT_PROPERTY | 400 | *Reserved - not currently emitted.* Missing parent properties are inherited automatically. |
| `DS-0905` | CLASS_HAS_CHILDREN | 409 | The class still has subclasses and cannot be deleted. Entity classes only. |
| `DS-0906` | RESERVED_PROPERTY_NAME | 400 | A declared property uses the name of a built-in record field (`id`, `createdAt`, `updatedAt`, `status`). Only `status` may be re-declared, and only as `{name: "status", path: "/status"}` to control its projections. |
| `message`stringA human-readable description of the error, intended for logs and diagnostics. Not stable across releases - do not parse or branch on it. |
| `path`string—**OPTIONAL**Location of the input that caused the error. Present only for codes that can identify one. The form depends on the code: a JSON Pointer into the request payload (DS-0008, DS-0602, DS-0650), a query parameter name (filter for DS-0005, sort for DS-0006), a field name (DS-0004), or a class property name (DS-0903). |

subKey
*
Type:
string
Subscribe key identifying the keyset.
entity_class
Type:
string
Entity class name
entity_class_version
Type:
integer
Version of the entity class. If not provided, the latest version is used.
entity_class_level
Type:
string
Level of the entity class.
cursor
Type:
string
Opaque cursor for pagination. Base64-encoded token representing the position

in the result set. Omit or pass null for the first page. Use the cursor value

from
meta.next_cursor
in the response to navigate to the next page.
limit
Type:
integer
Maximum number of items to return per page (default 20, max 100)
filter_fast
Type:
string
Filter expression using AppContext Query Language against strongly consistent storage with limited number of conditions
filter
Type:
string
Filter expression using AppContext Query Language against eventually consistent storage
sort
Type:
string
Comma-separated list of field names to sort by, each optionally

suffixed with
:desc
(ascending by default).

The built-in fields
id
,
createdAt
, and
updatedAt
are always

sortable without declaring them in the class definition.
status
is

also sortable by default, but can be restricted by projections: when a

class declares it at
/status
, a PAM-authenticated request can use it

only if every projection reachable by the token includes
status
.

Payload properties need
filtering
of at least
simple
, or
full

when
sort
is combined with
filter_advanced
.
auth
Type:
string
Required
unless you supply
signature
instead. An
[Access Manager](https://www.pubnub.com/docs/security/access-control/overview.md)
token authorizing the operation. Use this for client-side callers.

Supply either
auth
or
signature
, never both. Supplying neither returns
401
(
DS-0203
). Supplying both returns
403
(
DS-0201
).

If the token cannot be decoded, or its
[projection](https://www.pubnub.com/docs/data-storage/structured-data/projections.md)
does not permit the requested fields, the request fails with
403
(
DS-0202
, INVALID_TOKEN).
signature
Type:
string
Required
unless you supply
auth
instead. A signature proving the request was signed with the secret key for this keyset. Use this for server-side callers.

Supply either
signature
or
auth
, never both. Supplying neither returns
401
(
DS-0203
). Supplying both returns
403
(
DS-0201
).

Refer to
[Signature generation](https://www.pubnub.com/docs/sdks/rest-api/access-manager-introduction.md)
for how to compute it.
Bad request. Adds the filter, sort and cursor errors specific to list operations.

| Code | Constant | Cause |
| --- | --- | --- |
| `DS-0002` | BAD_REQUEST | Required header or query parameter missing. |
| `DS-0004` | VALIDATION_ERROR | Path variable or query parameter failed validation. |
| `DS-0005` | INVALID_FILTER | `filter_fast` / `filter` could not be parsed, references an unknown field, or compares a literal against an incompatible `valueKind`. `path` is always `filter`, including for `filter_fast`. |
| `DS-0006` | INVALID_ARGUMENT | `sort` references a field that is not sortable in this request (`path` is `sort`), or `cursor` could not be decoded. |

The built-in fields
id
,
createdAt
, and
updatedAt
are always sortable.
status
is

sortable by default, but can be restricted by projections when it is declared at
/status
:

a PAM-authenticated request can use it only if every projection reachable by the token

includes
status
. Payload properties additionally need
filtering
of at least
simple
—

or
full
when
filter_advanced
is present, because that path resolves sorts in the search

index, which only holds
full
properties.
errors
Type:
array
Array items:
items
Type:
object
Error object
Example Response
Example
1
Example
2
Example
3
Example
4

```
{
  "errors": [
    {
      "errorCode": "DS-0005",
      "message": "Error parsing filter expression at offset 12: expected comparison operator",
      "path": "filter"
    }
  ]
}
```

Unauthorized - no usable credentials were supplied.

| Code | Constant | Cause |
| --- | --- | --- |
| `DS-0203` | UNAUTHENTICATED | Neither a PAM token (`auth`) nor a request `signature` was supplied, or the portal session token is missing. |

errors
Type:
array
Array items:
items
Type:
object
Error object
Example Response

```
{
  "errors": [
    {
      "errorCode": "DS-0203",
      "message": "Authentication required: provide either a PAM token via 'auth' parameter or a request signature."
    }
  ]
}
```

Forbidden - credentials were recognised but the request is not permitted.

| Code | Constant | Cause |
| --- | --- | --- |
| `DS-0200` | DATASYNC_NOT_ENABLED | Datasync is not enabled for this subscribe key. |
| `DS-0201` | ACCESS_DENIED | Access Manager is not enabled for the keyset, `auth` and `signature` were both supplied, or the portal authorization check denied the request. |
| `DS-0202` | INVALID_TOKEN | The `auth` PAM token could not be decoded, or its projection does not permit the requested fields. |

errors
Type:
array
Array items:
items
Type:
object
Error object
Example Response
Example
1
Example
2
Example
3

```
{
  "errors": [
    {
      "errorCode": "DS-0200",
      "message": "Datasync not enabled for this subscribe key"
    }
  ]
}
```

Not Acceptable - the
Accept
header does not contain a supported value.

This response carries a
text/plain
body and
no
error code.
Too Many Requests - rate limit exceeded.

Rate limiting is applied by the edge in front of this service; the service itself defines no

error code for this status. Clients should not rely on an error code being present.
errors
Type:
array
Array items:
items
Type:
object
Error object
Internal server error.

| Code | Constant | Cause |
| --- | --- | --- |
| `DS-0000` | INTERNAL_SERVER_ERROR | An unhandled error occurred, or the request could not be routed because of a server-side configuration problem. |

errors
Type:
array
Array items:
items
Type:
object
Error object
Example Response

```
{
  "errors": [
    {
      "errorCode": "DS-0000",
      "message": "Internal server error"
    }
  ]
}
```

Service Unavailable.

| Code | Constant | Cause |
| --- | --- | --- |
| `DS-0009` | SERVICE_UNAVAILABLE | A dependency required to serve the request is unavailable, or the request could not be forwarded to its target region. A `Retry-After` header may be present. |

errors
Type:
array
Array items:
items
Type:
object
Error object
Example Response

```
{
  "errors": [
    {
      "errorCode": "DS-0009",
      "message": "Service temporarily unavailable"
    }
  ]
}
```