SAP Fieldglass
SAP Fieldglass Get Metadata API

The Get Metadata API from SAP Fieldglass — 1 operation(s) for get metadata.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.0.1
info:
  title: Approval Get Metadata 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: 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
      produces:
      - application/xml
      parameters:
      - $ref: '#/parameters/headerAuthorization'
      - $ref: '#/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
        type: string
      responses:
        '200':
          description: Metadata information for the given entity. A JSON schema is given as metadata.
          schema:
            $ref: '#/definitions/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.
          schema:
            $ref: '#/definitions/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.
          schema:
            $ref: '#/definitions/Status'
        '503':
          description: Internal Server Error. Server is not available.
          examples:
            text/html: <html><body><b>Http/1.1 Service Unavailable</b></body> </html>
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:
  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
parameters:
  headerApplicationKey:
    name: X-ApplicationKey
    description: The company-specific key provided by SAP Fieldglass for API access.
    type: string
    in: header
    required: false
  headerAuthorization:
    name: Authorization
    description: Only required for production access when using SAP Fieldglass.
    type: string
    in: header
    required: false
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.
SAP Fieldglass Get Metadata API

Documentation

Specifications

Other Resources

OpenAPI Specification
