SAP Fieldglass Get Data API

openapi: 3.2.0
info:
  version: 1.0.0
  title: SAP Fieldglass OData-Based Analytic Get Data API
  description: The SAP Fieldglass OData-Based Analytic API enables SAP Fieldglass users to remotely access reports stored in the Data Hub and return information from these reports.
  termsOfService: https://www.fieldglass.net/TermsOfUse.en_US.pdf
  contact:
    name: SAP Fieldglass OData-Based Analytic API
    url: http://www.fieldglass.com
    email: Fieldglass_API@sap.com
  license:
    name: SAP Fieldglass
    url: https://www.fieldglass.net/TermsOfUse.en_US.pdf
servers:
- url: https://sandbox.api.sap.com/fieldglass/api/data_hub
security:
- OAuth2:
  - user
tags:
- name: Get Data
paths:
  /{ProviderID}/{entityName}:
    get:
      tags:
      - Get Data
      summary: Get data for an entity
      description: Returns data for the specified ProviderID and entity.
      parameters:
      - $ref: '#/components/parameters/headerAuthorization'
      - $ref: '#/components/parameters/headerApplicationKey'
      - name: ProviderID
        in: path
        description: The ID for the entity (in this case, the report).
        required: true
        schema:
          type: string
      - name: entityName
        in: path
        description: The name of the entity (report). It can be obtained via the GET /{ServiceURL} operation.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/filter'
      - name: $orderby
        in: query
        description: The property or properties used to order the results. If there is more than one, separate using a comma. You can also specify asc for ascending and desc for descending order. For more information, see [OData Sorting](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374629).
        schema:
          type: array
          items:
            type: string
          uniqueItems: true
      - name: $select
        in: query
        description: Provide a comma-separated list of the properties to be returned. For more information, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620).
        schema:
          type: array
          items:
            type: string
          uniqueItems: true
      - name: packageSize
        in: query
        description: Provide the number of rows returned per page.
        schema:
          type: string
          default: 100
      - name: pageNum
        in: query
        description: Where returned data spans multiple pages, specify the number of the page to return.
        schema:
          type: string
          default: 1
      responses:
        '200':
          description: Data for the given entity, returned as a JSON schema.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Data'
        '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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '503':
          description: Internal Server Error. Server is not available.
          content:
            text/html:
              example: <html><body><b>Http/1.1 Service Unavailable</b></body> </html>
      operationId: getByProviderIDByEntityName
      x-operation-id-source: derived
components:
  parameters:
    headerApplicationKey:
      name: X-ApplicationKey
      description: The company-specific key provided by SAP Fieldglass for API access.
      in: header
      required: false
      schema:
        type: string
    skip:
      name: $skip
      in: query
      description: Excludes the number of items specified from the collection. For more information, see [OData Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374631).
      schema:
        type: integer
    filter:
      name: $filter
      in: query
      description: Restricts the items returned by property values. For more information, see see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374625).
      schema:
        type: string
    headerAuthorization:
      name: Authorization
      description: Only required for production access when using SAP Fieldglass.
      in: header
      required: false
      schema:
        type: string
    top:
      name: $top
      in: query
      description: Limits the number of items returned, up to but not exceeding the number specified. For more information, see [OData Paging - Top](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374630).
      schema:
        type: integer
        default: 20
  schemas:
    Status:
      type: object
      properties:
        TransactionID:
          type: string
          description: Transaction ID.
        ReturnCode:
          type: integer
          format: int32
          description: Return Code
        Message:
          type: string
          description: Message
    Data:
      properties:
        value:
          type: array
          items:
            type: object
    Error:
      type: string
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          scopes:
            user: get data hub entities
          tokenUrl: https://{host}/api/oauth2/v2.0/token?grant_type=client_credentials&response_type=token
      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.
externalDocs:
  description: SAP Fieldglass OData-Based Analytic API
  url: https://help.sap.com/viewer/d8db40690cb14f08a705f3bc5c9ecbb3/cloud/en-US
x-servers:
- url: https://{host}/api/data_hub/
  description: OData API
  templates:
    host:
      default: www.fieldglass.net
      description: The SAP Fieldglass region where the SAP Fieldglass APIs are used.
    default: sandbox
    description: Public URI Prefix for different environments, prod is Test or Production environment for Cloud Business Applications and sandbox is Mock environment with sample data.
x-sap-shortText: Enables you to retrieve data from SAP Fieldglass reports.