> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 新しいトランザクションでファイル処理を開始します

> ファイルを処理するためのトランザクションを作成します。
リクエストボディの最大サイズは 2 GB を超えることはできません。
トランザクションは自動的に開始されます。



## OpenAPI

````yaml /ja/openapi.json post /api/publicapi/v1/transactions/launch
openapi: 3.0.4
info:
  description: '環境: 本番環境<br>製品バージョン: 1.6.17'
  title: Vantage processing REST API
  version: '1.0'
  x-application-version: 1.6.17
servers:
  - description: 本番環境（米国リージョン）
    url: https://vantage-us.abbyy.com
  - description: 本番環境（ヨーロッパリージョン）
    url: https://vantage-eu.abbyy.com
  - description: 本番環境（オーストラリアリージョン）
    url: https://vantage-au.abbyy.com
security:
  - OAuth2Security:
      - global.wildcard
      - openid
      - permissions
paths:
  /api/publicapi/v1/transactions/launch:
    post:
      tags:
        - Transactions
      summary: 新しいトランザクションでファイル処理を開始します
      description: |-
        ファイルを処理するためのトランザクションを作成します。
        リクエストボディの最大サイズは 2 GB を超えることはできません。
        トランザクションは自動的に開始されます。
      operationId: LaunchTransaction
      parameters:
        - in: query
          name: skillId
          schema:
            type: string
      requestBody:
        content:
          multipart/form-data:
            encoding:
              Files:
                contentType: application/octet-stream
                explode: true
                style: form
              Model:
                contentType: application/json
                explode: true
                style: form
            schema:
              properties:
                Files:
                  items:
                    description: multipart/* コンテンツとして送信されたファイルを取得するためのモデル
                    format: binary
                    type: string
                  type: array
                Model:
                  additionalProperties: false
                  description: >-
                    トランザクション処理の追加 Parameter です。TransactionLaunchMetadataDto
                    モデルを参照してください。
                  properties:
                    files:
                      description: ファイル処理の Parameters
                      items:
                        $ref: >-
                          #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionFileMetadataDto
                      nullable: true
                      type: array
                    registrationParameters:
                      description: トランザクションの追加登録用の Parameter
                      items:
                        $ref: >-
                          #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionRegistrationParameter
                      maxItems: 10
                      nullable: true
                      type: array
                    skillParameters:
                      description: トランザクション用 Skill Parameter
                      items:
                        $ref: >-
                          #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionSkillParameter
                      maxItems: 10
                      nullable: true
                      type: array
                  type: object
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Results.CreatedTransactionResult
            text/json:
              schema:
                $ref: >-
                  #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Results.CreatedTransactionResult
            text/plain:
              schema:
                $ref: >-
                  #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Results.CreatedTransactionResult
          description: トランザクションの作成と開始が正常に完了しました
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
          description: 一部のファイルが無効であるか、または skillId が指定されていません
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
          description: 指定された skillId の Skill が存在しないか、公開されていません
components:
  schemas:
    Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionFileMetadataDto:
      additionalProperties: false
      description: 追加のファイル処理 Parameter
      properties:
        imageProcessingOptions:
          $ref: >-
            #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.ImageProcessingOptions
        index:
          description: トランザクション内のドキュメントは、この Parameter によって並び順が決まります
          nullable: true
          type: string
        registrationParameters:
          description: |-
            追加のファイル登録用 Parameter。定義済み Parameter:
                        
            SourceType: ファイルの取得元。通常はコネクタ名（スキャンステーション）;
                        
            SourceDetails: ファイルの受信方法;
                        
            SourceFileName: 追加されるファイルの名前（invoice.jfif）
                        
            SourceFilePath: ファイルへのパス
                        
            SourceArchiveName: 追加されるファイルが格納されているアーカイブの名前
                        
            SourceFolderName: 追加されるファイルが格納されているサブフォルダーの名前
          items:
            $ref: >-
              #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionFileRegistrationParameter
          maxItems: 10
          nullable: true
          type: array
      type: object
    Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionRegistrationParameter:
      additionalProperties: false
      description: トランザクション登録用 Parameter
      properties:
        key:
          description: Parameter のキー（名前）
          minLength: 1
          type: string
        value:
          description: Parameter の値
          minLength: 1
          type: string
      required:
        - key
        - value
      type: object
    Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionSkillParameter:
      additionalProperties: false
      description: トランザクション用 Skill Parameter
      properties:
        key:
          description: Parameter のキー名
          minLength: 1
          type: string
        value:
          description: Parameter の値
          minLength: 1
          type: string
      required:
        - key
        - value
      type: object
    Abbyy.Vantage.PublicApi.Contract.Transactions.Results.CreatedTransactionResult:
      additionalProperties: false
      properties:
        transactionId:
          format: uuid
          type: string
      required:
        - transactionId
      type: object
    Microsoft.AspNetCore.Mvc.ProblemDetails:
      additionalProperties: {}
      properties:
        detail:
          nullable: true
          type: string
        instance:
          nullable: true
          type: string
        status:
          nullable: true
          type: string
        title:
          nullable: true
          type: string
        type:
          nullable: true
          type: string
      type: object
    Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.ImageProcessingOptions:
      additionalProperties: false
      description: インポート時の画像前処理設定
      properties:
        autoCrop:
          $ref: >-
            #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.PreprocessingOperationSwitcher
        autoOrientation:
          $ref: >-
            #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.PreprocessingOperationSwitcher
      type: object
    Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionFileRegistrationParameter:
      additionalProperties: false
      properties:
        key:
          description: Parameter のキー名
          minLength: 1
          type: string
        value:
          description: Parameter の値
          minLength: 1
          type: string
      required:
        - key
        - value
      type: object
    Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.PreprocessingOperationSwitcher:
      description: 画像前処理操作スイッチャー
      enum:
        - Default
        - 'Yes'
        - 'No'
      type: string
  securitySchemes:
    OAuth2Security:
      flows:
        authorizationCode:
          authorizationUrl: https://vantage-preview.abbyy.com/auth2/connect/authorize
          scopes:
            global.wildcard: Global wildcard
            openid: User Id
            permissions: User permissions
          tokenUrl: https://vantage-preview.abbyy.com/auth2/connect/token
      type: oauth2

````