AMCS Group ExternalReferenceType API

The ExternalReferenceType API from AMCS Group — 1 operation(s) for externalreferencetype.

OpenAPI Specification

amcs-group-externalreferencetype-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Core AccessGroup ExternalReferenceType API
  version: core
tags:
- name: ExternalReferenceType
paths:
  /lists/externalReferenceTypes:
    get:
      tags:
      - ExternalReferenceType
      summary: Find with Filters
      description: "| Property                  | Description   |\r\n| ------------------------- | ---------------------------------------------------------------------------  |\r\n| GUID                      | The GUID associated to the external reference type   |\r\n| Description               | The description of the external reference type   |\r\n   "
      operationId: ExternalReferenceType_GetCollection
      parameters:
      - name: filter
        in: query
        schema:
          type: string
      - name: max
        in: query
        schema:
          type: integer
          format: int32
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: includeCount
        in: query
        schema:
          type: boolean
      - name: udf
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceResultCollection[ApiIntegratorExternalReferenceTypeResource]'
components:
  schemas:
    ApiResourceErrors:
      type: object
      properties:
        errors:
          type: string
    ApiIntegratorExternalReferenceTypeResource:
      type: object
      properties:
        Description:
          type: string
        IsUnique:
          type: boolean
        GUID:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
    ApiResourceResultCollectionExtra:
      type: object
      properties:
        count:
          type: integer
          format: int32
    ApiResourceResultCollection[ApiIntegratorExternalReferenceTypeResource]:
      type: object
      properties:
        resource:
          type: array
          items:
            $ref: '#/components/schemas/ApiIntegratorExternalReferenceTypeResource'
        extra:
          $ref: '#/components/schemas/ApiResourceResultCollectionExtra'
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
    ApiResourceStatus:
      type: object
      properties:
        id:
          type: integer
          format: int32
        isSuccess:
          type: boolean