Conga Custom Settings API

openapi: 3.2.0
info:
  title: Administration Custom Settings API
  version: 1.0.0
servers:
- url: https://rls.congacloud.com/api/revenue-admin/v1
security:
- Bearer: []
tags:
- name: CustomSettings
paths:
  /flows:
    get:
      tags:
      - CustomSettings
      summary: List flows
      description: Retrieves the list of the flows.
      responses:
        '200':
          description: OK
        '204':
          description: No Content
    post:
      tags:
      - CustomSettings
      summary: Create flows
      description: Creates one or more custom flows based on the request body.The API also creates display action settings and display column settings with default values, which can be overriden or updated using the settings endpoints.
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Flow'
          text/json:
            schema:
              $ref: '#/components/schemas/Flow'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Flow'
      responses:
        '201':
          description: Created
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Flow'
            application/json:
              schema:
                $ref: '#/components/schemas/Flow'
            text/json:
              schema:
                $ref: '#/components/schemas/Flow'
  /flows/{flowName}/views:
    get:
      tags:
      - CustomSettings
      summary: Retrieve column displays associated with a flow
      description: "Retrieves the column displays for the flow passed in the parameter, based on the Display Column Settings configured and the Display Type. The columns are defined for the following <b>Display Types</b> which correspond to different sections on a CPQ page: \n<ul><li>Cart Line Item</li><li>Cart Total Item</li><li>Mass Update</li><li>Cost Line Item</li><li>Usage Price tiers</li><li>Price Ramps</li><li>Tierd Price</li><li>Related Price</li><li>Line Item Waterfall</li><li>Option Line Item</li></ul><p>The API also retrieves the following details associated with the columns: </p><ul><li> Sequence: Defines sequence in which columns are displayed on CPQ pages.</li><li> Field Name: The name of the column</li><li> Is Editable: Indicates whether the column is editable in CPQ.</li><li>Style: Defines the column text alignment using CSS styles.</li><li> Style Class: Defines the style class used for the column.</li></ul>'"
      parameters:
      - name: flowName
        in: path
        description: The name of the flow
        required: true
        schema:
          type: string
          default: system
      - name: viewFor
        in: query
        description: The component associated with the flow
        schema:
          type: string
          default: Cart
      - name: search
        in: query
        description: Search with view field
        schema:
          type: string
      - name: sort
        in: query
        description: Sort the views
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
    post:
      tags:
      - CustomSettings
      summary: Create views
      description: Creates views for a flow.
      parameters:
      - name: flowName
        in: path
        description: The name of the flow
        required: true
        schema:
          type: string
          default: system
      - name: viewFor
        in: query
        description: The component associated with the flow
        schema:
          type: string
          default: Cart
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/View'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/View'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/View'
      responses:
        '201':
          description: Created
          content:
            text/plain:
              schema:
                type: array
                items: {}
            application/json:
              schema:
                type: array
                items: {}
            text/json:
              schema:
                type: array
                items: {}
    put:
      tags:
      - CustomSettings
      summary: Update flow views
      description: Updates one or more views for a flow record.
      parameters:
      - name: flowName
        in: path
        description: The name of the flow
        required: true
        schema:
          type: string
          default: system
      - name: viewFor
        in: query
        description: The component associated with the flow
        schema:
          type: string
          default: Cart
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/View'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/View'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/View'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items: {}
            application/json:
              schema:
                type: array
                items: {}
            text/json:
              schema:
                type: array
                items: {}
  /flows/{flowName}/views/{viewName}:
    delete:
      tags:
      - CustomSettings
      summary: Delete flow views
      description: Deletes the views for a flow.
      parameters:
      - name: viewName
        in: path
        description: The name of the view
        required: true
        schema:
          type: string
      - name: flowName
        in: path
        description: The name of the flow
        required: true
        schema:
          type: string
          default: system
      - name: viewFor
        in: query
        description: The component associated with the flow
        schema:
          type: string
          default: Cart
      responses:
        '200':
          description: OK
        '404':
          description: Not Found
    get:
      tags:
      - CustomSettings
      summary: Retrieve views associated with a flow
      description: Retrieves the views that are associated with the flow.
      parameters:
      - name: viewName
        in: path
        description: The name of the view
        required: true
        schema:
          type: string
      - name: flowName
        in: path
        description: The name of the flow
        required: true
        schema:
          type: string
          default: system
      - name: viewFor
        in: query
        description: The ccomponent associated with the flow
        schema:
          type: string
          default: Cart
      responses:
        '200':
          description: OK
        '204':
          description: No Content
  /flows/{flowname}:
    delete:
      tags:
      - CustomSettings
      summary: Delete a flow
      description: Deletes a flow based on the flow name provided in the parameter.
      parameters:
      - name: flowname
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: boolean
            application/json:
              schema:
                type: boolean
            text/json:
              schema:
                type: boolean
    get:
      tags:
      - CustomSettings
      summary: Get a flow by name
      description: This API can be used to retrieve a single flow record.
      parameters:
      - name: flowname
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
    put:
      tags:
      - CustomSettings
      summary: Update a flow
      description: updates a flow based on the flow name provided in the parameter.
      parameters:
      - name: flowname
        in: path
        description: ''
        required: true
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Flow'
          text/json:
            schema:
              $ref: '#/components/schemas/Flow'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Flow'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Flow'
            application/json:
              schema:
                $ref: '#/components/schemas/Flow'
            text/json:
              schema:
                $ref: '#/components/schemas/Flow'
  /flows/{flowname}/actions:
    get:
      tags:
      - CustomSettings
      summary: Retrieve actions associated with a flow
      description: " Retrieves actions for the flow passed in the parameter, based on the display action settings configured and the display type. The actions are defined for the following <b>Display Types</b> which correspond to different pages in CPQ:\n <ul><li>Cart Page</li><li>Catalog Page </li><li>Bundle Page </li><li>Attribute Page </li><li>Resolve</li><li> configuration Page </li><li>Installed Products Page</li><li>Analyze Quote </li><li>Cart Summary </li></ul><p> The API also retrieves the following details associated with the actions: </p><ul><li> Sequence: Defines sequence in which actions are displayed on CPQ pages. </li><li>Action: API names of the actions.For example, <i>Finalize</i> and<i>Addmoreproduct</i>.\n</li><li>Action Label Name: Actions lables that displayed on the CPQ pages. For example, <b>Finalize</b> and <b>Close Cart</b>. </li><li> Display As: Defines whether given action is displayed as an<i> Action</i> or<i> Task</i> on the CPQ page. </li><li> Action Area: Defines position on the page where action is displayed.For example, <i>Left</i>, <i>Right</i>, and<i> Center</i>. </li><li> Action Style Class: Defines the style class used for the action. </li><li> Action Page: The name of the Visualforce or custom page that is invoked for the respective action along with action params. </li><li> Behavior: Defines the action page''s behavior on opening the page in a dialog window, new window, or the same window. </li><li> Action type: Defines the action type. For example, <i>Quick Redirect</i>,<i> Save</i>, and<i> Quick Save</i>. </li><li>Is Enabled: Indicates whether the action is enabled or disabled. </li><li>Always Display: Indicates that the actions are displayed even is they are disabled.The disabled actions are grayed out on the CPQ pages. </li></ul>"
      parameters:
      - name: flowname
        in: path
        description: ''
        required: true
        schema:
          type: string
          default: system
      responses:
        '200':
          description: OK
        '204':
          description: No Content
    post:
      tags:
      - CustomSettings
      summary: Create flow actions
      description: Creates 1 or more flow actions.
      parameters:
      - name: flowname
        in: path
        description: ''
        required: true
        schema:
          type: string
          default: system
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: array
              items: {}
            example:
            - DisplayType: DisplayType
              ActionName: ActionName
              Name: Name
              Sequence: 1
              Flow: Flowname
              IsEnabled: true
              ActionArea: Flowname
              DisplayAs: Action
              AlwaysDisplay: true
              ActionLabelName: ActionLabelName
          text/json:
            schema:
              type: array
              items: {}
          application/*+json:
            schema:
              type: array
              items: {}
      responses:
        '201':
          description: Created
          content:
            text/plain:
              schema:
                type: array
                items: {}
            application/json:
              schema:
                type: array
                items: {}
            text/json:
              schema:
                type: array
                items: {}
    put:
      tags:
      - CustomSettings
      summary: Update flow actions
      description: Creates, updates, and deletes flow actions based on the request body, for the flow passed in the parameter.
      parameters:
      - name: flowname
        in: path
        description: ''
        required: true
        schema:
          type: string
          default: system
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: array
              items: {}
            example:
            - DisplayType: DisplayType
              ActionName: ActionName
              Name: Name
              Sequence: 1
              Flow: Flowname
              IsEnabled: true
              ActionArea: Flowname
              DisplayAs: Action
              AlwaysDisplay: true
              ActionLabelName: ActionLabelName
          text/json:
            schema:
              type: array
              items: {}
          application/*+json:
            schema:
              type: array
              items: {}
      responses:
        '201':
          description: Created
          content:
            text/plain:
              schema:
                type: array
                items: {}
            application/json:
              schema:
                type: array
                items: {}
            text/json:
              schema:
                type: array
                items: {}
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/RevenueException'
            application/json:
              schema:
                $ref: '#/components/schemas/RevenueException'
            text/json:
              schema:
                $ref: '#/components/schemas/RevenueException'
  /flows/{flowname}/displays:
    get:
      tags:
      - CustomSettings
      summary: Retrieve column displays associated with a flow
      description: "Retrieves column displays for the flow passed in the parameter, based on the display column settings configured and the display type. The columns are defined for the following <b>Display Types</b> which correspond to different sections on a CPQ page: \n<ul><li>Cart Line Item</li><li>Cart Total Item</li><li>Mass Update</li><li>Cost Line Item</li><li>Usage Price tiers</li><li>Price Ramps</li><li>Tierd Price</li><li>Related Price</li><li>Line Item Waterfall</li><li>Option Line Item</li></ul><p>The API also retrieves the following details associated with the columns: </p><ul><li> Sequence: Defines sequence in which columns are displayed on CPQ pages.</li><li> Field Name: The name of the column</li><li> Is Editable: Indicates whether the column is editable in CPQ.</li><li>Style: Defines the column text alignment using CSS styles.</li><li> Style Class: Defines the style class used for the column.</li></ul>'"
      parameters:
      - name: flowname
        in: path
        description: ''
        required: true
        schema:
          type: string
          default: system
      responses:
        '200':
          description: OK
        '204':
          description: No Content
    post:
      tags:
      - CustomSettings
      summary: Create flow displays
      description: Creates 1 or more displays for a flow.
      parameters:
      - name: flowname
        in: path
        description: ''
        required: true
        schema:
          type: string
          default: system
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: array
              items: {}
            example:
            - DisplayType: DisplayType
              Flow: FlowName
              Name: Name
              FieldLength: 18
              FieldName: FieldName
              FieldType: FieldType
              IsCalculated: true
              IsEditable: true
              IsPricePoint: false
              IsSortable: false
              Label: Label
              ObjectType: null
              Sequence: 1
              Scale: 5
              Style: null
              StyleClass: null
              SObjectName: null
              Controller: null
              IsRichTextchText: false
          text/json:
            schema:
              type: array
              items: {}
          application/*+json:
            schema:
              type: array
              items: {}
      responses:
        '201':
          description: Created
    put:
      tags:
      - CustomSettings
      summary: Update flow displays
      description: Updates 1 more displays for a flow record.
      parameters:
      - name: flowname
        in: path
        description: ''
        required: true
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: array
              items: {}
            example:
            - DisplayType: DisplayType
              Flow: FlowName
              Name: Name
              FieldLength: 18
              FieldName: FieldName
              FieldType: FieldType
              IsCalculated: true
              IsEditable: true
              IsPricePoint: false
              IsSortable: false
              Label: Label
              ObjectType: null
              Sequence: 1
              Scale: 5
              Style: null
              StyleClass: null
              SObjectName: null
              Controller: null
              IsRichTextchText: false
          text/json:
            schema:
              type: array
              items: {}
          application/*+json:
            schema:
              type: array
              items: {}
      responses:
        '201':
          description: Created
        '400':
          description: Bad Request
  /flows/{flowname}/settings:
    get:
      tags:
      - CustomSettings
      summary: Retrieve custom setting defined for a flow
      description: 'Retrieves the custom settings defined for a flow name provided in the parameter. When custom settings are defined at both flow-level and global-level, flow-level take precedence over global settings in response the API retrieves.<p> The API retrieves the following custom settings: </p><ul><li> Config System Properties</li><li>Config Select Config Products Settings</li><li>Config Select Bundle Options Settings</li><li>Incentive System Properties</li><li>Installed Products Settings</li></ul><p>The above-mentioned custom settings are categorized into the following: </p><ul><li>Config Page Settings</li><li>Catalog Page Settings</li><li>Cart Page Settings</li><li>Pricing Engine</li><li>Configuration Engine</li><li>Promotions Settings</li><li>Asset Settings</li><li>Incentives Settings</li><li>Favorite Settings</li></ul>'
      parameters:
      - name: flowname
        in: path
        description: ''
        required: true
        schema:
          type: string
          default: system
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: object
                additionalProperties: {}
            application/json:
              schema:
                type: object
                additionalProperties: {}
            text/json:
              schema:
                type: object
                additionalProperties: {}
        '204':
          description: No Content
  /flows/{flowname}/settings/{settingname}:
    delete:
      tags:
      - CustomSettings
      summary: Delete settings
      description: Deletes a setting or child setting for a flow.
      parameters:
      - name: settingname
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: childsettingname
        in: query
        description: ''
        schema:
          type: string
      - name: flowname
        in: path
        description: ''
        required: true
        schema:
          type: string
          default: system
      responses:
        '200':
          description: OK
        '204':
          description: No Content
    get:
      tags:
      - CustomSettings
      summary: Retrieve custom settings associated with a flow
      description: "Retrieves the following categories of setting associated with a flow name provided in the parameters. \n<ul><li>Config Page Settings</li><li>Catalog Page Settings</li></ul><p>The above-mentioned settings are divided into the following custom settings or child settings which are used in the `settingName` parameter to retrieve the fields belonging to it.</p><ul><li>Config System Properties</li><li>Config Select Config Products Settings</li><li>Config Select Bundle Options Settings</li></ul><p> The `childSettingName` is not supported in this release</p>"
      parameters:
      - name: settingname
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: childsettingname
        in: query
        description: ''
        schema:
          type: string
      - name: flowname
        in: path
        description: ''
        required: true
        schema:
          type: string
          default: system
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: object
                additionalProperties: {}
            application/json:
              schema:
                type: object
                additionalProperties: {}
            text/json:
              schema:
                type: object
                additionalProperties: {}
        '204':
          description: No Content
    post:
      tags:
      - CustomSettings
      summary: Create settings
      description: Creates a setting or child setting for a flow.
      parameters:
      - name: settingname
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: childsettingname
        in: query
        description: ''
        schema:
          type: string
      - name: flowname
        in: path
        description: ''
        required: true
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
            example:
              key1: value1
              key2: value2
          text/json:
            schema:
              type: object
              additionalProperties: {}
          application/*+json:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '201':
          description: Created
          content:
            text/plain:
              schema:
                type: array
                items: {}
            application/json:
              schema:
                type: array
                items: {}
            text/json:
              schema:
                type: array
                items: {}
    put:
      tags:
      - CustomSettings
      summary: Update custom settings associated with a flow
      description: "Updates the following categories of setting associated with a flow name provided in the parameters. \n<ul><li>Config Page Settings</li><li>Catalog Page Settings</li></ul><p>The above-mentioned settings are divided into the following custom settings or child settings which are used in the `settingName` parameter to update the fields belonging to it.</p><ul><li>Config System Properties</li><li>Config Select Config Products Settings</li><li>Config Select Bundle Options Settings</li></ul><p> The `childSettingName` is not supported in this release.</p>"
      parameters:
      - name: settingname
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: childsettingname
        in: query
        description: ''
        schema:
          type: string
      - name: flowname
        in: path
        description: ''
        required: true
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
            example:
              key1: value1
              key2: value2
          text/json:
            schema:
              type: object
              additionalProperties: {}
          application/*+json:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '201':
          description: Created
          content:
            text/plain:
              schema:
                type: array
                items: {}
            application/json:
              schema:
                type: array
                items: {}
            text/json:
              schema:
                type: array
                items: {}
  /flows/{flowname}/settings/{settingname}/{childsettingname}:
    delete:
      tags:
      - CustomSettings
      summary: Delete settings
      description: Deletes a setting or child setting for a flow.
      parameters:
      - name: settingname
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: childsettingname
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: flowname
        in: path
        description: ''
        required: true
        schema:
          type: string
          default: system
      responses:
        '200':
          description: OK
        '204':
          description: No Content
    get:
      tags:
      - CustomSettings
      summary: Retrieve custom settings associated with a flow
      description: "Retrieves the following categories of setting associated with a flow name provided in the parameters. \n<ul><li>Config Page Settings</li><li>Catalog Page Settings</li></ul><p>The above-mentioned settings are divided into the following custom settings or child settings which are used in the `settingName` parameter to retrieve the fields belonging to it.</p><ul><li>Config System Properties</li><li>Config Select Config Products Settings</li><li>Config Select Bundle Options Settings</li></ul><p> The `childSettingName` is not supported in this release</p>"
      parameters:
      - name: settingname
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: childsettingname
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: flowname
        in: path
        description: ''
        required: true
        schema:
          type: string
          default: system
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: object
                additionalProperties: {}
            application/json:
              schema:
                type: object
                additionalProperties: {}
            text/json:
              schema:
                type: object
                additionalProperties: {}
        '204':
          description: No Content
    post:
      tags:
      - CustomSettings
      summary: Create settings
      description: Creates a setting or child setting for a flow.
      parameters:
      - name: settingname
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: childsettingname
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: flowname
        in: path
        description: ''
        required: true
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
            example:
              key1: value1
              key2: value2
          text/json:
            schema:
              type: object
              additionalProperties: {}
          application/*+json:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '201':
          description: Created
          content:
            text/plain:
              schema:
                type: array
                items: {}
            application/json:
              schema:
                type: array
                items: {}
            text/json:
              schema:
                type: array
                items: {}
    put:
      tags:
      - CustomSettings
      summary: Update custom settings associated with a flow
      description: "Updates the following categories of setting associated with a flow name provided in the parameters. \n<ul><li>Config Page Settings</li><li>Catalog Page Settings</li></ul><p>The above-mentioned settings are divided into the following custom settings or child settings which are used in the `settingName` parameter to update the fields belonging to it.</p><ul><li>Config System Properties</li><li>Config Select Config Products Settings</li><li>Config Select Bundle Options Settings</li></ul><p> The `childSettingName` is not supported in this release.</p>"
      parameters:
      - name: settingname
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: childsettingname
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: flowname
        in: path
        description: ''
        required: true
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
            example:
              key1: value1
              key2: value2
          text/json:
            schema:
              type: object
              additionalProperties: {}
          application/*+json:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '201':
          description: Created
          content:
            text/plain:
              schema:
                type: array
                items: {}
            application/json:
              schema:
                type: array
                items: {}
            text/json:
              schema:
                type: array
                items: {}
components:
  schemas:
    RuntimeTypeHandle:
      type: object
      properties:
        Value:
          $ref: '#/components/schemas/IntPtr'
      additionalProperties: false
    FieldInfo:
      type: object
      properties:
        Name:
          type:
          - string
          - 'null'
          readOnly: true
        DeclaringType:
          $ref: '#/components/schemas/Type'
        ReflectedType:
          $ref: '#/components/schemas/Type'
        Module:
          $ref: '#/components/schemas/Module'
        CustomAttributes:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CustomAttributeData'
          readOnly: true
        IsCollectible:
          type: boolean
          readOnly: true
        MetadataToken:
          ty

# --- truncated at 32 KB (73 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/openapi/conga-customsettings-api-openapi.yml