Core
Framework v2.x
2

RequestPayload #

Available since 2.8.0
Experimental: non-backward compatible changes or removal may occur in any future release.

The RequestPayload type represents an API request sent to Kuzzle in JSON format.

This type is meant to be used with the SDK query method.

See the API KuzzleRequest Format documentation.

Copied to clipboard!
/*
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
  * Copyright 2015-2020 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  * https://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
import { JSONObject} from '../../index';
/**
  * Kuzzle API request payload
  *
  * @see https://docs.kuzzle.io/core/2/api/payloads/request
  */
export type RequestPayload = {
  /**
    * API controller name
    */
  controller: string;
  /**
    * API action name
    */
  action: string;
  /**
    * Index name
    */
  index?: string;
  /**
    * Collection name
    */
  collection?: string;
  /**
    * Document unique identifier
    */
  _id?: string;
  /**
    * Authentication token
    */
  jwt?: string;
  /**
    * Volatile data
    */
  volatile?: JSONObject;
  /**
    * Request body
    */
  body?: JSONObject;
  /**
    * Request unique identifier
    */
  requestId?: string;
  [key: string]: any;
}

Example:

Copied to clipboard!
import { RequestPayload } from 'kuzzle';

const requestPayload: RequestPayload = {
  controller: 'document',
  action: 'create',
  index: 'nyc-open-data',
  collection: 'yellow-taxi',
  body: {
    licence: 'B'
  }
};