Versions Compared

Old Version 2

changes.mady.by.user Andrew Hill

Saved on

compared with

New Version Current

changes.mady.by.user Jason Andrew

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
title3.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. 

Warning

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.



Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel1

Related pages:

  • Diagnostic Scripts


Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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

Include Page
_Default HTTP Headers
_Default 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. 

 


Include Page
_REST Response Codes
_REST Response Codes