SapccApiGetComponentsByIdsAndUserRequest
Request parameters for getComponentsByIdsAndUser operation in SapccApi. SapccApiGetComponentsByIdsAndUserRequest
interface SapccApiGetComponentsByIdsAndUserRequest {
readonly baseSiteId: string;
readonly catalogCode?: string;
readonly categoryCode?: string;
readonly componentIds?: Array<string>;
readonly currentPage?: number;
readonly fields?: GetComponentsByIdsAndUserFieldsEnum;
readonly pageSize?: number;
readonly productCode?: string;
readonly sort?: string;
readonly userId: string;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
baseSiteId | Required | string | Base site identifier {string} SapccApiGetComponentsByIdsAndUser |
catalogCode | Optional | string | Catalog code {string} SapccApiGetComponentsByIdsAndUser |
categoryCode | Optional | string | Category code {string} SapccApiGetComponentsByIdsAndUser |
componentIds | Optional | Array<string> | List of Component identifiers {Array<string>} SapccApiGetComponentsByIdsAndUser |
currentPage | Optional | number | Current result page. Default value is 0. {number} SapccApiGetComponentsByIdsAndUser |
fields | Optional | GetComponentsByIdsAndUserFieldsEnum | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL. {'BASIC' | 'DEFAULT' | 'FULL'} SapccApiGetComponentsByIdsAndUser |
pageSize | Optional | number | Number of results returned per page. Default value: 10. {number} SapccApiGetComponentsByIdsAndUser |
productCode | Optional | string | Product code {string} SapccApiGetComponentsByIdsAndUser |
sort | Optional | string | Sorting method applied to the return results. {string} SapccApiGetComponentsByIdsAndUser |
userId | Required | string | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user {string} SapccApiGetComponentsByIdsAndUser |