Class ByProjectKeyCustomObjectsRequestBuilder

Constructors

constructor

Properties

args

Methods

get head post withContainer withContainerAndKey

Constructors

constructor

Properties

Protected Readonly args

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

Type declaration

  • Optional baseUri?: string
  • executeRequest: executeRequest
  • pathArgs: {
        projectKey: string;
    }
    • projectKey: string

Methods

get

  • get(methodArgs?): ApiRequest<CustomObjectPagedQueryResponse>

  • Parameters

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

    Returns ApiRequest<CustomObjectPagedQueryResponse>

    Deprecated

head

  • head(methodArgs?): ApiRequest<void>

  • Checks if a CustomObject exists for a given Query Predicate. Returns a 200 OK status if any CustomObjects match the Query Predicate or a 404 Not Found otherwise.

    Parameters

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

    Returns ApiRequest<void>

post

  • post(methodArgs): 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 with `null` values will **not be saved**.

    Parameters

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

    Returns ApiRequest<CustomObject>

withContainer

withContainerAndKey

Settings

Member Visibility

Theme

On This Page

constructorargsgetheadpostwithContainerwithContainerAndKey