SAP Fieldglass Reports API

openapi: 3.0.1
info:
  title: Approval Reports API
  description: "This is a generated connector for [SAP Fieldglass Approval API API v1.0.0](https://api.sap.com/api/approvals/resource) OpenAPI specification. \nThe SAP Fieldglass Approval API allows clients to approve or reject SAP Fieldglass work items. Clients retrieve the work items pending an approval action from the authenticated user and return the workflow action to be performed (either approve or reject). The list and details provided by the SAP Fieldglass API give clients the ability to present work items for approval to their users with the level of detail needed to make an informed approval decision and the mechanism to return the approval or rejection decision."
  termsOfService: https://www.fieldglass.net/TermsOfUse.en_US.pdf
  x-ballerina-init-description: 'The connector initialization requires setting the API credentials.

    Create and configure an OAuth2 client credentials by following [this guide](https://help.sap.com/viewer/b865ed651e414196b39f8922db2122c7/LATEST/en-US/7aefa21a65f94b25b7e639c3931b6f83.html).

    '
  x-ballerina-display:
    label: SAP Fieldglass Approval
    iconPath: icon.png
  contact:
    name: SAP Fieldglass Approval API
    url: http://www.fieldglass.com
    email: Fieldglass_API@sap.com
  license:
    name: SAP Fieldglass
    url: https://www.fieldglass.net/TermsOfUse.en_US.pdf
  version: 1.0.0
security:
- OAuth2:
  - user
tags:
- name: Reports
paths:
  /report:
    get:
      summary: Get a list of available reports
      description: Returns a list of all available reports including the report ID and name.
      security:
      - OAuth2:
        - user
      operationId: getReports
      tags:
      - Reports
      produces:
      - application/json
      consumes:
      - application/x-www-form-urlencoded
      parameters:
      - name: Authorization
        in: header
        required: false
        type: string
        description: Only required for production access when using SAP Fieldglass.
      - name: X-ApplicationKey
        in: header
        required: false
        type: string
        description: The company-specific key provided by SAP Fieldglass for API access. Required for production access.
      responses:
        '200':
          description: An array of reports
          schema:
            type: array
            items:
              $ref: '#/definitions/report'
        '400':
          description: Bad Request. This response is returned if the specified URL is invalid, the request is not formatted correctly, or if the request is missing a required field.
        '401':
          description: Unauthorized. User/password or application key is not verified.
        '403':
          description: Forbidden. Token is not verified.
        '404':
          description: Not Found. Service being requested does not exist.
        '500':
          description: Internal Server Error. Server is not available.
        default:
          description: No Result
          schema:
            $ref: '#/definitions/Error'
  /report/{report_id}:
    get:
      summary: Get a specific report
      description: Returns report data for the report ID specified by the user.
      security:
      - OAuth2:
        - user
      tags:
      - Reports
      operationId: getReportById
      produces:
      - application/json
      parameters:
      - name: report_id
        in: path
        description: The ID of the report. You can obtain it by getting the list of available reports.
        required: true
        type: string
      - name: Authorization
        in: header
        required: false
        type: string
        description: Only required for production access when using SAP Fieldglass.
      - name: X-ApplicationKey
        in: header
        required: false
        type: string
        description: The company-specific key provided by SAP Fieldglass for API access. This is required for production access.
      responses:
        '200':
          description: OK. The request was received successfully.
          schema:
            $ref: '#/definitions/report'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
components:
  securitySchemes:
    OAuth2:
      type: oauth2
      description: To use this REST API, you need to get OAuth client credentials (user credentials and client-specific application key) from an SAP Fieldglass account representative. After that, you need to pass the obtained client credentials to the SAP Fieldglass token endpoint to obtain an access token.
      flows:
        clientCredentials:
          tokenUrl: ' '
          scopes:
            user: approve work items
definitions:
  report:
    type: object
    properties:
      id:
        type: string
        maxLength: 24
        description: Unique identifier representing a specific report.
      name:
        type: string
        maxLength: 500
        description: Name of the report.
      dataType:
        type: string
        description: Data type.
      maxLength:
        type: string
        description: Max length.
      analyticType:
        type: string
        description: Analytic Type.
      semanticType:
        type: string
        description: Semantic type.
      measureUnitType:
        type: string
        description: Measure unit type.
      measureUnits:
        type: string
        description: Measure units.
      measureAggregation:
        type: string
        description: Measure aggregation.
      scale:
        type: string
        description: Scale.
  Error:
    type: object
    properties:
      code:
        type: integer
        format: int32
      message:
        type: string
      fields:
        type: string
externalDocs:
  description: SAP Fieldglass Approval API Guide
  url: https://help.sap.com/viewer/695f67ff045b402bad469e7340b3108c/Latest/en-US
x-servers:
- url: https://{hostname}/api/{suffix}
  description: REST API
  templates:
    hostname:
      enum:
      - www.fieldglass.net
      default: www.fieldglass.net
      description: The SAP Fieldglass region where the SAP Fieldglass APIs are used.
    suffix:
      enum:
      - v1
      - vc
      default: vc
      description: The suffix for the URL.
x-sap-shortText: Enables you to approve or reject SAP Fieldglass work items.