Class ByProjectKeyCategoriesRequestBuilder

Constructors

constructor

Properties

args

Methods

get head post withId withKey

Constructors

constructor

Properties

Protected Readonlyargs

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

Methods

get

  • get(
        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;
            };
        },
    ): ApiRequest<CategoryPagedQueryResponse>

    Either the scope view_products:{projectKey} or view_categories:{projectKey} is required.

    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<CategoryPagedQueryResponse>

head

  • head(
        methodArgs?: {
            headers?: { [key: string]: string | string[] };
            queryArgs?: { where?: string | string[]; [key: string]: QueryParam };
        },
    ): ApiRequest<void>

    Checks if a Category exists for on a given Query Predicate. Returns a 200 OK status if any Categories match the Query Predicate or a 404 Not Found otherwise.

    Parameters

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

    Returns ApiRequest<void>

post

withId

withKey

Settings

Member Visibility

On This Page

Constructors
Properties
Methods