Collections

Database → Collections endpoints.

Collections hold your records. Norbix generates a full CRUD + query API over each collection from its schema, with record-level ownership and triggers.

Endpoint	Method
Aggregate	POST collections/{collectionName}/aggregate
Change Responsibility	PUT collections/{collectionName}/{id}/responsibility
Count	GET collections/{collectionName}/count
Delete Many	DELETE collections/{collectionName}/many
Delete One	DELETE collections/{collectionName}/{id}
Distinct	GET collections/{collectionName}/distinct
Execute Aggregate	POST collections/{collectionName}/aggregates/{aggregateId}/execute
Find	GET collections/{collectionName}
Find One	GET collections/{collectionName}/{id}
Find Own	GET collections/{collectionName}/own
Insert Many	POST collections/{collectionName}/many
Insert One	POST collections/{collectionName}
Replace One	PUT collections/{collectionName}/{id}/replace
Update Many	PUT collections/{collectionName}/many
Update One	PUT collections/{collectionName}/{id}
Aggregate Records	POST collections/{collectionName}/aggregate
Change Record Responsibility	PUT collections/{collectionName}/{id}/responsibility
Count Records	GET collections/{collectionName}/count
Delete Many Records	DELETE collections/{collectionName}/many
Delete Record	DELETE collections/{collectionName}/{id}
Distinct Record Values	GET collections/{collectionName}/distinct
Execute Records Aggregate	POST collections/{collectionName}/aggregates/{aggregateId}/execute
Find One Record	GET collections/{collectionName}/{id}
Find Records	GET collections/{collectionName}
Get Collection Indexes	GET collections/{collectionName}/indexes
Insert Many Records	POST collections/{collectionName}/many
Insert Record	POST collections/{collectionName}
Replace Record	PUT collections/{collectionName}/{id}/replace
Seed Collection Records	POST collections/seed
Update Many Records	PUT collections/{collectionName}/many
Update One Record	PUT collections/{collectionName}/{id}

Hub only (developer / admin plane):

Endpoint	Method
Hub record endpoints	the same record routes as above, on the Hub
Seed Collection Records	POST collections/seed
Get Collection Indexes	GET collections/{collectionName}/indexes

Rules for every record endpoint

• filter, document, update and pipeline are JSON strings.

• Inserts and updates (Update One, Update Many) are validated against the collection's published schema.

• A filter or pipeline with $where, $function or $accumulator, or a read pipeline with $out / $merge, is refused with CM-ERRORS-DATABASE-031.

• Without databaseIntegrationId the default database integration of the request's environment is used.

• Bulk writes need a real filter. Update Many and Delete Many refuse an empty filter {} (or no filter) with CM-ERRORS-DATABASE-037. To change or delete every record on purpose, send allRecords: true (AllRecords in .NET) with the empty filter.

• Soft-deleted records are not written. Update One / Update Many / Replace One / Change Responsibility skip records that are soft-deleted — for a write they are "not found", just as reads do not return them.

• Updates take bare fields only. An update body with MongoDB operators at the top level ({"$inc": {"stock": 1}}, $set, $unset, …) is refused with CM-ERRORS-DATABASE-035, one error per operator. Send {"stock": 5}; the server applies it with $set.

• A broken record body has its own error. A document / replacement that is not a JSON object (or an Insert Many item that is not an object) answers CM-ERRORS-DATABASE-036, with the index of the bad item; CM-ERRORS-DATABASE-005 is only for a broken filter.

• Own scope works for bulk operations. A caller with only own-record rights may call Insert Many (createAsUser — every record gets the caller as owner, even if the document names someone else), Update Many (updateOwn) and Delete Many (deleteOwn) — the filter is narrowed to the caller's own records. Changing the owner in an own-scope Update Many is refused (that needs full database:update).

• The new owner must be a project user. Change Responsibility checks the new owner in the users of the environment's default database integration and answers CM-ERRORS-MEMBERSHIP-USERS-012 when there is no such user — nothing is written.

In Cloud: Records.