Fenergo E Signature Type Configuration API

openapi: 3.2.0
info:
  title: Fenergo E Signature Type Configuration API
  version: '1.0'
  description: 'Operations tagged ESignatureTypeConfiguration across 3 of this provider''s published API definitions: fenergo-documentmanagementcommand-v1-0-openapi.json, fenergo-documentmanagementcommand-v2-0-openapi.json, fenergo-documentmanagementquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /documentmanagementcommand
- url: /documentmanagementquery
security:
- Bearer: []
tags:
- name: ESignatureTypeConfiguration
paths:
  /api/esignaturetypeconfiguration:
    put:
      tags:
      - ESignatureTypeConfiguration
      summary: Save eSignature Type Configuration
      description: 'Required permissions:

        Following permissions are required: ESignatureConfigurationAccess'
      operationId: SaveSignatureTypeConfiguration
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ESignatureTypeConfigurationRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ESignatureTypeConfigurationRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ESignatureTypeConfigurationRequestDtoServiceRequest'
      responses:
        '200':
          description: Success. Type configuration added
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ESignatureTypeConfigurationResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ESignatureTypeConfigurationResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ESignatureTypeConfigurationResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    get:
      tags:
      - ESignatureTypeConfiguration
      summary: Get all Type Configurations
      description: 'Required permissions:

        Following permissions are required: ESignatureConfigurationAccess'
      operationId: GetAllSignatureTypeConfigurations
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: List of Fenergo.Nebula.DocumentManagement.Query.Application.Dto.ESignatureTypeConfigurationDto class containing type configuration information.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ESignatureTypeConfigurationDtoListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ESignatureTypeConfigurationDtoListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ESignatureTypeConfigurationDtoListServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /documentmanagementcommand
  /api/v2/esignaturetypeconfiguration:
    put:
      tags:
      - ESignatureTypeConfiguration
      summary: Save eSignature Type Configuration
      description: 'Required permissions:

        Following permissions are required: ESignatureConfigurationAccess'
      operationId: SaveSignatureTypeConfiguration
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ESignatureTypeConfigurationRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ESignatureTypeConfigurationRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ESignatureTypeConfigurationRequestDtoServiceRequest'
      responses:
        '200':
          description: Success. Type configuration added
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ESignatureTypeConfigurationResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ESignatureTypeConfigurationResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ESignatureTypeConfigurationResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /documentmanagementcommand
  /api/esignaturetypeconfiguration/{id}:
    get:
      tags:
      - ESignatureTypeConfiguration
      summary: Get Type Configuration
      description: 'Required permissions:

        Following permissions are required: ESignatureConfigurationAccess'
      operationId: GetSignatureTypeConfiguration
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Instance of Fenergo.Nebula.DocumentManagement.Query.Application.Dto.ESignatureTypeConfigurationDto class containing type configuration information.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ESignatureTypeConfigurationDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ESignatureTypeConfigurationDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ESignatureTypeConfigurationDtoServiceResponse'
        '400':
          description: Invalid request.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Signature type configuration not found.
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /documentmanagementquery
  /api/esignaturetypeconfiguration/entitySignatureType/{entityDraftId}:
    get:
      tags:
      - ESignatureTypeConfiguration
      summary: Get Entity Signature Type
      description: 'Required permissions:

        Following permissions are required: ESignatureConfigurationAccess'
      operationId: CalculateEntitySignatureType
      parameters:
      - name: entityDraftId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Instance of Fenergo.Nebula.DocumentManagement.Query.Application.Dto.EntitySignatureTypeDto class containing entity signature type information.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/EntitySignatureTypeDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/EntitySignatureTypeDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/EntitySignatureTypeDtoServiceResponse'
        '400':
          description: Invalid request.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Entity draft or signature type configuration not found.
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /documentmanagementquery
components:
  schemas:
    ESignatureLookupValue:
      type: object
      properties:
        label:
          type:
          - string
          - 'null'
        value: {}
      additionalProperties: false
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    ESignatureTypeConfigurationResponseDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
      additionalProperties: false
      description: DTO representing response after saving eSignature type configuration
    ESignatureLookup:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        values:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ESignatureLookupValue'
      additionalProperties: false
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ESignatureTypeConfigurationResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ESignatureTypeConfigurationResponseDto'
          description: DTO representing response after saving eSignature type configuration
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ObjectServiceResponse:
      type: object
      properties:
        data: {}
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ESignatureTypeConfigurationRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ESignatureTypeConfigurationRequestDto'
          description: DTO representing eSignature type configuration
      additionalProperties: false
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ESignatureTypeConfigurationRequestDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type:
          - string
          - 'null'
        signatureType:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ESignatureLookup'
        defaultSignatureType:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ESignatureLookup'
        conditions:
          type:
          - string
          - 'null'
      additionalProperties: false
      description: DTO representing eSignature type configuration
    ESignatureLookupValueDetails:
      type: object
      properties:
        label:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
      additionalProperties: false
    ESignatureTypeConfigurationDtoListServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ESignatureTypeConfigurationDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    EntitySignatureTypeDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntitySignatureTypeDto'
          description: DTO representing eSignature task signature type configuration
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ESignatureLookupDetails:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        values:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ESignatureLookupValueDetails'
      additionalProperties: false
    EntitySignatureTypeDto:
      type: object
      properties:
        isDefaultSignatureType:
          type: boolean
        signatureTypeDetails:
          allOf:
          - $ref: '#/components/schemas/ESignatureLookupValueDetails'
      additionalProperties: false
      description: DTO representing eSignature task signature type configuration
    ESignatureTypeConfigurationDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type:
          - string
          - 'null'
        signatureType:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ESignatureLookupDetails'
        defaultSignatureType:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ESignatureLookupDetails'
        conditions:
          type:
          - string
          - 'null'
      additionalProperties: false
      description: DTO representing signature type configuration
    ESignatureTypeConfigurationDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ESignatureTypeConfigurationDto'
          description: DTO representing signature type configuration
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-documentmanagementcommand-v1-0-openapi.json
- fenergo-documentmanagementcommand-v2-0-openapi.json
- fenergo-documentmanagementquery-v1-0-openapi.json