Ballerina library

sap.fieldglass.approval

Module sap.fieldglass.approval

OverviewPrerequisites

API

Client

Definitions

Approvals
ApprovalsAttributes
ApprovalsHeader
ApprovalsPayload
ClientHttp1Settings
ConnectionConfig
OAuth2ClientCredentialsGrantConfig
ProxyConfig
Status

Error

ballerinax/sap.fieldglass.approval Ballerina library

1.3.1

Overview

This is a generated connector for SAP Fieldglass Approval API API v1.0.0 OpenAPI specification.

The 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.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

  • Create and configure an OAuth2 client credentials by following this guide.

Clients

sap.fieldglass.approval: Client

Isolated

This is a generated connector for SAP Fieldglass Approval API API v1.0.0 OpenAPI specification. The 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.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create and configure an OAuth2 client credentials by following this guide.

init (ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig - The configurations to be used when initializing the connector
  • serviceUrl string - URL of the target service

getItemListForApproval

Isolated FunctionRemote Function
function getItemListForApproval(string? authorization, string? xApplicationkey) returns Approvals|error

Get a list of items that require approval

Parameters
  • authorization string? (default ()) - Only required for production access when using SAP Fieldglass.
  • xApplicationkey string? (default ()) - The company-specific key provided by SAP Fieldglass for API access. Required for production access.
Return Type

getItemListFroApprovalByModule

Isolated FunctionRemote Function
function getItemListFroApprovalByModule(string moduleId, string? authorization, string? xApplicationkey) returns Approvals|error

Get items that require approval for a module

Parameters
  • moduleId string - The ID for the module (for example, 40 for Job Posting or 270 for Work Order). A full list can be found in the supporting documentation.
  • authorization string? (default ()) - Only required for production access when using SAP Fieldglass.
  • xApplicationkey string? (default ()) - The company-specific key provided by SAP Fieldglass for API access. Required for production access.
Return Type

approveOrRejectItem

Isolated FunctionRemote Function
function approveOrRejectItem(string moduleId, string workItemId, string action, string? authorization, string? xApplicationkey, string? comments, string? reasonId) returns Approvals|error

Approve or reject an item

Parameters
  • moduleId string - The ID for the module (for example, 40 for Job Posting or 270 for Work Order). A full list can be found in the supporting documentation.
  • workItemId string - The ID of the work item. You can get this from the response received when getting the list of items that require approval.
  • action string - The action to take on the work item. This can be either ''approve'' or ''reject''. If it is reject, the reasonId is required.
  • authorization string? (default ()) - Only required for production access when using SAP Fieldglass.
  • xApplicationkey string? (default ()) - The company-specific key provided by SAP Fieldglass for API access. Required for production access.
  • comments string? (default ()) - Any comments about the action.
  • reasonId string? (default ()) - The reasonId for the rejection. This is required when the action is 'reject'. You can get a list of rejection reasons available for the module from the response when getting rejection reasons.
Return Type

getWorkItemDetail

Isolated FunctionRemote Function
function getWorkItemDetail(string moduleId, string workItemId, string? authorization, string? xApplicationkey) returns Approvals|error

Get details for work item

Parameters
  • moduleId string - The ID for the module (for example, 40 for Job Posting or 270 for Work Order). A full list can be found in the supporting documentation.
  • workItemId string - The ID of the work item.
  • authorization string? (default ()) - Only required for production access when using SAP Fieldglass.
  • xApplicationkey string? (default ()) - The company-specific key provided by SAP Fieldglass for API access. Required for production access.
Return Type

getRejectionReasons

Isolated FunctionRemote Function
function getRejectionReasons(string moduleId, string? authorization, string? xApplicationkey) returns Approvals|error

Get rejection reasons

Parameters
  • moduleId string - The ID for the module (for example, 40 for Job Posting or 270 for Work Order). A full list can be found in the supporting documentation.
  • authorization string? (default ()) - Only required for production access when using SAP Fieldglass.
  • xApplicationkey string? (default ()) - The company-specific key provided by SAP Fieldglass for API access. Required for production access.
Return Type

Records

sap.fieldglass.approval: Approvals

Fields

sap.fieldglass.approval: ApprovalsAttributes

Fields
  • ref string? - Object ID, visible to end users.
  • uom string? - 3-character currency code.
  • name string? - Name of object as defined by user.
  • startDate string? - Start date.
  • amount string? - Amount to be approved.
  • refVersion int? - Revision number of object to be approved.
  • validObject boolean? - Always returns false.
  • createDate string? - Recorded start date of object to be approved. Logical value is module dependent.
  • creatorName string? - Creator name.
  • uniqueName string? - Unique name.
  • emailId string? - Unique name.
  • status string? - Ok if response is OK.
  • others record {}? - Additional data captured in SAP Fieldglass for the object. Full list of data is module and configuration-dependent and should be consumed/presented as extrinsic.

sap.fieldglass.approval: ApprovalsHeader

Fields
  • appVersion string? - API version.
  • numRecs int? - Number of records returned in the payload.
  • status string? - Status of the API call.
  • details string? - Always All Ok for successful responses.

sap.fieldglass.approval: ApprovalsPayload

Fields
  • moduleID string? - Numeric module reference ID.
  • moduleName string? - Name of module, also type of object to be approved.
  • ID string? - Globally unique database-level identifier of object. This is the ID used for the drill down call. Not visible to end users.
  • Status string? - Ok if response is OK.
  • Details string? - All ok if response is OK.
  • ActivityID string? - Ok if response is OK.

sap.fieldglass.approval: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields
  • keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
  • chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

sap.fieldglass.approval: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields
  • httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
  • timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
  • forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header
  • cache CacheConfig? - HTTP caching related configurations
  • compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header
  • circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
  • retryConfig RetryConfig? - Configurations associated with retrying
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

sap.fieldglass.approval: OAuth2ClientCredentialsGrantConfig

Closed record

OAuth2 Client Credentials Grant Configs

Fields
  • tokenUrl string(default " ") - Token URL

sap.fieldglass.approval: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields
  • host string(default "") - Host name of the proxy server
  • port int(default 0) - Proxy server port
  • userName string(default "") - Proxy server username
  • password string(default "") - Proxy server password

sap.fieldglass.approval: Status

Fields
  • TransactionID string? - Transaction ID.
  • ReturnCode int? - Return code.

String types

sap.fieldglass.approval: Error

string

Error

Import

import ballerinax/sap.fieldglass.approval;Copy

Metadata

Released date: over 1 year ago

Version: 1.3.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 1

Current verison: 1

Weekly downloads

Source repository

Keywords

Business Management/ERP

Cost/Paid

Contributors

Other versions

1.3.1

1.3.01.2.01.0.0

Dependencies

ballerina/url/2.2.3ballerina/http/2.6.0

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2024 WSO2 LLC