online-help.platform.features.premier_subscription.connectors.inbound-rest-api.overview.title
URL Format
Overview

All end points URLs are based on the following format:

https://{domain}/api/rest/{clientId}/{versionNumber}/{entity}/{action}.html?token=XXXXXXXX&userId={userId}

Parameters

The corresponding parameters are:

  • domain: "wwww.mobiwork.com" for the staging platform and "www.mobiwork.com" for the production platform

  • The MobiWork staging platform is a production alike platform that can be used for the initial development and testing of the integration with the MobiWork solutions. Please note that the staging platform doesn't have a certified SSL certificate and that you might need to ignore the corresponding warning from your client (e.g. use the "-k" option if you are using the CURL testing tool).


  • clientId: the unique clientId assigned by MobiWork to each client account (e.g. "12104")

  • The clientId is provided by MobiWork in the Help -> About Us section.


  • versionNumber: the MobiWork version number at the time of your integration

  • The current version number is: 10.0.78

    MobiWork uses this version number to understand what version was used when the API client was written. It is primarily used to maintain backwards compatibility with existing API users when new changes are introduced to the API.


  • entity: the MobiWork entity that is manipulated (e.g. "asset," "customer," "work order"...)


  • action: the action to be performed: "view," "add," "edit," "list, "delete"


  • token: the authentication token as returned in the response of the initial authenticate end point


  • userId: optional parameter to specify the user that should be used when the request is performed

  • MobiWork has an extensive user based access control and permissions framework that determines what operations and data any given user is authorized to access or perform. In addition, the userId is used by MobiWork to provide its audit trail and history capabilities.

    If the parameter is not specified, all end points will be executed with the userId of an active global administrator of the account.

    If provided, all end points will be executed with the given userId.

Example

https:///api/rest/12014/10.0.78/asset/list.html

to retrieve all the assets of the clientId 12014 using a global administrator permission and the version 10.0.78  of the API