LeaseAccelerator Reporting API

openapi: 3.1.0
info:
  title: LeaseAccelerator Documents Reporting API
  version: '26.3'
  summary: REST-addressed, XML-RPC style API for the LeaseAccelerator enterprise lease lifecycle platform.
  description: 'The LeaseAccelerator API combines the simplicity of REST requests with the data exchange capabilities of XML Remote Procedure Calls (RPC). Each request is stateless and multiple method requests can be submitted concurrently from the same secure session.


    Access is secured by SAML2. Before submitting API requests you authenticate through the LeaseAccelerator SAML2 authentication layer (service provider URL `https://{environment}.leaseaccelerator.com/auth/api`, ECP mode against your own identity provider) and receive a text security token. Requests are then POSTed to `https://{environment}.leaseaccelerator.com/lease_accelerator/api/LeaseAccelerator/{operation}` with the `token` and `file` form fields, where `file` carries an `<APIRequest>` document.


    This description was generated by the API Evangelist enrichment pipeline from the publicly published LeaseAccelerator developer documentation. Operation keys, the URL template, the authentication model, and the request/response envelopes are taken verbatim from that documentation; per-field payload schemas are documented per operation in the API Methods reference and are not reproduced here.'
  termsOfService: https://insightsoftware.com/legal/terms-of-use/
  contact:
    name: LeaseAccelerator Support (insightsoftware)
    url: https://insightsoftware.com/support/
  x-generated-by: api-evangelist enrichment pipeline
  x-source-documentation: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895814655245-Application-Programming-Interface-API-for-Developers
servers:
- url: https://{environment}.leaseaccelerator.com/lease_accelerator/api/LeaseAccelerator
  description: LeaseAccelerator API endpoint. `environment` is the LeaseAccelerator environment being accessed (www for production); contact LeaseAccelerator Support for other environment URLs.
  variables:
    environment:
      default: www
      description: LeaseAccelerator environment; www is production.
security:
- saml2Token: []
tags:
- name: Reporting
paths:
  /Generate:
    post:
      operationId: Generate
      summary: Generate Report or Document
      description: 'This method consists of the set of parameters needed to generate the requested document or report. See Generate Report Asynch for additional report generation options.


        Operation key: `Generate`. Reference: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods'
      tags:
      - Reporting
      externalDocs:
        description: API Methods reference
        url: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - token
              - file
              properties:
                token:
                  type: string
                  description: The security token returned by the SAML2 authentication service at /auth/api.
                file:
                  type: string
                  description: The XML <APIRequest> document carrying the Request envelope (RequestId, WarningPolicy, ErrorPolicy) and the operation-specific <Payload>.
      responses:
        '200':
          description: An <APIResponse> document. A Status of 0 with Context "Ok" indicates success; any other Status value is an error described by Context.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/APIResponse'
        '405':
          description: Method not allowed — the API accepts POST only.
        '500':
          description: Server error, or an invalid/expired security token.
  /GenerateAsynch:
    post:
      operationId: GenerateAsynch
      summary: Generate Report Asynch
      description: 'This method is like the Generate method as it consists of the set of parameters needed to generate the requested document or report. The only difference between the Generate API and the GenerateAsynch API, is that instead of the report being returned directly to the screen, this API will just make the call and return the request id. Run Generate Report Asynch which will return a request id. Use request id returned as input to the Get Report Status operation. Rerun until Get Report Status returns


        Operation key: `GenerateAsynch`. Reference: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods'
      tags:
      - Reporting
      externalDocs:
        description: API Methods reference
        url: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - token
              - file
              properties:
                token:
                  type: string
                  description: The security token returned by the SAML2 authentication service at /auth/api.
                file:
                  type: string
                  description: The XML <APIRequest> document carrying the Request envelope (RequestId, WarningPolicy, ErrorPolicy) and the operation-specific <Payload>.
      responses:
        '200':
          description: An <APIResponse> document. A Status of 0 with Context "Ok" indicates success; any other Status value is an error described by Context.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/APIResponse'
        '405':
          description: Method not allowed — the API accepts POST only.
        '500':
          description: Server error, or an invalid/expired security token.
  /GetReportStatus:
    post:
      operationId: GetReportStatus
      summary: Get Report Status
      description: 'The GetReportStatus operation is used to fetch the status of Generate Report Asynch based on the request id. Run Generate Report Asynch which will return a request id. Use request id returned as input to the Get Report Status operation. Rerun until Get Report Status returns a status of Success and non-null Endtime. Next retrieve the actual file using request id as input to the Get Report File operation. The request payload is as below.


        Operation key: `GetReportStatus`. Reference: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods'
      tags:
      - Reporting
      externalDocs:
        description: API Methods reference
        url: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - token
              - file
              properties:
                token:
                  type: string
                  description: The security token returned by the SAML2 authentication service at /auth/api.
                file:
                  type: string
                  description: The XML <APIRequest> document carrying the Request envelope (RequestId, WarningPolicy, ErrorPolicy) and the operation-specific <Payload>.
      responses:
        '200':
          description: An <APIResponse> document. A Status of 0 with Context "Ok" indicates success; any other Status value is an error described by Context.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/APIResponse'
        '405':
          description: Method not allowed — the API accepts POST only.
        '500':
          description: Server error, or an invalid/expired security token.
  /GetReportFile:
    post:
      operationId: GetReportFile
      summary: Get Report File
      description: 'The GetReportFile operation is used to fetch the file generated by the Generate Report Asynch operation based on the request id. Run Generate Report Asynch which will return a request id. Use request id returned as input to the Get Report Status operation. Rerun until Get Report Status returns a status of Success and non-null Endtime. Retrieve the actual file using request id as input to the Get Report File operation. The request payload is as below.


        Operation key: `GetReportFile`. Reference: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods'
      tags:
      - Reporting
      externalDocs:
        description: API Methods reference
        url: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - token
              - file
              properties:
                token:
                  type: string
                  description: The security token returned by the SAML2 authentication service at /auth/api.
                file:
                  type: string
                  description: The XML <APIRequest> document carrying the Request envelope (RequestId, WarningPolicy, ErrorPolicy) and the operation-specific <Payload>.
      responses:
        '200':
          description: An <APIResponse> document. A Status of 0 with Context "Ok" indicates success; any other Status value is an error described by Context.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/APIResponse'
        '405':
          description: Method not allowed — the API accepts POST only.
        '500':
          description: Server error, or an invalid/expired security token.
components:
  schemas:
    APIResponse:
      type: object
      description: The generic LeaseAccelerator API response envelope.
      xml:
        name: APIResponse
      properties:
        Response:
          type: object
          properties:
            RequestId:
              type: string
              description: The unique identifier specified in the request.
            Status:
              type: integer
              description: A code indicating success or failure. Zero (0) always means success; any other value represents an error.
            Context:
              type: string
              description: A description of the overall request results. "Ok" always means success; any other value describes the error encountered.
        Payload:
          type: string
          description: The operation-specific XML response payload.
  securitySchemes:
    saml2Token:
      type: apiKey
      in: query
      name: token
      description: 'SAML2-issued text security token, submitted as the `token` form field on every POST. Obtain it by submitting a SAML2 ECP GET request to https://{environment}.leaseaccelerator.com/auth/api identifying your identity provider and a user federated for access in LeaseAccelerator. Note: OpenAPI has no native representation for a form-field credential, so it is modelled here as an apiKey; the token is transmitted in the multipart body, not the query string.'
externalDocs:
  description: Application Programming Interface (API) for Developers
  url: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895814655245-Application-Programming-Interface-API-for-Developers