openapi: 3.0.1 info: title: Approval Get Data 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 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: '#/parameters/headerAuthorization' - $ref: '#/parameters/headerApplicationKey' - name: ProviderID in: path description: The ID for the entity (in this case, the report). required: true type: string - name: entityName in: path description: The name of the entity (report). It can be obtained via the GET /{ServiceURL} operation. required: true type: string - $ref: '#/parameters/top' - $ref: '#/parameters/skip' - $ref: '#/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). type: array uniqueItems: true items: type: string - 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). type: array uniqueItems: true items: type: string - name: packageSize type: string in: query description: Provide the number of rows returned per page. default: 100 - name: pageNum type: string in: query description: Where returned data spans multiple pages, specify the number of the page to return. default: 1 responses: '200': description: Data for the given entity, returned as a JSON schema. schema: $ref: '#/definitions/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. 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: Http/1.1 Service Unavailable 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: Data: properties: value: type: array items: type: object 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: 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). type: integer default: 20 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 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). 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). type: integer 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.