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