Class ByProjectKeyMeBusinessUnitsRequestBuilder

Index

Constructors

constructor

new ByProjectKeyMeBusinessUnitsRequestBuilder(args): ByProjectKeyMeBusinessUnitsRequestBuilder
Parameters
- args: {
      baseUri?: string;
      executeRequest: executeRequest;
      pathArgs: {
          projectKey: string;
      };
  }
  - Optional baseUri?: string
  - executeRequest: executeRequest
  - pathArgs: {
    projectKey: string;
    }
    - projectKey: string
Returns ByProjectKeyMeBusinessUnitsRequestBuilder
- Defined in generated/client/business-units/by-project-key-me-business-units-request-builder.ts:18

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<BusinessUnitPagedQueryResponse>
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<BusinessUnitPagedQueryResponse>
- Defined in generated/client/business-units/by-project-key-me-business-units-request-builder.ts:52

head

head(methodArgs?): ApiRequest<void>
Checks if a BusinessUnit exists for a given Query Predicate. Returns a 200 OK status if any BusinessUnits 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>
- Defined in generated/client/business-units/by-project-key-me-business-units-request-builder.ts:83

post

post(methodArgs): ApiRequest<BusinessUnit>
Automatically assigns the Associate to the Business Unit in the default Associate Role defined in BusinessUnitConfiguration. If there is no default Associate Role configured, this request fails with an InvalidOperation error. When creating a Division, the Associate must have the AddChildUnits Permission in the parent unit. If the required Permission is missing, an AssociateMissingPermission error is returned.
Parameters
- methodArgs: {
      body: MyBusinessUnitDraft;
      headers?: {
          [key: string]: string | string[];
      };
      queryArgs?: {
          expand?: string | string[];
          [key: string]: QueryParam;
      };
  }
  - body: MyBusinessUnitDraft
  - 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<BusinessUnit>
- Defined in generated/client/business-units/by-project-key-me-business-units-request-builder.ts:110

withId

withId(childPathArgs): ByProjectKeyMeBusinessUnitsByIDRequestBuilder
Parameters
- childPathArgs: {
  ID: string;
  }
  - ID: string
Returns ByProjectKeyMeBusinessUnitsByIDRequestBuilder
- Defined in generated/client/business-units/by-project-key-me-business-units-request-builder.ts:27

withKey

withKey(childPathArgs): ByProjectKeyMeBusinessUnitsKeyByKeyRequestBuilder
Parameters
- childPathArgs: {
  key: string;
  }
  - key: string
Returns ByProjectKeyMeBusinessUnitsKeyByKeyRequestBuilder
- Defined in generated/client/business-units/by-project-key-me-business-units-request-builder.ts:39

Class ByProjectKeyMeBusinessUnitsRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional baseUri?: string

executeRequest: executeRequest

pathArgs: { projectKey: string; }

projectKey: string

Returns ByProjectKeyMeBusinessUnitsRequestBuilder

Properties

Protected Readonly args

Type declaration

Optional baseUri?: string

executeRequest: executeRequest

pathArgs: { projectKey: string; }

projectKey: string

Methods

get

Parameters

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

head

Parameters

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

Parameters

body: MyBusinessUnitDraft

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

withId

Parameters

ID: string

Returns ByProjectKeyMeBusinessUnitsByIDRequestBuilder

withKey

Parameters

key: string

Returns ByProjectKeyMeBusinessUnitsKeyByKeyRequestBuilder

Settings

Member Visibility

Theme

On This Page

`Optional` baseUri?: string

pathArgs: {
projectKey: string;
}

`Protected` `Readonly` args

`Optional` baseUri?: string

pathArgs: {
projectKey: string;
}

`Optional` headers?: {
[key: string]: string | string[];
}

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

`Optional` expand?: string | string[]

`Optional` limit?: number

`Optional` offset?: number

`Optional` sort?: string | string[]

`Optional` where?: string | string[]

`Optional` withTotal?: boolean

`Optional` headers?: {
[key: string]: string | string[];
}

`Optional` queryArgs?: {
where?: string | string[];
[key: string]: QueryParam;
}

`Optional` where?: string | string[]

`Optional` headers?: {
[key: string]: string | string[];
}

`Optional` queryArgs?: {
expand?: string | string[];
[key: string]: QueryParam;
}

`Optional` expand?: string | string[]