SAP Fieldglass Results API

openapi: 3.0.1
info:
  title: Approval Results 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: Results
paths:
  /result:
    post:
      tags:
      - Results
      summary: Provides results for the work order
      description: Posts results for a specific background check request.
      parameters:
      - name: Authorization
        in: header
        required: false
        description: Only required for production access when using SAP Fieldglass.
        type: string
      - name: Content-Type
        in: header
        required: false
        type: string
        description: JSON format is supported. This value is application/json.
      - name: X-ApplicationKey
        in: header
        required: false
        type: string
        description: The company-specific key provided by SAP Fieldglass for API access.
      - name: Body
        in: body
        required: true
        description: The body of the request.
        schema:
          $ref: '#/definitions/ResultConfirmation'
      - name: clientReferenceId
        type: string
        required: true
        description: Globally-unique SAP Fieldglass identifier of the object. This is the Work Order ID used for the drill-down call in SAP Fieldglass. It is not visible to end users.
        in: query
      responses:
        '200':
          description: Order Result POST successful
        '401':
          description: Unauthorized
        '500':
          description: Internal Server 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:
  ResultConfirmation:
    type: object
    properties:
      HEADER:
        type: object
        properties:
          AppVersion:
            type: string
            description: App version
            example: FieldglassAPIServer/1.0
          OSUAStr:
            type: string
            description: Description
            example: FieldglassAPIServer/1.0
          NumRecs:
            type: integer
            description: Number of records
            example: 1
          Status:
            type: string
            description: Status
            example: ok
          Details:
            type: string
            description: Details
            example: all ok
      backgroundReportPackage:
        type: object
        properties:
          providerReferenceId:
            type: string
            description: Background check order ID
          orderStatus:
            type: string
            description: Overall order status
          resultStatus:
            type: string
            description: Overall result status
          dateOrderReceived:
            type: string
            description: Date order received
          dateOrderCompleted:
            type: string
            description: Verification date
          screenings:
            type: array
            description: Details about individual screenings
            items:
              type: object
              properties:
                name:
                  type: string
                  description: Source name
                description:
                  type: string
                  description: Source detail
                type:
                  type: string
                  description: Test name
                screeningStatus:
                  type: string
                  description: Screening status
                screeningResultStatus:
                  type: string
                  description: Screening result status
                dateOrderReceived:
                  type: string
                  description: Verification date
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.