CreateCjsSearchDefinition

POST

https://api.cbf.tcn.com/api/v0alpha/lms/collections/createsearchdefinition

CreateCjsSearchDefinition creates a search definition

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "metadata": {
        "cjs_search_definition_id": "string",
        "name": "string",
        "description": "string",
        "deleted": true,
        "exec_count": 0,
        "exec_success": 0,
        "exec_fail": 0,
        "created_date": "1s",
        "last_edited": "1s"
    },
    "search_fields": [
        {
            "cjs_search_field_id": "string",
            "cjs_search_definition_id": "string",
            "field_name": "string",
            "field_type": "FIELD_TYPE_STRING",
            "field_value": "string"
        }
    ],
    "whitelisted_return_fields": [
        {
            "cjs_search_field_id": "string",
            "cjs_search_definition_id": "string",
            "field_name": "string",
            "field_type": "FIELD_TYPE_STRING",
            "field_value": "string"
        }
    ],
    "blacklisted_return_fields": [
        {
            "cjs_search_field_id": "string",
            "cjs_search_definition_id": "string",
            "field_name": "string",
            "field_type": "FIELD_TYPE_STRING",
            "field_value": "string"
        }
    ],
    "unique_identifiers": [
        {
            "cjs_search_field_id": "string",
            "cjs_search_definition_id": "string",
            "field_name": "string",
            "field_type": "FIELD_TYPE_STRING",
            "field_value": "string"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v0alpha/lms/collections/createsearchdefinition' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "metadata": {
        "cjs_search_definition_id": "string",
        "name": "string",
        "description": "string",
        "deleted": true,
        "exec_count": 0,
        "exec_success": 0,
        "exec_fail": 0,
        "created_date": "1s",
        "last_edited": "1s"
    },
    "search_fields": [
        {
            "cjs_search_field_id": "string",
            "cjs_search_definition_id": "string",
            "field_name": "string",
            "field_type": "FIELD_TYPE_STRING",
            "field_value": "string"
        }
    ],
    "whitelisted_return_fields": [
        {
            "cjs_search_field_id": "string",
            "cjs_search_definition_id": "string",
            "field_name": "string",
            "field_type": "FIELD_TYPE_STRING",
            "field_value": "string"
        }
    ],
    "blacklisted_return_fields": [
        {
            "cjs_search_field_id": "string",
            "cjs_search_definition_id": "string",
            "field_name": "string",
            "field_type": "FIELD_TYPE_STRING",
            "field_value": "string"
        }
    ],
    "unique_identifiers": [
        {
            "cjs_search_field_id": "string",
            "cjs_search_definition_id": "string",
            "field_name": "string",
            "field_type": "FIELD_TYPE_STRING",
            "field_value": "string"
        }
    ]
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "metadata": {
        "cjs_search_definition_id": "string",
        "name": "string",
        "description": "string",
        "deleted": true,
        "exec_count": 0,
        "exec_success": 0,
        "exec_fail": 0,
        "created_date": "1s",
        "last_edited": "1s"
    },
    "search_fields": [
        {
            "cjs_search_field_id": "string",
            "cjs_search_definition_id": "string",
            "field_name": "string",
            "field_type": "FIELD_TYPE_STRING",
            "field_value": "string"
        }
    ],
    "whitelisted_return_fields": [
        {
            "cjs_search_field_id": "string",
            "cjs_search_definition_id": "string",
            "field_name": "string",
            "field_type": "FIELD_TYPE_STRING",
            "field_value": "string"
        }
    ],
    "blacklisted_return_fields": [
        {
            "cjs_search_field_id": "string",
            "cjs_search_definition_id": "string",
            "field_name": "string",
            "field_type": "FIELD_TYPE_STRING",
            "field_value": "string"
        }
    ],
    "unique_identifiers": [
        {
            "cjs_search_field_id": "string",
            "cjs_search_definition_id": "string",
            "field_name": "string",
            "field_type": "FIELD_TYPE_STRING",
            "field_value": "string"
        }
    ]
}

🟢200Success

Modified at 2025-09-26 15:44:58

GetCollectionEntries

GetCjsSearchDefinition