BlackRock Studio Subscriptions:filter API

openapi: 3.2.0
info:
  title: Blackrock Studio Subscriptions:filter API
  version: 1.0.0
  x-aladdin-api-id: agraph.platform.studio.studio_notification.StudioSubscriptionAPI
  x-aladdin-api-stability: alpha
  x-aladdin-spec-id: agraph.platform.studio.studio_notification.v1.StudioSubscriptionAPI
  description: 'Operations tagged StudioSubscriptions:filter across 2 of this provider''s published API definitions: blackrock-studio_subscription-swagger.json, blackrock-studio-subscription-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/platform/studio/studio-notification/v1/
security:
- APIKeyHeader: []
  OAuth2AccessCode:
  - offline_access
  - platform.studio.studio_notification.v1.StudioSubscription
- APIKeyHeader: []
  OAuth2ClientCredentials:
  - offline_access
  - platform.studio.studio_notification.v1.StudioSubscription
- APIKeyHeader: []
  ClientKeyHeader: []
- APIKeyHeader: []
  basicAuth: []
tags:
- name: StudioSubscriptions:filter
paths:
  /studioSubscriptions:filter:
    post:
      security:
      - APIKeyHeader: []
        OAuth2AccessCode:
        - platform.studio.studio_notification.v1.StudioSubscription
      - APIKeyHeader: []
        OAuth2ClientCredentials:
        - platform.studio.studio_notification.v1.StudioSubscription
      - APIKeyHeader: []
        ClientKeyHeader: []
      - APIKeyHeader: []
        basicAuth: []
      description: Filters Studio subscriptions by target entity, specific event, user who subscribed, and time subscribed
      summary: FilterStudioSubscriptions filters studio subscription by event details
      operationId: StudioSubscriptionAPI_FilterStudioSubscriptions
      parameters:
      - description: A unique identifier for this request.
        name: VND.com.blackrock.Request-ID
        in: header
        required: true
        schema:
          type: string
          format: UUID
      - description: Timestamp assigned to this request at origin, in "HTTP-date" format as defined by RFC 7231.
        name: VND.com.blackrock.Origin-Timestamp
        in: header
        required: true
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1FilterStudioSubscriptionsResponse'
        '400':
          description: Aladdin® will not process the request due to an apparent client error.
          headers:
            VND.com.blackrock.Request-ID:
              description: The unique identifier assigned by the client to the request that originated this response.
              schema:
                type: string
                format: UUID
            VND.com.blackrock.Response-ID:
              description: A Unique Identifier for this response.
              schema:
                type: string
                format: UUID
            VND.com.blackrock.Response-Timestamp:
              description: Timestamp assigned to this response, in "HTTP-date" format as defined by RFC 7231.
              schema:
                type: string
                format: date-time
          content:
            application/json:
              schema:
                description: Defines an error that occurred.
                type: object
                required:
                - code
                - message
                properties:
                  code:
                    description: A short mnemonic reference code for the error.
                    type: string
                    maxLength: 40
                  message:
                    description: A human readable description of the error.
                    type: string
        '401':
          description: Aladdin® will not process the request as the necessary credentials were not provided or were invalid.
          headers:
            VND.com.blackrock.Request-ID:
              description: The unique identifier assigned by the client to the request that originated this response.
              schema:
                type: string
                format: UUID
            VND.com.blackrock.Response-ID:
              description: A Unique Identifier for this response.
              schema:
                type: string
                format: UUID
            VND.com.blackrock.Response-Timestamp:
              description: Timestamp assigned to this response, in "HTTP-date" format as defined by RFC 7231.
              schema:
                type: string
                format: date-time
          content:
            application/json:
              schema:
                description: Defines an error that occurred.
                type: object
                required:
                - code
                - message
                properties:
                  code:
                    description: A short mnemonic reference code for the error.
                    type: string
                    maxLength: 40
                  message:
                    description: A human readable description of the error.
                    type: string
        '403':
          description: Aladdin® understood the request but is refusing to authorize it.
          headers:
            VND.com.blackrock.Request-ID:
              description: The unique identifier assigned by the client to the request that originated this response.
              schema:
                type: string
                format: UUID
            VND.com.blackrock.Response-ID:
              description: A Unique Identifier for this response.
              schema:
                type: string
                format: UUID
            VND.com.blackrock.Response-Timestamp:
              description: Timestamp assigned to this response, in "HTTP-date" format as defined by RFC 7231.
              schema:
                type: string
                format: date-time
          content:
            application/json:
              schema:
                description: Defines an error that occurred.
                type: object
                required:
                - code
                - message
                properties:
                  code:
                    description: A short mnemonic reference code for the error.
                    type: string
                    maxLength: 40
                  message:
                    description: A human readable description of the error.
                    type: string
        '404':
          description: Aladdin® did not find the resource requested or is unwilling to disclose if it exists. Could indicate a defect in the client program or data which is no longer accessible.
          headers:
            VND.com.blackrock.Request-ID:
              description: The unique identifier assigned by the client to the request that originated this response.
              schema:
                type: string
                format: UUID
            VND.com.blackrock.Response-ID:
              description: A Unique Identifier for this response.
              schema:
                type: string
                format: UUID
            VND.com.blackrock.Response-Timestamp:
              description: Timestamp assigned to this response, in "HTTP-date" format as defined by RFC 7231.
              schema:
                type: string
                format: date-time
          content:
            application/json:
              schema:
                description: Defines an error that occurred.
                type: object
                required:
                - code
                - message
                properties:
                  code:
                    description: A short mnemonic reference code for the error.
                    type: string
                    maxLength: 40
                  message:
                    description: A human readable description of the error.
                    type: string
      x-quota-limit: 1000
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1FilterStudioSubscriptionsRequest'
        required: true
      tags:
      - StudioSubscriptions:filter
    servers:
    - url: /api/platform/studio/studio-notification/v1/
components:
  schemas:
    v1StudioSubscriptionsQuery:
      description: The query required to perform a filter studio subscription call.
      type: object
      properties:
        studioEntityType:
          title: Type of entity we are filtering subscription on
          $ref: '#/components/schemas/v1StudioEntityType'
        studioEntityName:
          type: string
          title: Name of entity we are filtering subscription on
        studioNotificationEventType:
          title: Type of event we are filtering subscription on
          $ref: '#/components/schemas/v1StudioNotificationEventType'
        studioNotificationEventName:
          type: string
          title: Name of the event we are filtering subscription on
        userId:
          type: string
          title: user id of the studio subscription
        dateRangeFilter:
          title: Range filter
          $ref: '#/components/schemas/v1RangeFilter'
    v1StudioSubscription:
      type: object
      title: StudioSubscription describes a subscription to a Studio notification
      properties:
        id:
          type: string
          title: id is the unique identifier of a subscription
        user:
          type: string
          title: user is the user that is subscribed to a notification
        studioNotificationEvent:
          title: studio_notification_event is the type of notification the user is subscribed to
          $ref: '#/components/schemas/v1StudioNotificationEvent'
        studioNotificationScope:
          title: studio_notification_scope is the scope of who this notification will be sent to matched by the subscription
          $ref: '#/components/schemas/v1StudioNotificationScope'
        studioNotificationAction:
          title: action is the type of method the user will receive the notification
          $ref: '#/components/schemas/v1StudioNotificationAction'
        email:
          type: string
          title: email is the email address of the user that has this subscription
        creationDateTime:
          type: string
          format: date-time
          title: creation_date_time is the time the subscription was created
    v1RangeFilter:
      type: object
      title: Range Filter for filter requests across apis
      properties:
        startDate:
          type: string
          format: date
          title: Start range
        endDate:
          type: string
          format: date
          title: End range
    v1FilterStudioSubscriptionsRequest:
      description: The request body of the filter studio subscriptions call.
      type: object
      properties:
        query:
          description: The query used to filter against studio subscriptions.
          $ref: '#/components/schemas/v1StudioSubscriptionsQuery'
        pageToken:
          description: The starting point of a query result.
          type: string
        pageSize:
          description: 'The maximum number of studio notifications to be returned per page of results. The maximum allowed page size is 1000.


            Default is 100 if empty or a number < 1 is specified.'
          type: integer
          format: int32
    v1FilterStudioSubscriptionsResponse:
      description: The response for filter studio subscriptions method.
      type: object
      required:
      - studioSubscriptions
      properties:
        studioSubscriptions:
          description: The studio subscription entities that match the specified respective filter request.
          type: array
          required:
          - studio_subscriptions
          items:
            $ref: '#/components/schemas/v1StudioSubscription'
        nextPageToken:
          description: A token to retrieve the next page of results.
          type: string
    v1StudioEntityType:
      description: "- STUDIO_ENTITY_TYPE_UNSPECIFIED: Unspecified\n - STUDIO_ENTITY_TYPE_USER: User\n - STUDIO_ENTITY_TYPE_PROJECT: Project\n - STUDIO_ENTITY_TYPE_SPACE: Space"
      type: string
      title: StudioEntityType is the entity type of the notification receiver
      default: STUDIO_ENTITY_TYPE_UNSPECIFIED
      enum:
      - STUDIO_ENTITY_TYPE_UNSPECIFIED
      - STUDIO_ENTITY_TYPE_USER
      - STUDIO_ENTITY_TYPE_PROJECT
      - STUDIO_ENTITY_TYPE_SPACE
    v1StudioNotificationEvent:
      type: object
      title: StudioNotificationEvent contains the information about the event that triggers a Studio notification
      properties:
        studioNotificationEventType:
          title: studio_notification_event_type is the type of event that triggered the notification e.g. NOTIFICATION_TYPE_PROJECT
          $ref: '#/components/schemas/v1StudioNotificationEventType'
        eventName:
          type: string
          title: name is the name of the event specific to the type of notification e.g. project_user_added
    v1StudioNotificationAction:
      description: "- STUDIO_NOTIFICATION_ACTION_UNSPECIFIED: Unspecified\n - STUDIO_NOTIFICATION_ACTION_SMTP: Email notification\n - STUDIO_NOTIFICATION_ACTION_PUSH: Studio UI push notification"
      type: string
      title: StudioNotificationAction describes the method in which the user will receive the notification
      default: STUDIO_NOTIFICATION_ACTION_UNSPECIFIED
      enum:
      - STUDIO_NOTIFICATION_ACTION_UNSPECIFIED
      - STUDIO_NOTIFICATION_ACTION_SMTP
      - STUDIO_NOTIFICATION_ACTION_PUSH
    v1StudioNotificationEventType:
      description: "- STUDIO_NOTIFICATION_EVENT_TYPE_UNSPECIFIED: Unspecified\n - STUDIO_NOTIFICATION_EVENT_TYPE_ACM: Aladdin Credit Management\n - STUDIO_NOTIFICATION_EVENT_TYPE_COMPUTE: Studio Compute\n - STUDIO_NOTIFICATION_EVENT_TYPE_API: API Applications\n - STUDIO_NOTIFICATION_EVENT_TYPE_SPACE: Studio Space\n - STUDIO_NOTIFICATION_EVENT_TYPE_PROJECT: Studio Project"
      type: string
      title: StudioNotificationEventType is the type of Studio notification
      default: STUDIO_NOTIFICATION_EVENT_TYPE_UNSPECIFIED
      enum:
      - STUDIO_NOTIFICATION_EVENT_TYPE_UNSPECIFIED
      - STUDIO_NOTIFICATION_EVENT_TYPE_ACM
      - STUDIO_NOTIFICATION_EVENT_TYPE_COMPUTE
      - STUDIO_NOTIFICATION_EVENT_TYPE_API
      - STUDIO_NOTIFICATION_EVENT_TYPE_SPACE
      - STUDIO_NOTIFICATION_EVENT_TYPE_PROJECT
    v1StudioNotificationScope:
      type: object
      title: StudioNotificationScope describes the notification receiver
      properties:
        studioEntityType:
          title: studio_entity_type is the entity type of the notification receiver
          $ref: '#/components/schemas/v1StudioEntityType'
        studioEntityName:
          type: string
          title: studio_entity_name is the name of the targeted notification receiver
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      name: VND.com.blackrock.API-Key
      in: header
    ClientKeyHeader:
      type: apiKey
      name: X-API-Key
      in: header
    OAuth2AccessCode:
      type: oauth2
      flows:
        authorizationCode:
          scopes:
            offline_access: This keeps you signed in to the app, even when you are not using it.
            platform.studio.studio_notification.v1.StudioSubscription: This grants access to all endpoints in the platform.studio.studio_notification.v1.StudioSubscription API
          authorizationUrl: https://client.blackrock.com/api/oauth2/default/v1/authorize
          tokenUrl: https://client.blackrock.com/api/oauth2/default/v1/token
      description: This API uses OAuth 2.0 with the access code flow.
    OAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          scopes:
            offline_access: This keeps you signed in to the app, even when you are not using it.
            platform.studio.studio_notification.v1.StudioSubscription: This grants access to all endpoints in the platform.studio.studio_notification.v1.StudioSubscription API
          tokenUrl: https://client.blackrock.com/api/oauth2/default/v1/token
      description: This API uses OAuth 2.0 with the client credentials flow.
    basicAuth:
      type: http
      scheme: basic
x-refined-from:
- blackrock-studio_subscription-swagger.json
- blackrock-studio-subscription-openapi.yml
x-access-level: Internal
x-provenance:
  method: harvested
  publisher: BlackRock
  source: https://raw.githubusercontent.com/blackrock/aladdinsdk/HEAD/aladdinsdk/api/codegen/platform/studio/studio_notification/v1/studio_subscription/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)