SAP Field Service Management SDK

---

JavaScript SDK to Interface with SAP Field Service Management APIs and Services.

Find more documentation and related information at SAP Field Service Management Documentation

• SAP Field Service Management SDK
  • JavaScript SDK to Interface with SAP Field Service Management APIs and Services.
  • Getting started
    • Examples
  • CoreAPIClient
    • Query for objects using CoreSQL
    • CRUD object
      • Create a new object
      • Read object by id
      • Update object (providing full new version)
      • Update object (providing only fields to change)
      • Delete object
        • lastChanged
      • Batch Actions (Transactions)
  • Support
  • License

Getting started

install from NPM

npm i fsm-sdk --save

using the sdk in NodeJS with credentials:

const fsm = require('fsm-sdk');

const client = new fsm.CoreAPIClient({

  // [mandatory] your client configuration
  clientIdentifier: '<your-clientIdentifier>',
  clientSecret: '<your-clientSecret>',
  clientVersion: '<your-clientVersion>',

  // [optional] oauth grant type, default=password
  authGrantType: 'password' | 'client_credentials' | undefined

  // [optional] | [mandatory] if oauth grant type password
  authAccountName: '<your-authAccountName>',

  // [optional] | [mandatory] if oauth grant type password
  authUserName: '<your-authUserName>',

  // [optional] | [mandatory] if oauth grant type password
  authPassword: '<your-authPassword>',

  // [optional] or default=FIRST
  authCompany: '<your-authCompany>',

  // [optional] provide verbose logs
  debug: false,

  // [optional] enable using custom oauth endpoints
  oauthEndpoint: 'https://eu.fsm.cloud.sap/api/oauth2/v2',

  // [optional] client will cache token (helpful for writing integration tests)
  tokenCacheFilePath: './.myToken.json'

});

related doc's:

• Field Service Management - Integration Guidelines
• Access API (OAuth 2.0)
• Generating Client ID and Secret

Examples

Some illustrative cases are provided in the examples folder.

---

CoreAPIClient

The CoreAPIClient API actions will return a Promise and is asynchronous by default.

Query for objects using CoreSQL

Provides the [coreSQL] and the [dtos] used in the query see Field Service Management - Query API

const coreSQL =
  `SELECT
    sc.id,
    sc.subject
  FROM
    ServiceCall sc
  WHERE
   sc.id = '36A5626F65A54FE7911F536C501D151A'
  `;

await client.query(coreSQL, ['ServiceCall']);

CRUD object

related doc's:

• Data API v4 Docs
• Data Model Documentation

Create a new object

const serviceCall = {
   id: fsm.CoreAPIClient.createUUID(), // => 36A5626F65A54FE7911F536C501D151A
   ...
};

await client.post('ServiceCall', serviceCall);

Read object by id or externalId

await client.getById('ServiceCall', '36A5626F65A54FE7911F536C501D151A');
// or
await client.getByExternalId('ServiceCall', 'my-1');

Update object (providing full new version)

await client.put('ServiceCall', { ... });
// or
await client.putByExternalId('ServiceCall', { ... });

Update object (providing only fields to change)

await client.patch('ServiceCall', {
    id: '36A5626F65A54FE7911F536C501D151A',
    subject: 'update-only-subject',
    lastChanged: 1535712340
  });
// or
await client.patchByExternalId('ServiceCall', { externalId: 'my-1', ... });

Delete object by id or externalId

await client.deleteById('ServiceCall', {
    id: '36A5626F65A54FE7911F536C501D151A',
    lastChanged: 1535712340
  });
// or
await client.deleteByExternalId('ServiceCall', { externalId: 'my-1', ... });

lastChanged

The lastChanged field is used for optimistic locking. It's like a version-key you must provide in order to update an object.

Batch Actions (Transactions)

// actions will be executed in sequence order like in array

const actions = [ 
  new CreateAction('ServiceCall', { ... }), 
  new UpdateAction('BusinessPartner', { id, lastChanged ... }), // required for update
  new DeleteAction('Address', { id, lastChanged ... }) // required for delete
];

const response = await client.batch(actions) 
// response => [ { body: { statusCode: 200|201|400, data: { ... } } }, req1, req2 ]

// data will contain a list resp, unwrap to access first
const [[{ serviceCall }], [{ businessPartner }], ] = response.map(it => it.body.data);

Support

In case you need further help, check out the SAP Field Service Management Help Portal or report and incident in SAP Support Portal with the component "CEC-SRV-FSM".

License

Copyright (c) 2020 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file.