Typescript SDK Type Docs
    Preparing search index...

    Class ByProjectKeyCustomObjectsRequestBuilder

    Index

    Constructors

    constructor

    Properties

    args

    Methods

    get head post withContainer withContainerAndKey

    Constructors

    Properties

    args: {
        baseUri?: string;
        executeRequest: executeRequest;
        pathArgs: { projectKey: string };
    }

    Methods

    • Parameters

      • OptionalmethodArgs: {
            headers?: { [key: string]: string | string[] };
            queryArgs?: {
                expand?: string | string[];
                limit?: number;
                offset?: number;
                sort?: string | string[];
                where?: string | string[];
                withTotal?: boolean;
                [key: string]: QueryParam;
            };
        }

      Returns ApiRequest<CustomObjectPagedQueryResponse>

    • Checks if one or more CustomObjects exist for the provided query predicate. Returns a 200 status if any CustomObjects match the query predicate, or a 404 status otherwise.

      Parameters

      • OptionalmethodArgs: {
            headers?: { [key: string]: string | string[] };
            queryArgs?: { where?: string | string[]; [key: string]: QueryParam };
        }

      Returns ApiRequest<void>

    post

    • post(
          methodArgs: {
              body: CustomObjectDraft;
              headers?: { [key: string]: string | string[] };
              queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
          },
      ): ApiRequest<CustomObject>

      If an object with the given container/key exists, the object will be replaced with the new value and the version is incremented. If the request contains a version and an object with the given container/key, then the version must match the version of the existing object. Concurrent updates to the same Custom Object returns a ConcurrentModification error even if the version is not provided.

      Fields within `value` that have `null` values **are not saved**.

      Parameters

      • methodArgs: {
            body: CustomObjectDraft;
            headers?: { [key: string]: string | string[] };
            queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
        }

      Returns ApiRequest<CustomObject>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods