openapi: 3.2.0
info:
  title: Logicmonitor Applies To Functions API
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: '1.0'
  description: 'Operations tagged AppliesToFunctions across 2 of this provider''s published API definitions: logicmonitor-rest-api-v2-swagger.json, logicmonitor-rest-api-v3-swagger.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /santaba/rest
tags:
- name: AppliesToFunctions
paths:
  /setting/functions/{id}:
    patch:
      summary: update applies to function
      security:
      - LMv1: []
      description: ''
      operationId: patchAppliesToFunction
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppliesToFunction'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
          format: int32
          pattern: \d+
      - in: query
        name: reason
        required: false
        schema:
          type: string
      - in: query
        name: ignoreReference
        required: false
        schema:
          type: boolean
          default: false
      tags:
      - AppliesToFunctions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppliesToFunction'
    get:
      summary: get applies to function
      security:
      - LMv1: []
      description: ''
      operationId: getAppliesToFunctionById
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppliesToFunction'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
          format: int32
          pattern: \d+
      tags:
      - AppliesToFunctions
    delete:
      summary: delete applies to function
      security:
      - LMv1: []
      description: ''
      operationId: deleteAppliesToFunctionById
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
          format: int32
          pattern: \d+
      - in: query
        name: ignoreReference
        required: false
        schema:
          type: boolean
          default: false
      tags:
      - AppliesToFunctions
    put:
      summary: update applies to function
      security:
      - LMv1: []
      description: ''
      operationId: updateAppliesToFunction
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppliesToFunction'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
          format: int32
          pattern: \d+
      - in: query
        name: reason
        required: false
        schema:
          type: string
      - in: query
        name: ignoreReference
        required: false
        schema:
          type: boolean
          default: false
      tags:
      - AppliesToFunctions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppliesToFunction'
    servers:
    - url: /santaba/rest
  /setting/functions:
    post:
      summary: add applies to function
      security:
      - LMv1: []
      description: ''
      operationId: addAppliesToFunction
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppliesToFunction'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - AppliesToFunctions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppliesToFunction'
    get:
      summary: get applies to function list
      security:
      - LMv1: []
      description: ''
      operationId: getAppliesToFunctionList
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestAppliesToFunctionPaginationResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: query
        name: fields
        required: false
        schema:
          type: string
      - in: query
        name: size
        required: false
        schema:
          type: integer
          format: int32
          default: 50.0
      - in: query
        name: offset
        required: false
        schema:
          type: integer
          format: int32
          default: 0.0
      - in: query
        name: filter
        required: false
        schema:
          type: string
      tags:
      - AppliesToFunctions
    servers:
    - url: /santaba/rest
  /setting/functions/importjson:
    post:
      summary: Import AppliesTo function via json
      security:
      - LMv1: []
      x-minimum-permissions:
        Modules ->  All Installed modules: Manage
        Modules -> Access Groups: Manage
      description: Import a AppliesTo function using json data
      operationId: importAppliesToFunctionJson
      responses:
        '200':
          description: Successfully imported the AppliesTo function via Json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppliesToFunction_2'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: query
        name: handleConflict
        schema:
          type: string
      - in: query
        name: fieldsToPreserve
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      tags:
      - AppliesToFunctions
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
    servers:
    - url: /santaba/rest
components:
  schemas:
    RestAppliesToFunctionPaginationResponse:
      type: object
      properties:
        total:
          format: int32
          readOnly: true
          type: integer
        searchId:
          readOnly: true
          type: string
        items:
          type: array
          items:
            $ref: '#/components/schemas/AppliesToFunction'
    AppliesToFunction:
      type: object
      required:
      - code
      - name
      properties:
        code:
          description: The AppliesTo Function code. Note that special characters may need to be escaped.
          type: string
        name:
          description: The name of the AppliesTo Function
          type: string
        description:
          description: The description of the AppliesTo Function
          type: string
        id:
          format: int32
          description: The ID of the AppliesTo Function
          readOnly: true
          type: integer
    ErrorResponse:
      type: object
      properties:
        errorMessage:
          description: The error message
          readOnly: true
          type: string
        errorCode:
          format: int32
          description: The error code
          readOnly: true
          type: integer
        errorDetail:
          description: The error detail
          readOnly: true
          type: object
    AppliesToFunction_2:
      type: object
      required:
      - code
      - name
      properties:
        installationMetadata:
          description: The local module's IntegrationMetadata, readable for troubleshooting purposes
          readOnly: true
          $ref: '#/components/schemas/IntegrationMetadata'
        code:
          description: The AppliesTo Function code. Note that special characters may need to be escaped.
          type: string
        accessGroups:
          description: Access group Details in response
          type: array
          items:
            $ref: '#/components/schemas/AccessGroup'
        originRegistryId:
          description: The Registry ID of the Exchange Integration this module is based from, including this field will set this as the module's import base and mark the ID's version as audited
          readOnly: true
          type: string
        name:
          description: The name of the AppliesTo Function
          type: string
        checksum:
          description: The metadata checksum for the LMModule content
          readOnly: true
          type: string
        description:
          description: The description of the AppliesTo Function
          type: string
        id:
          format: int32
          description: The ID of the AppliesTo Function
          readOnly: true
          type: integer
          minimum: 0
        accessGroupIds:
          uniqueItems: true
          description: The Access Groups Id's
          type: array
          items:
            format: int32
            description: The Access Groups Id's
            type: integer
          example: 1, 2, 3
        isInUse:
          description: Whether the AppliesTo Function is currently in use
          readOnly: true
          type: boolean
        lineageId:
          description: The lineage Id of the LMModule
          readOnly: true
          type: string
    AccessGroup:
      description: Module's access groups
      type: object
      required:
      - name
      properties:
        createdBy:
          description: User who created access group
          readOnly: true
          type: string
        name:
          description: The name of the access group
          type: string
          example: LinuxGroup
        tenantId:
          description: Tenancy details
          type: string
        description:
          description: Description about access group
          type: string
        id:
          format: int32
          description: The id of the access group
          readOnly: true
          type: integer
        updatedOn:
          format: int64
          description: Time when access group updated
          readOnly: true
          type: integer
        createdOn:
          format: int64
          description: Time when access group created
          readOnly: true
          type: integer
    IntegrationMetadata:
      description: The local module's IntegrationMetadata, readable for troubleshooting purposes
      readOnly: true
      type: object
      properties:
        targetLastPublishedId:
          description: Specifies the target last published Id
          readOnly: true
          type: string
        targetLastPublishedChecksum:
          description: The metadata checksum for the target last published LMModule content
          readOnly: true
          type: string
        targetLastPublishedVersion:
          description: Specifies the target last published version
          readOnly: true
          type: string
        originChecksum:
          description: The metadata checksum for the LMModule content
          readOnly: true
          type: string
        originAuthorNamespace:
          description: Specifies the origin Author companies namespace
          readOnly: true
          type: string
        originLocator:
          description: Specifies the origin version locator
          readOnly: true
          type: string
        isChangedFromOrigin:
          description: Specifies if the Applies To function is changed from origin or not
          readOnly: true
          type: boolean
        auditedRegistryId:
          description: Specifies the audited registry Id
          readOnly: true
          type: string
        targetLineageId:
          description: Specifies the target lineage Id
          readOnly: true
          type: string
        logicModuleType:
          description: 'The values can be DataSources | EventSources | PropertySources | ConfigSources | LogSources | TopologySources | Jobmonitors | AppliesTo Functions | SNMP SysOID Maps

            The type of LogicModule'
          readOnly: true
          type: string
          enum:
          - DATASOURCE
          - EVENTSOURCE
          - CONFIGSOURCE
          - PROPERTYSOURCE
          - DIAGNOSTICSOURCE
          - REMEDIATIONSOURCE
          - TOPOLOGYSOURCE
          - JOBMONITOR
          - APPLIESTO_FUNCTION
          - SNMP_SYSOID_MAP
          - LOGSOURCE
        isChangedFromTargetLastPublished:
          description: Specifies if the Applies To function is changed from target last published or not
          readOnly: true
          type: boolean
        originLineageId:
          description: The origin lineage Id of the LMmodule
          readOnly: true
          type: string
        originAuthorCompanyUUID:
          description: Specifies the origin Author companies unique Id
          readOnly: true
          type: string
        localModuleId:
          format: int32
          description: The LocalModule Id
          readOnly: true
          type: integer
        originRegistryId:
          description: The Registry ID of the Exchange Integration this module is based from
          readOnly: true
          type: string
        originVersion:
          description: Specifies the origin version
          readOnly: true
          type: string
        auditedVersion:
          description: Specifies the audited registry version
          readOnly: true
          type: string
        originName:
          description: Specifies the origin module name
          readOnly: true
          type: string
  securitySchemes:
    LMv1:
      in: header
      name: Authorization
      type: apiKey
externalDocs:
  description: LogicMonitor Support Docs
  url: https://www.logicmonitor.com/support/rest-api-developers-guide/
x-refined-from:
- logicmonitor-rest-api-v2-swagger.json
- logicmonitor-rest-api-v3-swagger.json