SAP Fieldglass Get Metadata API

openapi: 3.2.0
info:
  version: 1.0.0
  title: SAP Fieldglass OData-Based Analytic Get Metadata 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 Metadata
paths:
  /{ProviderID}/$metadata:
    get:
      tags:
      - Get Metadata
      summary: Get metadata for an entity
      description: Returns metadata for the specified ProviderID. A JSON schema is returned representing the metadata.
      security:
      - OAuth2:
        - user
      parameters:
      - $ref: '#/components/parameters/headerAuthorization'
      - $ref: '#/components/parameters/headerApplicationKey'
      - name: ProviderID
        in: path
        description: The ID for the entity (in this case, the report). This is returned when getting all providers.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Metadata information for the given entity. A JSON schema is given as metadata.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/metaData'
        '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/xml:
              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/xml:
              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: getByProviderID$metadata
      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
    headerAuthorization:
      name: Authorization
      description: Only required for production access when using SAP Fieldglass.
      in: header
      required: false
      schema:
        type: string
  schemas:
    metaData:
      properties:
        Schema:
          type: object
          properties:
            -Namespace:
              type: string
              example: fieldglass.insite
            -Alias:
              type: string
              example: insite
            EntityType:
              type: object
              properties:
                -Name:
                  type: string
                Key:
                  type: object
                  properties:
                    PropertyRef:
                      type: object
                      properties:
                        -Name:
                          type: string
                Property:
                  type: array
                  items:
                    type: object
                    properties:
                      -Name:
                        type: string
                        example: business_unit
                      -Type:
                        type: string
                        example: Edm.String
                      -MaxLength:
                        type: string
                        example: '100'
            EntityContainer:
              type: object
              properties:
                -Name:
                  type: string
                  example: dbContainer
                EntitySet:
                  type: object
                  properties:
                    -Name:
                      type: string
                      example: job_postings
                    -EntityType:
                      type: string
                      example: insite.job_posting
                    Annotation:
                      type: object
                      properties:
                        -Term:
                          type: string
                          example: Capabilities.Supported
                        Record:
                          type: object
                          properties:
                            PropertyValue:
                              type: object
                              properties:
                                -Property:
                                  type: string
                                  example: Supported
                                Bool:
                                  type: string
                                  example: 'false'
    Status:
      type: object
      properties:
        TransactionID:
          type: string
          description: Transaction ID.
        ReturnCode:
          type: integer
          format: int32
          description: Return Code
        Message:
          type: string
          description: Message
    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.