Blackbaud Ad Hoc Query API

openapi: 3.2.0
info:
  title: Blackbaud Ad Hoc Query API
  version: '1.0'
  x-refined-note:
  - x-apievangelist-provenance differs across the merged source definitions and was not carried
  description: 'Operations tagged AdHocQuery across 2 of this provider''s published API definitions: blackbaud-altru-analysis-api-openapi.yml, blackbaud-crm-analysis-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.sky.blackbaud.com/alt-anamg
- url: https://api.sky.blackbaud.com/crm-anamg
security:
- Bb-Api-Subscription-Key: []
  OAuth2: []
tags:
- name: AdHocQuery
paths:
  /AdHocQuery/GetDefinition:
    get:
      operationId: AdHocQueryGetDefinition
      summary: Get an ad-hoc query definition
      description: Gets the definition of a saved ad-hoc query, including its selected fields, filters, sorts, and metadata.
      responses:
        '200':
          description: Returned when the operation successfully creates the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdHocQueryGetDefinitionResponse'
              example:
                changed_by_user_name: rhernandez - rhernandez@net.com
                owner: rhernandez - rhernandez@net.com
                date_changed: '2024-11-15T12:01:46Z'
                date_added: '2024-11-07T12:35:29Z'
                changed_by_id: 6a9d7944-5f04-4ecb-82cf-9af702c98c86
                added_by_id: 6a9d7944-5f04-4ecb-82cf-9af702c98c86
                record_type: Constituent
                select_fields:
                  column_name:
                  - AGE
                  - FIRSTNAME
                  - GENDERCODEID_TRANSLATION
                  - FORMATTEDNAME
                filter_fields:
                - object_name: V_QUERY_CONSTITUENT
                  column_name: FIRSTNAME
                  parent_path: V_QUERY_CONSTITUENT
                  display_path: V_QUERY_CONSTITUENT
                  include_current_node: 'true'
                  data_mart_last_refresh: '0001-01-01T12:00:00Z'
                  values: alex
                  translated_values: alex
                  data_type: String
                - object_name: V_QUERY_CONSTITUENT
                  column_name: AGE
                  parent_path: V_QUERY_CONSTITUENT
                  display_path: V_QUERY_CONSTITUENT
                  include_current_node: 'true'
                  filter_operator: IsGreaterThan
                  compare_type: And
                  data_mart_last_refresh: '0001-01-01T12:00:00Z'
                  values: '20'
                  translated_values: '20'
                  data_type: String
                sort_fields:
                - alias_name: Gender
                  sort_order: Descending
                - alias_name: First name
                  sort_order: Ascending
                group_filter_fields: null
        '400':
          description: Returned when the request body is not in the appropriate format.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Returned when the user does not have permission to create the resource.
        '404':
          description: Returned when the specified resource is not found.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      tags:
      - AdHocQuery
    servers:
    - url: https://api.sky.blackbaud.com/alt-anamg
components:
  schemas:
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          description: A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank".
        title:
          type: string
          description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
        status:
          type: integer
          description: The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
          format: int32
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem.
        instance:
          type: string
          description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
        trace_id:
          type: string
          description: A request ID that can be provided to Blackbaud Support that may help with further troubleshooting.
        span_id:
          type: string
          description: A request ID that can be provided to Blackbaud Support that may help with further troubleshooting.
      additionalProperties: false
      description: A machine-readable format for specifying errors in HTTP API responses based on https://tools.ietf.org/html/rfc7807.
      x-display-name: Problem details
      x-display-id: ProblemDetails
    AdHocQueryGetDefinitionFilterFields:
      type: object
      properties:
        object_name:
          type: string
          description: The object name.
        column_name:
          type: string
          description: The column name.
        parent_path:
          type: string
          description: The parent path.
        display_path:
          type: string
          description: The display path.
        id_set_field:
          type: boolean
          description: The ID set field.
        filter_operator:
          type: boolean
          description: The filter operator.
        field:
          type: string
          description: The field.
        use_left_parenthesis:
          type: boolean
          description: Indicates whether to use a left parenthesis.
        use_right_parenthesis:
          type: boolean
          description: Indicates whether to use a right parenthesis.
        left_parenthesis_count:
          type: integer
          description: The left parenthesis count.
        right_parenthesis_count:
          type: integer
          description: The right parenthesis count.
        include_blanks:
          type: boolean
          description: Indicates whether to include blanks.
        value_is_output_field:
          type: boolean
          description: Indicates whether value is output field.
        meets_all_criteria:
          type: boolean
          description: Indicates whether all criteria must be met.
        meets_none_of_the_criteria:
          type: boolean
          description: Indicates whether none of the criteria are met.
        meets_none_of_the_criteria_not_equal_to:
          type: boolean
          description: Indicates whether none of the not-equal-to criteria are met.
        include_current_node:
          type: boolean
          description: Indicates whether to include the current node.
        compare_type:
          type: string
          description: Compare type.
        data_mart_last_refresh:
          $ref: '#/components/schemas/FuzzyDate'
        id_set_field_info:
          type: object
          description: ID set field info.
        date_filter_types:
          type: object
          description: Date filter types.
        fuzzy_date_filter_types:
          type: object
          description: Fuzzy date filter types.
        month_day_filter_types:
          type: object
          description: Month day filter types.
        values:
          type: string
          description: Values.
        translated_values:
          type: string
          description: Translated values.
        data_type:
          type: string
          description: The data type.
      description: Defines the shape of an ad-hoc query definition filter field.
      x-display-name: filter_fields
      x-display-id: filter_fields
    AdHocQueryGetDefinitionSelectFields:
      type: object
      properties:
        column_name:
          type: array
          items:
            type: string
          description: The column name.
      description: Defines the shape of an ad-hoc query definition select field.
      x-display-name: select_fields
      x-display-id: select_fields
    AdHocQueryGetDefinitionSortFields:
      type: object
      properties:
        field_name:
          type: string
          description: The field name.
        sort_order:
          type: string
          description: The sort order.
      description: Defines the shape of an ad-hoc query definition sort field.
      x-display-name: sort_fields
      x-display-id: sort_fields
    AdHocQueryGetDefinitionResponse:
      type: object
      properties:
        owner:
          type: string
          description: The owner.
        added_by_user_name:
          type: string
          description: The added by user name.
        added_by_id:
          type: string
          description: The added by ID.
        changed_by_id:
          type: string
          description: The changed by ID.
        date_changed:
          type: string
          description: The date changed.
        date_added:
          $ref: '#/components/schemas/FuzzyDate'
        changed_by_user_name:
          type: string
          description: The changed by user name.
        record_type:
          type: string
          description: The record type.
        select_fields:
          type: object
          items:
            $ref: '#/components/schemas/AdHocQueryGetDefinitionSelectFields'
          description: The selected fields.
        filter_fields:
          type: array
          items:
            $ref: '#/components/schemas/AdHocQueryGetDefinitionFilterFields'
          description: The filter fields.
        sort_fields:
          type: array
          items:
            $ref: '#/components/schemas/AdHocQueryGetDefinitionSortFields'
          description: The sort fields.
        group_filter_fields:
          type: array
          items:
            $ref: '#/components/schemas/AdHocQueryGetDefinitionGroupFilterFields'
          description: The group filter fields.
      additionalProperties: false
      description: Defines the shape of an ad-hoc query definition response object.
    AdHocQueryGetDefinitionGroupFilterFields:
      type: object
      properties:
        aggregate_type:
          type: string
          description: The aggregate type.
      description: Defines the shape of an ad-hoc query definition group filter field.
      x-display-name: group_filter_fields
      x-display-id: group_filter_fields
    FuzzyDate:
      type: object
      properties:
        year:
          type: integer
          description: The year.
          format: int32
        month:
          type: integer
          description: The month.
          format: int32
        day:
          type: integer
          description: The day.
          format: int32
      description: FuzzyDate
      example:
        year: 2024
        month: 4
        day: 13
      x-display-name: Month Day
      x-display-id: Month Day
  securitySchemes:
    Bb-Api-Subscription-Key:
      type: apiKey
      name: Bb-Api-Subscription-Key
      in: header
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.blackbaud.com/oauth/authorize
          tokenUrl: https://oauth2.sky.blackbaud.com/token
          scopes: {}
x-refined-from:
- blackbaud-altru-analysis-api-openapi.yml
- blackbaud-crm-analysis-api-openapi.yml