@salesforce/lds-adapters-industries-sales-excellence 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,968 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '57.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v66.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  ActionableListAvailableKpiRepresentation:
+    description: The output representation for a KPI Bar Available metrics in Actionable
+      List screen
+    type: object
+    properties:
+      almsId:
+        description: Available KPIs actionable list member status id
+        type: string | nil
+        required: false
+      description:
+        description: Available KPIs description
+        type: string | nil
+        required: false
+      label:
+        description: Available KPIs label
+        type: string
+      metricId:
+        description: Available KPIs metric id
+        type: string | nil
+        required: false
+  ActionableListSelectedKpiRepresentation:
+    description: Input representation for a Selected KPIs in Actionable List KPI Bar
+    type: object
+    properties:
+      developerName:
+        description: developerName
+        type: string
+  ActionableListSelectedKpisRepresentation:
+    description: Input representation for a list of Selected KPIs
+    type: object
+    properties:
+      selectedKpisList:
+        description: selected KPIs list
+        type: array
+        items:
+          type: object
+  ActionableListFieldsInputRepresentation:
+    description: Input representation for updating actionable list.
+    type: object
+    properties:
+      priority:
+        description: priority
+        type: string
+      isAutoAssignmentAllowed:
+        description: isAutoAssignmentAllowed
+        type: boolean
+        required: false
+      omniScriptKey:
+        description: omniScriptKey
+        type: string
+        required: false
+      sortField:
+        description: sortField
+        type: string
+        required: false
+      sortOrder:
+        description: sortOrder
+        type: string
+        required: false
+      endDate:
+        description: endDate
+        type: string
+        required: false
+  ActionableListMemberFieldsInputRepresentation:
+    description: Input representation for updating actionable list member.
+    type: object
+    properties:
+      assignee:
+        description: assignee
+        type: AssigneeInputRepresentation
+  AdditionalContextRepresentation:
+    description: Input representation for additional context
+    type: object
+    properties:
+      contextRecordId:
+        description: Context record Id of the actionable list
+        type: string
+  AssignActionableListInputRepresentation:
+    description: Input representation for assigning actionable List
+    type: object
+    properties:
+      actionableListFields:
+        description: Sets the value of the fields actionable list.
+        type: ActionableListFieldsInputRepresentation
+      actionableListMemberFields:
+        description: Sets the value of the fields actionable list member.
+        type: ActionableListMemberFieldsInputRepresentation
+      actionableListMemberRecordIds:
+        description: Sets the value of the actionable list member Ids.
+        type: array
+        required: false
+        items:
+          type: string
+      autoAssignee:
+        description: Sets the value of the Auto Assignee.
+        type: object
+        required: false
+  AssignActionableListRepresentation:
+    description: The output representation Actionable list members
+    type: object
+    properties:
+      actionableListId:
+        description: ActionableList ID
+        type: string
+      status:
+        description: Status
+        type: SalesExcellenceStatusRepresentation
+  AssignedActionableListRepresentation:
+    description: The output representation for a user's assigned actionable list
+    type: object
+    properties:
+      id:
+        description: Actionable List Id
+        type: string
+      memberSortBy:
+        description: Actionable List Sort By Field For Actionable List Members
+        type: string | nil
+        required: false
+      memberSortOrder:
+        description: Actionable List Sort Order For Actionable List Members
+        type: string | nil
+        required: false
+      name:
+        description: Actionable List Name
+        type: string | nil
+        required: false
+      priority:
+        description: Actionable List Priority
+        type: string | nil
+        required: false
+      objectName:
+        description: Actionable List Anchor Object Name
+        type: string | nil
+        required: false
+  AssignedActionableListsRepresentation:
+    description: List of actionable lists assigned to the querying user
+    type: object
+    properties:
+      actionableLists:
+        description: List of actionable lists assigned to the querying user
+        type: array
+        items:
+          type: AssignedActionableListRepresentation
+  MetadataDetailRepresentation:
+    description: Output representation of metadata of particular quick action
+    type: object
+    properties:
+      column:
+        description: Field Type of anchor entity for which quick action can be performed
+        type: string
+        required: false
+      label:
+        description: Label name of column of the anchor entity for which quick action can be performed
+        type: string
+        required: false
+  QuickActionsMetadataRepresentation:
+    description: Output representation of metadata of particular quick action
+    type: object
+    properties:
+      metadataDetailRepresentation:
+        description: List of metadata detail for each quick action
+        type: array
+        items:
+          type: MetadataDetailRepresentation
+      quickActionType:
+        description: Type of given quick action
+        type: string
+  ALMStatusCountRepresentation:
+    description: Output representation to display actionable List member status
+    type: object
+    properties:
+      iconName:
+        description: get icon name
+        type: string | nil
+        required: false
+      id:
+        description: get id
+        type: string | nil
+      status:
+        description: get status
+        type: string | nil
+        required: false
+      count:
+        description: get count of members with this status
+        type: integer
+        required: false
+  ActionableListMetadataRepresentation:
+    description: Output representation of status and count and quick action metadata of given Actionable List
+    type: object
+    properties:
+      quickActionList:
+        description: List of quick actions with metadata
+        type: array
+        items:
+          type: QuickActionsMetadataRepresentation
+      statusCountList:
+        description: List of member status with count of ALMs in given Actionable List
+        type: array
+        items:
+          type: ALMStatusCountRepresentation
+  AssigneeInputRepresentation:
+    description: Input representation for assignee of actionable list member
+    type: object
+    properties:
+      name:
+        description: Name
+        type: string
+      type:
+        description: Type
+        type: string
+  AutoAssigneeInputRepresentation:
+    description: Input representation for updating Auto Assignee
+    type: object
+    properties:
+      name:
+        description: Auto Assignee Name
+        type: string
+      type:
+        description: Auto Assignee Type
+        type: string
+  FilterRepresentation:
+    description: Input representation for a filter query
+    type: object
+    properties:
+      fieldName:
+        description: Name of field to be filtered
+        type: string
+      operator:
+        description: operator for filter
+        type: string
+      dataType:
+        description: data type
+        type: string
+        required: false
+      value:
+        description: value for filter
+        type: string
+  FilterRepresentationList:
+    description: Input representation for a list of filters
+    type: object
+    properties:
+      filterList:
+        description: filter by clause list
+        type: array
+        items:
+          type: FilterRepresentation
+  KpiBarInputRepresentation:
+    description: Input representation for KPI Bar fetch in Actionable List screen
+    type: object
+    properties:
+      actionableListId:
+        description: actionableListId
+        type: string
+        required: true
+      filters:
+        description: filter by clause list
+        type: array
+        required: false
+        items:
+          type: FilterRepresentation
+      isFetchAvailableKpis:
+        description: is fetching available KPIs
+        type: boolean
+        required: false
+      slotSize:
+        description: slotSize
+        type: integer
+        required: false
+  ActionableListKpiBarWrapperInputRepresentation:
+    description: wrapper of KpiBarInputRepresentation
+    type: object
+    properties:
+      generateActionableListKpiBar:
+        description: Input representation for KpiBarInputRepresentation
+        type: KpiBarInputRepresentation
+  KpiBarMetricRepresentation:
+    description: The output representation for a KPI Bar metric in Actionable List
+      screen
+    type: object
+    properties:
+      dataType:
+        description: KPI metrics dataType
+        type: string | nil
+      displayOrder:
+        description: KPI metrics sequence number
+        type: integer
+        required: false
+      errorMessage:
+        description: KPI metrics error message
+        type: string
+      filters:
+        description: KPI metric Filters
+        type: array
+        items:
+          type: FilterRepresentation
+      isError:
+        description: KPI metrics isError
+        type: boolean
+      label:
+        description: KPI metric label
+        type: string
+      metricId:
+        description: KPI metrics id
+        type: string | nil
+        required: false
+      almsId:
+        description: Available KPIs actionable list member status id
+        type: string | nil
+        required: false
+      value:
+        description: KPI metric value
+        type: string
+  KpiBarOutputRepresentation:
+    description: KPI Bar representation of Actionable List
+    type: object
+    properties:
+      availableKpis:
+        description: List of Available KPIs available to the querying user
+        type: array
+        items:
+          type: ActionableListAvailableKpiRepresentation
+      isKpiConfigureAllowed:
+        description: Flag that indicates if the current user has permissions to configure
+          KPIs on the given actionable list
+        type: boolean | nil
+        required: false
+      kpiMetrics:
+        description: List of KPI Metrics available to the querying user
+        type: array
+        items:
+          type: KpiBarMetricRepresentation
+      status:
+        description: KPI Bar results status
+        type: StatusResponseRepresentation
+  OrderByRepresentation:
+    description: Input representation of orderBy clause for ActionableListMemberAPI
+    type: object
+    properties:
+      fieldName:
+        description: Name of field
+        type: string
+      nulls:
+        description: nulls first or last
+        type: string
+      operator:
+        description: operator for orderBy
+        type: string
+  OrderByRepresentationList:
+    description: Input representation of orderBy clause list for ActionableListMemberAPI
+    type: object
+    properties:
+      orderByList:
+        description: order by clause list
+        type: array
+        items:
+          type: OrderByRepresentation
+  SalesExcellenceStatusRepresentation:
+    description: Output representation to display the status of an API request
+    type: object
+    properties:
+      code:
+        description: get status code
+        type: integer
+      message:
+        description: get status message
+        type: string
+  SearchActionableListMemberInputRepresentation:
+    description: Input representation for list/search actionable list members API
+    type: object
+    properties:
+      after:
+        description: cursor ref
+        type: string
+        required: false
+      filters:
+        description: filter by clause list
+        type: FilterRepresentationList
+        required: false
+      orderBy:
+        description: order by clause list
+        type: OrderByRepresentationList
+        required: false
+      requireHeaders:
+        description: cursor ref
+        type: boolean
+        required: false
+      scope:
+        description: 'scope '
+        type: string
+      searchTerm:
+        description: searchTerm
+        type: string
+        required: false
+  ActionRepresentation:
+    description: Output representation for custom bulk action
+    type: object
+    properties:
+      componentName:
+        description: get component name
+        type: string
+        required: false
+      componentType:
+        description: get component type
+        type: string
+        required: false
+      displayLabel:
+        description: get display label
+        type: string
+        required: false
+      displayOrder:
+        description: get display order
+        type: integer
+        required: false
+      isAlmAction:
+        description: if the action is an ALM action
+        type: boolean
+        required: false
+  SearchActionableListMemberRepresentation:
+    description: The output representation Actionable list members
+    type: object
+    properties:
+      actions:
+        description: get actions
+        type: array
+        items:
+          type: ActionRepresentation
+        required: false
+      fields:
+        description: A list of fields metadata.
+        type: array
+        items:
+          type: any
+      isColumnsModalVisible:
+        description: is columns modal visible
+        type: boolean
+        required: false
+      nextPageToken:
+        description: nextPage cursor
+        type: string
+        required: true
+      objectName:
+        description: object name
+        type: string
+        required: false
+      records:
+        description: A list of queried records from dataset
+        type: array
+        items:
+          type: any
+  # TODO Hand-rolled W-11656360: SearchActionableListMemberWrapperInputRepresentation added manually
+  SearchActionableListMemberWrapperInputRepresentation:
+    description: wrapper of SearchActionableListMemberInputRepresentation
+    type: object
+    properties:
+      actionableListMemberSearchInput:
+        description: Input representation for SearchActionableListMemberInputRepresentation
+        type: SearchActionableListMemberInputRepresentation
+  # TODO Hand-rolled W-11656360: AssignActionableListWrapperInputRepresentation added manually
+  AssignActionableListWrapperInputRepresentation:
+    description: wrapper of AssignActionableListInputRepresentation
+    type: object
+    properties:
+      assignActionableList:
+        description: Input representation for AssignActionableListInputRepresentation
+        type: AssignActionableListInputRepresentation
+  # TODO Hand-rolled W-13174143: AssignActionableListWrapperInputRepresentation added manually
+  ActionableListMemberQueueRepresentation:
+    description: The output representation for a queue containing user specified search
+      term in its name and has actionable list member in supported object list
+    type: object
+    properties:
+      id:
+        description: Queue Id
+        type: string
+      name:
+        description: Queue Name
+        type: string
+  ActionableListMemberQueuesRepresentation:
+    description: List of queues containing user specified search term in its name
+      and has actionable list member in supported object list
+    type: object
+    properties:
+      nextPageCursor:
+        description: next page cursor of filtered ALM supporting queues
+        type: string
+        required: false
+      queues:
+        description: List of actionable lists assigned to the querying user
+        type: array
+        items:
+          type: ActionableListMemberQueueRepresentation
+  SegmentDetailsListRepresentation:
+    description: Output representation capturing the records from market segment
+    type: object
+    properties:
+      segmentData:
+        description: segment records from market segment
+        type: array
+        items:
+          type: SegmentDetailsRepresentation
+      status:
+        description: get status
+        type: CdpSalesExcellenceStatusRepresentation
+  SegmentDetailsRepresentation:
+    description: List Output representation capturing the records from market segment
+    type: object
+    properties:
+      createdDate:
+        description: get created date
+        type: string
+      dataSpaceDevName:
+        description: get data space dev name
+        type: string | nil
+      dataSpaceName:
+        description: get data space name
+        type: string | nil
+      description:
+        description: get segment description
+        type: string | nil
+      id:
+        description: get market segment id
+        type: string
+      lastPublishedEndDateTime:
+        description: get market segment last published end date time
+        type: string | nil
+      lastSegmentMemberCount:
+        description: get market segment member count
+        type: string | nil
+      mktDataModelObjectId:
+        description: get data model object id
+        type: string
+      mktDataModelObjectNameSpacePrefix:
+        description: get data model object name space prefix
+        type: string | nil
+      name:
+        description: get market segment name
+        type: string
+      publishScheduleInterval:
+        description: get publish schedule interval
+        type: string
+      publishScheduleStartDateTime:
+        description: get publish schedule start date time
+        type: string | nil
+      publishStatus:
+        description: get publish status
+        type: string | nil
+      segmentMembershipTable:
+        description: get segment membership table
+        type: string | nil
+      segmentOn:
+        description: get segment on
+        type: string
+  ActionableListMemberStatusInputRepresentation:
+    description: Input representation for creating Actionable List Member Status
+    type: object
+    properties:
+      iconName:
+        description: Sets the icon name for ALMS
+        type: string
+      isDefault:
+        description: Flag to denote if the status is default
+        type: boolean
+      status:
+        description: Sets the status for ALMS
+        type: string
+  # TODO Hand-rolled W-13609889: CreateActionableListRecordsWrapperInputRepresentation added manually
+  CreateActionableListRecordsWrapperInputRepresentation:
+    description: wrapper of CreateActionableListRecordsInputRepresentation
+    type: object
+    properties:
+      createActionableListRecordsInputRepresentation:
+        description: Input representation for CreateActionableListRecordsInputRepresentation
+        type: CreateActionableListRecordsInputRepresentation
+  CreateActionableListRecordsInputRepresentation:
+    description: Input representation for creating sales excellence entities
+    type: object
+    properties:
+      actionableListDataSetColumns:
+        description: List of actionable list data set columns
+        type: array
+        required: false
+        items:
+          type: string
+      actionableListDescription:
+        description: Set description for Actionable list
+        type: string
+        required: false
+      actionableListMemberStatuses:
+        description: List of actionable list member statuses
+        type: array
+        items:
+          type: object
+      actionableListName:
+        description: Set name for actionable list
+        type: string
+      additionalContext:
+        description: Additional context of the actionable list
+        type: object
+        required: false
+      dataSpaceDevName:
+        description: Set data space dev name for the data space
+        type: string
+      mktDataModelObjectName:
+        description: DataModel Object Name to be filtered
+        type: string
+      mktDataModelObjectNameSpacePrefix:
+        description: DataModel Object Name space to be filtered
+        type: string
+      segmentId:
+        description: Set segment id on actionable list
+        type: string
+      segmentOn:
+        description: Set anchor entity for create actionable list definition
+        type: string
+      smhTableName:
+        description: Set smhTableName to query
+        type: string
+      timestamp:
+        description: Set latest timestamp for the segmentMembershipHistory table
+        type: string
+      synchronizationAllowed:
+        description: Set if synchronization is allowed in actionable list
+        type: boolean
+      type:
+        type: string
+        description: The type of the actionable list that can be created from the
+          actionable list definition.
+        required: false
+  CreateActionableListRecordsRepresentation:
+    description: Output representation for create actionable list definition API
+    type: object
+    properties:
+      actionableListId:
+        description: Id of actionable list
+        type: string | nil
+  # TODO Hand-rolled W-13174143: SegmentPreviewWrapperInputRepresentation added manually
+  SegmentPreviewWrapperInputRepresentation:
+    description: wrapper of SegmentPreviewInputRepresentation
+    type: object
+    properties:
+      segmentPreviewInput:
+        description: Input representation for SegmentPreviewInputRepresentation
+        type: SegmentPreviewInputRepresentation
+  SegmentPreviewInputRepresentation:
+    description: Input representation to fetch the segment data
+    type: object
+    properties:
+      dataSpaceDevName:
+        description: DataSpace Dev Name to be filtered
+        type: string
+      mktDataModelObjectId:
+        description: DataModel Object Id to be filtered
+        type: string
+      mktDataModelObjectNameSpacePrefix:
+        description: DataModel Object Name space to be filtered
+        type: string
+      objectName:
+        description: Object Name to be filtered
+        type: string
+      segmentId:
+        description: Segment ID  to be filtered
+        type: string
+      smhTableName:
+        description: Segment history table name to be filtered
+        type: string
+  SegmentPreviewListRepresentation:
+    description: Output representation capturing the object id's of the selected segment
+    type: object
+    properties:
+      mktDataModelObjectName:
+        description: datamodel object name
+        type: string
+      segmentData:
+        description: objectId's in selected segment
+        type: array
+        items:
+          type: SegmentPreviewRepresentation
+      segmentLatestTimeStamp:
+        description: get cdpSegmentLatestTimeStamp
+        type: string
+      status:
+        description: get status
+        type: CdpSalesExcellenceStatusRepresentation
+  SegmentPreviewRepresentation:
+    description: Output representation capturing the object id's of the selected segment
+    type: object
+    properties:
+      objectId:
+        description: object id of the selected segment object
+        type: string
+  CdpSalesExcellenceStatusRepresentation:
+    description: Output representation to display the status of an API request
+    type: object
+    properties:
+      code:
+        description: get status code
+        type: integer
+      message:
+        description: get status message
+        type: string
+  StatusResponseRepresentation:
+    description: Status response representation
+    type: object
+    properties:
+      code:
+        description: Code for Error
+        type: string
+      message:
+        description: Message stating the reason for error, if any
+        type: string
+  ActionableListKPIMappingInputRepresentation:
+    description: Input representation for maps the selected list of KPI to an actionable
+      list
+    type: object
+    properties:
+      actionableListId:
+        description: The ID of the actionable list for which the key performance indicators are defined
+        type: string
+      selectedKpis:
+        description: selectedKpis
+        type: array
+        items:
+          type: object
+  ActionableListKpiMappingWrapperInputRepresentation:
+    description: wrapper of ActionableListKPIMappingInputRepresentation
+    type: object
+    properties:
+      generateActionableListKpiMapping:
+        description: Input representation for ActionableListKPIMappingInputRepresentation
+        type: ActionableListKPIMappingInputRepresentation
+  ActionableListKPIMappingListRepresentation:
+    description: 'Input representation for a Mapping KPIs in Actionable List '
+    type: object
+    properties:
+      actionableListMemberStatusId:
+        description: actionableListMemberStatusId
+        type: string
+        required: false
+      displayOrder:
+        description: The display order of the KPI that is shown on KPI Bar.
+        type: integer
+        required: false
+      kpiDefinitionId:
+        description: Actionable List Key Performance Indicator Definition Id
+        type: string
+        required: false
+  ActionableListKPIMappingRepresentation:
+    description: KPI Mapping representation of Actionable List
+    type: object
+    properties:
+      actionableListId:
+        description: Actionable List Id
+        type: string
+      status:
+        description: KPI Mapping results status
+        type: StatusResponseRepresentation
+/connect/sales-excellence:
+  /actionable-list-members:
+    post:
+      description: API to list/search actionable list members
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SearchActionableListMemberRepresentation
+      body:
+        application/json:
+          type: SearchActionableListMemberWrapperInputRepresentation
+          # TODO [W-11656360]: Hand Rolled Change that removed 'required: false' since the 'required' property is not allowed in RAML 1.0
+          (oas-body-name): actionableListMemberSearchInput
+  /actionable-list-members/{actionableListId}:
+    post:
+      description: API to list/search actionable list members given an ID of the actionable
+        list
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SearchActionableListMemberRepresentation
+      body:
+        application/json:
+          type: SearchActionableListMemberWrapperInputRepresentation
+          # TODO [W-11656360]: Hand Rolled Change that removed 'required: false' since the 'required' property is not allowed in RAML 1.0
+          (oas-body-name): actionableListMemberSearchInput
+    uriParameters:
+      actionableListId:
+        type: string
+        required: true
+  /actionable-list/assignment/{actionableListId}:
+    post:
+      description: API to assign actionable list given an ID of the actionable list
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: AssignActionableListRepresentation
+      body:
+        application/json:
+          type: AssignActionableListWrapperInputRepresentation
+          # TODO [W-11656360]: Hand Rolled Change that removed 'required: false' since the 'required' property is not allowed in RAML 1.0
+          (oas-body-name): assignActionableList
+    uriParameters:
+      actionableListId:
+        type: string
+        required: true
+  /actionable-list/key-performance-indicators/mappings:
+    post:
+      description: API to maps the selected list of key performance indicators
+        to an actionable list
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ActionableListKPIMappingRepresentation
+      body:
+        application/json:
+          type: ActionableListKpiMappingWrapperInputRepresentation
+          # TODO [W-11656360]: Hand Rolled Change that removed 'required: false' since the 'required' property is not allowed in RAML 1.0
+          (oas-body-name): generateActionableListKpiMapping
+  /actionable-list/kpi:
+    post:
+      description: API to assign actionable list given an ID of the actionable
+        list
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: KpiBarOutputRepresentation
+      body:
+        application/json:
+          type: ActionableListKpiBarWrapperInputRepresentation
+          # TODO [W-11656360]: Hand Rolled Change that removed 'required: false' since the 'required' property is not allowed in RAML 1.0
+          (oas-body-name): generateActionableListKpiBar
+  /actionable-lists:
+    get:
+      description: Get a list of all the actionable lists that are assigned to the
+        calling or querying user.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: AssignedActionableListsRepresentation
+  /actionable-lists/metadata/{actionableListId}:
+    get:
+      description: Get a list of member status with count and metadata
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ActionableListMetadataRepresentation
+      queryParameters:
+        hasMemberStatus:
+          type: boolean
+          required: false
+        hasQuickActions:
+          type: boolean
+          required: false
+        searchTerm:
+          type: string
+          required: false
+    uriParameters:
+      actionableListId:
+        type: string
+        required: true
+  /actionable-list-member/queues:
+    get:
+      displayName: getALMQueues
+      description: API to search queues that has actionable list member as supported
+        object and contains specified searchTerm in their name
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ActionableListMemberQueuesRepresentation
+      queryParameters:
+        nextPageCursor:
+          type: string
+          required: false
+        searchTerm:
+          type: string
+          required: false
+  /cust-data-pfrm:
+    /segments:
+      get:
+        displayName: getSegmentDetails
+        description: method to fetch segments list from market segment entity.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SegmentDetailsListRepresentation
+        queryParameters:
+          dataSpaceId:
+            type: string
+            required: false
+          dataSpacePrefix:
+            type: string
+            required: false
+          searchTerm:
+            type: string
+            required: false
+    /create-records:
+      post:
+        displayName: postCdpSalesExcellence
+        description: API to create actionable list definition
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CreateActionableListRecordsRepresentation
+        body:
+          application/json:
+            type: CreateActionableListRecordsWrapperInputRepresentation
+            # TODO [W-13609889]: Hand Rolled Change that removed 'required: false' since the 'required' property is not allowed in RAML 1.0
+            (oas-body-name): createActionableListRecordsInputRepresentation
+    /segment-preview:
+      post:
+        displayName: postSegmentPreview
+        description: method for fetching object id's from selected segment while
+          creating an actionable list
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SegmentPreviewListRepresentation
+        body:
+          application/json:
+            type: SegmentPreviewWrapperInputRepresentation
+            # TODO [W-13174143]: Hand Rolled Change that removed 'required: false' since the 'required' property is not allowed in RAML 1.0
+            (oas-body-name): segmentPreviewInput