Document toolboxDocument toolbox

DiagScript REST API

Owned by Andrew Hill (Deactivated)
Last updated: Oct 01, 2024 by Jason Andrew
1 min read

3.14.0

The DiagScript REST API is used for update the mobile diagnostic script that is execute when the mobile users clicks the support option from the logon screen and sends the diagnostic information. 

Diagnostic script are written in JavaScript and are typically provided by the ServicePower support team. This script should only be updated by someone that is fully trained on the internals of ServiceMobility and understand any potential impact of changing this script.

ServicePower support team may provide an updated script to a customer that is hosting on-premise to gather specific information from the field in the event of problems that can't be resolved through the standard support process.

On this page:

Related pages:

  • Diagnostic Scripts

Resource URL Summary

Description

GET /seiapi/v3/trans/DiagScript/${id}

Description

PUT /seiapi/v3/trans/DiagScript/${id}

Description

DELETE /seiapi/v3/trans/DiagScript/${id}

API Specific Parameters

ParameterDescription

${id}

Identifies the ID of the mobile diagnostic script.

Valid values are:

  • default - The default script executed by any mobile user that clicks on the Send diagnostics button
  • any valid mobile user id - This is used to manage a custom diagnostic script targeted at a single specific user

Supported HTTP Methods

MethodDescription
GET

Returns the mobile diagnostic script identified by the ${id} URL parameter

PUTReplaces the mobile diagnostic script identified by the ${id} URL parameter
DELETERemoves the mobile diagnostic script identified by the ${id} URL parameter

HTTP Headers

This API uses the default ServiceMobility HTTP Headers.

HTTP Body

The body contains the mobile diagnostic script definition. 

(info) All diagnostic scripts must use an HTTP Content-Type of text/plain. 


HTTP Response

Response Codes

HTTP CodeDescription

200

OK. Request was processed successfully.

(info) Even though the request may return a successful code of 200, the body may still contain warning details.

400

Syntax error in request. The response body will provide more details on the specific reason. Verify the URI, its parameters, and request body.

401

Unauthorized. The credentials are incorrect, please verify and try again.

404

Not Found. The URL is incorrect, please verify and try again.

405

The specified HTTP method is not supported for this resource.

409

Conflict. This error usually occurs when attempting to overwrite an existing object that can not be replaced.

410

The specified object does not exists. Please verify the URI.

500

An error has occurred within ServiceMobility. Please review the error message details and if necessary, contact customer support.

Response Body

{
    "code": 400,
    "detail": {
        "message": "",
        "params": {
            "value": ""
        },
        "dataPath": ""
    }
}

Response Object Properties

PropertyTypeDescription
codeintegerThe HTTP response code.
detailobject

This object provides additional details the system provided while processing the transactions. Usually the details provide additional information on why an error occurred. However, it may also provide warning details even when the requests was successful. For example, the request may have returned a response of 200=OK, but included warnings in the response body of properties that are still being used that are marked for deprecation.

PropertyTypeDescription
messagestringA human readable message related to the processing of the request.
paramscollectionA collection of additional key/value pairs that contain the values that caused the warning/error condition.
dataPathstringIdentifies the location within the request body the message refers to.