Find One

Gets record by specified database unique id or filter.

Last updated 2 years ago

Was this helpful?

Find One

Gets record by specified database unique id or filter.

Finds one database record. You can pass projection to return record fields you care about. Also, you can include referenced collections to have all that information in one place.

var client = new CodeMashClient(apiKey, projectId);
var service = new CodeMashRepository<Person>(client);

var person = await service.FindOneByIdAsync(
    "{RECORD_ID}",
    new DatabaseFindOneOptions()
);

Check the docs about entities on how the response record is deserialized into your class object.

import { db } from 'codemash';

export async function getEmployeeDetails(id) {
    const response = await db.getRecord('employees', id);
    return response;
}

use Codemash\CodemashClient;
use Codemash\CodemashDb;

class CodemashService
{
    protected CodemashDb $codemashDb;
    protected string $collectionName = '{YOUR_COLLECTION_NAME}';

    public function __construct()
    {
        $secretKey = '{YOUR_SECRET_KEY}';
        $projectId = '{YOUR_PROJECT_ID}';

        $client = new CodemashClient($secretKey, $projectId);
        $this->codemashDb = new CodemashDb($client);
    }

    public function findOneById()
    {
        $responseData = $this->codemashDb->get([
        	'collectionName' => 'employees',
        	'id' => '{EMPLOYEE_ID}',
        ]);
    }
}

Check the docs on how to form projections. Check the docs on how to use references.

Find One (by using a filter)

GET https://api.codemash.io/:version/db/:collectionName/findOne

Gets a record by using a filter. This endpoint accepts GET and POST methods.

Path Parameters

Name

Type

Description

version

string

A version of the API endpoint.

collectionName

string

The name of the collection to get a record from.

Query Parameters

Name

Type

Description

filter

string

Filter document. This allows you to find a record by a custom filter. More about filters follow the link below.

referencedFields

array

Fields to left join. More about referencing fields follow the link below.

addReferencesFirst

boolean

If set to true, left joins first before applying other processing to main records. More about referencing fields follow the link below.

cultureCode

string

Language code. If your record has translatable fields, those fields will only include this specified language. If not provided, will take language from the Accept-Language header.

projection

string

Projection document. This allows you to specify what fields to return decreasing the amount of data transferred. More about projections follow the link below.

includeSchema

boolean

If set to true, includes your collection details in the response.

excludeCulture

boolean

Culture code or Accept-Language header will be used for translatable fields. If you want to get values in all languages, set this as true.

Headers

Name

Type

Description

Authorization

string

Secret API key which belongs to your project or user. Not required if using cookies with a session ID.

x-cm-projectid

string

Your project's ID. Can be passed as a query parameter.

{
    "result": "{ '_id': '5e37136bf59f3a3f940b99a4', 'name': 'John' }",
    "schema": null,
}

var client = new CodeMashClient(apiKey, projectId);
var service = new CodeMashRepository<Person>(client);

var person = await service.FindOneAsync(
    x => x.Id == "{RECORD_ID}",
    new DatabaseFindOneOptions()
);

Check the docs about entities on how the response record is deserialized into your class object.

import { db } from 'codemash';

export async function getEmployeeByUserId(id) {    
    
    const filter = { userId : id };    
    return await db.getRecordWithFilter(collectionName, filter, null);
}

use Codemash\CodemashClient;
use Codemash\CodemashDb;

class CodemashService
{
    protected CodemashDb $codemashDb;
    protected string $collectionName = '{YOUR_COLLECTION_NAME}';

    public function __construct()
    {
        $secretKey = '{YOUR_SECRET_KEY}';
        $projectId = '{YOUR_PROJECT_ID}';

        $client = new CodemashClient($secretKey, $projectId);
        $this->codemashDb = new CodemashDb($client);
    }

    public function findOneByFilter()
    {
        $responseData = $this->codemashDb->findOne([
        	'collectionName' => 'employees',
        	'filter' => [
        		'address' => 'Los Angeles',
        	],
        ]);
    }
}

Check the docs on how to form projections, filters. Check the docs on how to use references.

PreviousFind NextInsert

Last updated 2 years ago

Was this helpful?

Finds one database record. You can pass projection to return record fields you care about. Also, you can include referenced collections to have all that information in one place.

var client = new CodeMashClient(apiKey, projectId);
var service = new CodeMashRepository<Person>(client);

var person = await service.FindOneByIdAsync(
    "{RECORD_ID}",
    new DatabaseFindOneOptions()
);

Check the docs about entities on how the response record is deserialized into your class object.

import { db } from 'codemash';

export async function getEmployeeDetails(id) {
    const response = await db.getRecord('employees', id);
    return response;
}

use Codemash\CodemashClient;
use Codemash\CodemashDb;

class CodemashService
{
    protected CodemashDb $codemashDb;
    protected string $collectionName = '{YOUR_COLLECTION_NAME}';

    public function __construct()
    {
        $secretKey = '{YOUR_SECRET_KEY}';
        $projectId = '{YOUR_PROJECT_ID}';

        $client = new CodemashClient($secretKey, $projectId);
        $this->codemashDb = new CodemashDb($client);
    }

    public function findOneById()
    {
        $responseData = $this->codemashDb->get([
        	'collectionName' => 'employees',
        	'id' => '{EMPLOYEE_ID}',
        ]);
    }
}

Check the docs on how to form projections. Check the docs on how to use references.

Find One (by using a filter)

GET https://api.codemash.io/:version/db/:collectionName/findOne

Gets a record by using a filter. This endpoint accepts GET and POST methods.

Path Parameters

Name

Type

Description

version

string

A version of the API endpoint.

collectionName

string

The name of the collection to get a record from.

Query Parameters

Name

Type

Description

filter

string

Filter document. This allows you to find a record by a custom filter. More about filters follow the link below.

referencedFields

array

Fields to left join. More about referencing fields follow the link below.

addReferencesFirst

boolean

If set to true, left joins first before applying other processing to main records. More about referencing fields follow the link below.

cultureCode

string

Language code. If your record has translatable fields, those fields will only include this specified language. If not provided, will take language from the Accept-Language header.

projection

string

Projection document. This allows you to specify what fields to return decreasing the amount of data transferred. More about projections follow the link below.

includeSchema

boolean

If set to true, includes your collection details in the response.

excludeCulture

boolean

Culture code or Accept-Language header will be used for translatable fields. If you want to get values in all languages, set this as true.

Headers

Name

Type

Description

Authorization

string

Secret API key which belongs to your project or user. Not required if using cookies with a session ID.

x-cm-projectid

string

Your project's ID. Can be passed as a query parameter.

{
    "result": "{ '_id': '5e37136bf59f3a3f940b99a4', 'name': 'John' }",
    "schema": null,
}

var client = new CodeMashClient(apiKey, projectId);
var service = new CodeMashRepository<Person>(client);

var person = await service.FindOneAsync(
    x => x.Id == "{RECORD_ID}",
    new DatabaseFindOneOptions()
);

Check the docs about entities on how the response record is deserialized into your class object.

import { db } from 'codemash';

export async function getEmployeeByUserId(id) {    
    
    const filter = { userId : id };    
    return await db.getRecordWithFilter(collectionName, filter, null);
}

use Codemash\CodemashClient;
use Codemash\CodemashDb;

class CodemashService
{
    protected CodemashDb $codemashDb;
    protected string $collectionName = '{YOUR_COLLECTION_NAME}';

    public function __construct()
    {
        $secretKey = '{YOUR_SECRET_KEY}';
        $projectId = '{YOUR_PROJECT_ID}';

        $client = new CodemashClient($secretKey, $projectId);
        $this->codemashDb = new CodemashDb($client);
    }

    public function findOneByFilter()
    {
        $responseData = $this->codemashDb->findOne([
        	'collectionName' => 'employees',
        	'filter' => [
        		'address' => 'Los Angeles',
        	],
        ]);
    }
}

Check the docs on how to form projections, filters. Check the docs on how to use references.

[FindOne] - Gets record by specified database unique id.

Finds one database record. You can pass projection to return record fields you care about. Also, you can include referenced collections to have all that information in one place. https://docs.codemash.io/api/database/collections/find-one

get

/{version}/db/{CollectionName}//{Id}

Authorizations

Path parameters

Idanyrequired

Id of a record. Required if filter is not set.

CollectionNameanyrequired

Collection name - unique, lowercased, collection name without whitespace. E.g., if your collection title you have entered in the CodeMash dashboard is "Business Trips" then collection name would be "business-trips".

versionanyrequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v2

Query parameters

ExcludeSchemaany

Use the IncludeSchema property when you want to have schema definition in the API response as well. This is useful when you have dynamic data rendering and want to have context over your data structure and how it should be displayed. By default schema is excluded.

ExcludeCultureany

Set ExcludeCulture property to "true" when you want to return all the data translations from translatable fields. This is useful when you want to take care about translations in the front-end side. E.g.: when you want to enter product description in your project supported languages.

IncludeUserNamesany

If your collection record has relationship with the Users collection from the Membership module, you can set IncludeUserNames property to "true" to get full user name and id information altogether without making any extra roundtrip to the server.

IncludeRoleNamesany

If your collection record has relationship with the system Roles from the Membership module, you can set IncludeRoleNames property to "true" to get full role name and id information altogether without making any extra roundtrip to the server.

IncludeCollectionNamesany

If your collection record has relationship with other collections from the Database module, you can set IncludeCollectionNames property to "true" to get display name and id information altogether without making any extra roundtrip to the server.

IncludeTermNamesany

If your collection record has relationship with the taxonomy terms from the Database module, you can set IncludeTermNames property to "true" to get term name and id information altogether without making any extra roundtrip to the server.

AddReferencesFirstany

If true, then references are injected before your list queries are applied

Header parameters

Acceptanyrequired

Accept Header

X-CM-Clusterany

API key of your cluster. Can be passed in a header as X-CM-Cluster.

X-CM-ProjectIdanyrequired

ID of your project. Can be passed in a header as X-CM-ProjectId.

CultureCodeany

Specify culture code when your response from the API should be localised. E.g.: en

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.codemash.io//{version}/db/{CollectionName}/{Id}' \
  --header 'Authorization: YOUR_API_KEY'

200

{
  "schema": {
    "collection_name_as_title": "text",
    "collection_name": "text",
    "ui_schema": "text",
    "json_schema": "text",
    "database_id": "text",
    "schema_id": "text",
    "translatable_fields": [
      "text"
    ]
  },
  "response_status": {
    "error_code": "text",
    "message": "text",
    "stack_trace": "text",
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "errors": [
      {
        "error_code": "text",
        "field_name": "text",
        "message": "text",
        "meta": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ]
  },
  "result": "text"
}

Success

[FindOne] - Gets record by specified database unique id.

post

/{version}/db/{CollectionName}//{Id}

Authorizations

Path parameters

Idanyrequired

Id of a record. Required if filter is not set.

CollectionNameanyrequired

versionanyrequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v2

Query parameters

IncludeTermNamesany

AddReferencesFirstany

If true, then references are injected before your list queries are applied

Header parameters

Acceptanyrequired

Accept Header

X-CM-Clusterany

API key of your cluster. Can be passed in a header as X-CM-Cluster.

X-CM-ProjectIdanyrequired

ID of your project. Can be passed in a header as X-CM-ProjectId.

CultureCodeany

Specify culture code when your response from the API should be localised. E.g.: en

Body

any

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.codemash.io//{version}/db/{CollectionName}/{Id}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json'

200

{
  "schema": {
    "collection_name_as_title": "text",
    "collection_name": "text",
    "ui_schema": "text",
    "json_schema": "text",
    "database_id": "text",
    "schema_id": "text",
    "translatable_fields": [
      "text"
    ]
  },
  "response_status": {
    "error_code": "text",
    "message": "text",
    "stack_trace": "text",
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "errors": [
      {
        "error_code": "text",
        "field_name": "text",
        "message": "text",
        "meta": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ]
  },
  "result": "text"
}

Success