AMCS Group WorkflowProviderWebHook API

openapi: 3.0.1
info:
  title: Core AccessGroup WorkflowProviderWebHook API
  version: core
tags:
- name: WorkflowProviderWebHook
paths:
  /web-hook/workflow-provider/callback:
    post:
      tags:
      - WorkflowProviderWebHook
      parameters:
      - name: registrationKey
        in: query
        schema:
          type: string
      - name: id
        in: query
        schema:
          type: string
      - name: action
        in: query
        schema:
          type: string
      - name: txid
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Success
  /web-hook/workflow-provider/delete-schedule:
    post:
      tags:
      - WorkflowProviderWebHook
      parameters:
      - name: id
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Success
  /services/api/workflow/workflowProviderWebHooks/changes:
    get:
      tags:
      - WorkflowProviderWebHook
      parameters:
      - name: since
        in: query
        schema:
          type: string
      - name: cursor
        in: query
        schema:
          type: string
      - name: links
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceChanges[ApiWorkflowProviderWebHookResource]'
  /services/api/workflow/workflowProviderWebHooks/template:
    get:
      tags:
      - WorkflowProviderWebHook
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceResult[ApiWorkflowProviderWebHookResource]'
  /services/api/workflow/workflowProviderWebHooks/{id}:
    get:
      tags:
      - WorkflowProviderWebHook
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: links
        in: query
        schema:
          type: string
      - name: include
        in: query
        schema:
          type: string
      - name: expand
        in: query
        schema:
          type: string
      - name: udf
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceResultEntity[ApiWorkflowProviderWebHookResource]'
    put:
      tags:
      - WorkflowProviderWebHook
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiResourceId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceId'
    delete:
      tags:
      - WorkflowProviderWebHook
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResource'
  /services/api/workflow/workflowProviderWebHooks/{id}/blob/{blobMemberName}:
    get:
      tags:
      - WorkflowProviderWebHook
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: blobMemberName
        in: path
        required: true
        schema:
          type: string
      - name: fileName
        in: query
        schema:
          type: string
      - name: contentType
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
                format: binary
  /services/api/workflow/workflowProviderWebHooks:
    get:
      tags:
      - WorkflowProviderWebHook
      parameters:
      - name: filter
        in: query
        schema:
          type: string
      - name: search
        in: query
        schema:
          type: string
      - name: order
        in: query
        schema:
          type: string
      - name: max
        in: query
        schema:
          type: string
      - name: page
        in: query
        schema:
          type: string
      - name: includeCount
        in: query
        schema:
          type: string
      - name: includeDeleted
        in: query
        schema:
          type: string
      - name: links
        in: query
        schema:
          type: string
      - name: udf
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceResultCollection[ApiWorkflowProviderWebHookResource]'
    post:
      tags:
      - WorkflowProviderWebHook
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiResourceId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceId'
components:
  schemas:
    ApiResourceResultUpdatesExtra:
      type: object
      properties:
        until:
          type: string
          nullable: true
        cursor:
          type: string
          nullable: true
      additionalProperties: false
    ApiResourceId:
      type: object
      properties:
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
        resource:
          type: integer
          format: int32
      additionalProperties: false
    ApiResourceResultEntity[ApiWorkflowProviderWebHookResource]:
      type: object
      properties:
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
        resource:
          $ref: '#/components/schemas/AMCS.Core.Entity.Api.Workflow.ApiWorkflowProviderWebHook'
        links:
          $ref: '#/components/schemas/ApiResourceResultEntityLinks'
        extra:
          $ref: '#/components/schemas/ApiResourceResultEntityExtra'
      additionalProperties: false
    ApiResourceErrors:
      type: object
      properties:
        errors:
          type: string
          nullable: true
      additionalProperties: false
    ApiResourceStatus:
      type: object
      properties:
        id:
          type: integer
          format: int32
          nullable: true
        isSuccess:
          type: boolean
      additionalProperties: false
    ApiResourceResultCollectionExtra:
      type: object
      properties:
        count:
          type: integer
          format: int32
          nullable: true
      additionalProperties: false
    ApiResourceResult[ApiWorkflowProviderWebHookResource]:
      type: object
      properties:
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
        resource:
          $ref: '#/components/schemas/AMCS.Core.Entity.Api.Workflow.ApiWorkflowProviderWebHook'
      additionalProperties: false
    AMCS.Core.Entity.Api.Workflow.ApiWorkflowProviderWebHook:
      type: object
      properties:
        isValid:
          type: boolean
          readOnly: true
        id:
          type: integer
          format: int32
          nullable: true
          readOnly: true
        id32:
          type: integer
          format: int32
          readOnly: true
        guid:
          type: string
          format: uuid
          nullable: true
        lastChangeReasonId:
          type: integer
          format: int32
          nullable: true
        tempIdentifier:
          type: string
          nullable: true
        workflowProviderWebHookId:
          type: integer
          format: int32
          nullable: true
        workflowProviderId:
          type: integer
          format: int32
        workflowDefinitionId:
          type: string
          format: uuid
        triggerObjectName:
          type: string
          nullable: true
        triggerEventType:
          type: integer
          format: int32
        triggerEventFormat:
          type: integer
          format: int32
        triggerEventFilter:
          type: string
          nullable: true
        triggerEventTypeDescriptions:
          type: array
          items:
            type: string
          nullable: true
          readOnly: true
      additionalProperties: false
    ApiResource:
      type: object
      properties:
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
      additionalProperties: false
    ApiResourceResultEntityExtra:
      type: object
      properties:
        expand:
          type: object
          additionalProperties:
            type: object
            additionalProperties: {}
            nullable: true
          nullable: true
        include:
          type: object
          additionalProperties:
            type: array
            items:
              type: object
              additionalProperties: {}
            nullable: true
          nullable: true
      additionalProperties: false
    ApiResourceResultCollection[ApiWorkflowProviderWebHookResource]:
      type: object
      properties:
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
        resource:
          type: array
          items:
            $ref: '#/components/schemas/AMCS.Core.Entity.Api.Workflow.ApiWorkflowProviderWebHook'
          nullable: true
        extra:
          $ref: '#/components/schemas/ApiResourceResultCollectionExtra'
      additionalProperties: false
    ApiResourceResultEntityLinks:
      type: object
      properties:
        self:
          type: string
          nullable: true
        associations:
          type: array
          items:
            type: string
          nullable: true
        expand:
          type: array
          items:
            type: string
          nullable: true
        operations:
          type: array
          items:
            type: string
          nullable: true
      additionalProperties: false
    ApiResourceChanges[ApiWorkflowProviderWebHookResource]:
      type: object
      properties:
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
        resource:
          type: array
          items:
            $ref: '#/components/schemas/AMCS.Core.Entity.Api.Workflow.ApiWorkflowProviderWebHook'
          nullable: true
        extra:
          $ref: '#/components/schemas/ApiResourceResultUpdatesExtra'
      additionalProperties: false