Chat now with support
Chat with Support

We are currently experiencing issues on our phone support and are working diligently to restore services. For support, please sign in and create a case or email supportadmin@quest.com for assistance

Stat 6.3 - System Administration Guide

Overview of Stat Administration Administrative Utilities Stat Security General Maintenance Tables
System Maintenance Service Domain Maintenance Department Maintenance Issue Tracking Maintenance Country Maintenance Customer Maintenance Object Type Maintenance PeopleSoft Environment Connection Maintenance Pre/Post Migration Steps Parameters Oracle Applications Configuration Oracle Applications Connection Maintenance Generic Application Connection Maintenance Schema Object Parameters Maintenance Data Object Maintenance PeopleSoft Search Configurations Stat Report Definition Maintenance Version Control Management Connection Maintenance
Service Domain-Specific Maintenance Configuring the Stat Central Agent Email Configuration Object Security Appendix: Sample Service Domain Configuration Appendix: User Class Rights Appendix: Creating a Staging Database Appendix: Database Tuning Appendix: Oracle Applications File Type Directory Appendix: Ports and Firewalls Appendix: REST Web Services API Appendix: SOAP-Based Web Services API Appendix: Troubleshooting Chart Appendix: stat.conf Configuration Appendix: Custom Report Files

Appendix: REST Web Services API

Stat provides programmatic access to CSR information via a Web Service API. The Stat Web Services are available when the Stat Central Agent is live. API calls represent specific operations that your client applications can use to retrieve or update data.

The following information is intended for developers and system administrators who want to use Stat Web Services to develop an interface to one or more of their in-house applications.

Authentication

The preferred authentication method for the Stat REST API is HTTP basic authentication (when using SSL).

The Stat Web client uses cookie-based authentication in the browser, so you can call REST from JavaScript on the page and rely on the authentication that the browser has established.

URI Structure

Stat REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. The Stat REST API uses the standard HTTP methods such as GET, PUT, POST and DELETE and uses JSON as its communication format. Refer to each API description below for a list of the HTTP methods available for that resource.

The URI format for Stat REST API resources has the following structure:

REST API Resources

The Stat REST API provides the following resources.

 

 

Provides access to the Stat Activity Codes.

Request

Responses

200

application/json returns list of Activity Codes or a single Activity Code for a Service Domain

400

Invalid Service Domain or no access to the Service Domain

404

Activity Code not found

Provides access to the Stat Activity Codes.

Request

Responses

200

application/json returns list of Activity Codes or a single Application for a Service Domain

400

Invalid Service Domain or no access to the Service Domain

404

Application not found

Provides access to the Stat Queue Assignments.

Request

Responses

200

application/json returns list of Queue Assignments for a Queue in a Service Domain

400

Invalid Service Domain or no access to the Service Domain

Provides access to CSRs by using the Service Domain, CSR Id, Tracking Number, or ALT Number.

Request

To create or update a CSR:

Example:

 

To update a CSR:

Example:

Responses

200

application/json returns list of CSRs or a single CSR. CSR was updated successfully.

201

CSR Created

400

Any error encountered during creation/update

Provides access to CSR Attachments by Service Domain and CSR ID.

Request

To create a CSR Attachment.

Example:

To delete a CSR Attachment:

Responses

200

application/json returns list of CSR attachments or a single CSR attachment

201

CSR Attachment Created

204

CSR Attachment Deleted

400

Invalid Service Domain or no access to the Service Domain

404

Attachment not found

Provides access to the Stat CSR Description Templates by Service Domain. You may also pass Template ID as Application Code or as CSR Type to retrieve a specific Template.

Request

Responses

200

application/json returns list of Attachments for a Service Domain and CSR ID

400

Invalid Service Domain or no access to the Service Domain

Provides access to the Stat CSR Resolution Templates by Service Domain. You may also pass the Template ID as Application Code or as CSR Type to retrieve a specific Template.

Request

Responses

200

application/json returns list of CSR Resolutions for a Service Domain

400

Invalid Service Domain or no access to the Service Domain

Provides access to Stat CSR Priorities.

 

Request

Responses

200

application/json returns list of CSR Priorities or a CSR Priority for a Service Domain

400

Invalid Service Domain or no access to the Service Domain

404

CSR Priority not found

Provides access to CSR Tasks by Service Domain and CSR ID.

Request

To create a CSR Task:

Example:

Valid taskTime states:

To update a CSR Task:

Example:

To delete a CSR Task:

Responses

200

application/json returns list of CSR Tasks or a single CSR Task

201

CSR Task Created

204

CSR Task Deleted

400

Invalid Service Domain or no access to the Service Domain

Provides access to CSR Logs by Service Domain and CSR ID.

Request

To create a CSR Log:

Example:

To update a CSR Log:

Responses

200

application/json returns list of CSR Logs or a single CSR Log

201

CSR Log Created

400

Invalid Service Domain or no access to the Service Domain

Provides access to the Stat CSR Templates.

Request

Responses

200

application/json returns list of CSR Templates or a single CSR Template for a Service Domain

400

Invalid Service Domain or no access to the Service Domain

Provides access to the Stat Customers.

Request

Responses

200

application/json returns list of Customers or a single Customer

400

Any error encountered

404

Customer not found

Provides access to Stat Customer Priorities where “Use Customer Prio” column on Service Domain is enabled.

Request

Responses

200

application/json returns list of Customer Priorities or a single Customer Priority for a Service Domain

400

Invalid Service Domain or no access to the Service Domain

404

Customer Priority not found

Provides access to the Stat Application Environment where the “Use Appl Env” column on the Service Domain is enabled.

Request

Responses

200

application/json returns list of Environments or a single Environment for a Service Domain and Application Code

400

Invalid Service Domain or no access to the Service Domain

404

Environment not found

Provides access to Stat Projects or Projects for a Service Domain.

Request

Responses

200

application/json returns list of all Projects or list of Projects for a Service Domain

400

Error in Request

404

Projects not found

Provides access to the Stat CSR Log Topics.

Request

Responses

200

application/json returns list of CSR Log Topics or a single CSR Log Topic for a Service Domain

400

Invalid Service Domain or no access to the Service Domain

404

CSR Log Topic not found

Provides access to the Stat Service Domains.

Request

Responses

200

application/json returns list of Service Domains

400

Bad request

404

Service Domain not found

Provides access to Stat Users and a list of Users who have access to a Service Domain.

Request

Responses

200

application/json returns list of Users

400

Bad request

404

User not found

Provides access to the Stat CSR Types.

Request

Responses

200

application/json returns list of CSR Type Codes or a single CSR Type Code for a Service Domain

400

Invalid Service Domain or no access to the Service Domain

404

CSR Type Code not found

Provides access to the Stat CSR Queues.

Request

Responses

200

application/json returns list of CSR Queues

400

Invalid Service Domain or no access to the Service Domain

404

CSR Queue not found

Provides access to the Stat CSR Statuses.

Request

Responses

200

application/json returns list of CSR Statuses

400

Invalid Service Domain or no access to the Service Domain

404

CSR Status not found

Provides access to the Stat Workflows.

Request

Responses

200

application/json returns list of CSR Workflows

400

Invalid Service Domain or no access to the Service Domain

404

CSR Workflow not found

Provides access to the Stat Workflow Transfer. You can access the current Status of the Workflow and the list of available transfers (targetStatuses field) for a CSR. You can then pass the Object ID of the available transfer to the PUT request in order to perform the transfer.

Request

Example:

Responses

200

application/json returns list of CSR Workflow Transfers. Transfer was performed successfully.

400

Any errors encountered.

404

CSR Workflow not found

Provides access to the Stat Migration Approvals.

Request

Example:

Responses

200

application/json returns list of CSR Migration Approvals or a successful submission of approval

400

Any errors encountered.

Provides access to the Stat Patch Approvals.

Request

Example:

Responses

200

application/json returns list of CSR Patch Approvals or a successful submission of approval

400

Any errors encountered.

Provides access to the Stat Transfer Approvals.

Request

Example:

Responses

200

application/json returns list of CSR Transfer Approvals or a successful submission of approval

400

Any errors encountered.

Provides access to the Stat CSR Archive Sets. The call for specific Archive Set returns the list of objects in the Archive set.

Request

Responses

200

application/json returns list of Archive Set or a single Archive Set for a Service Domain and CSR ID

400

Invalid Service Domain or no access to the Service Domain

404

Archive Set not found

Provides access to Stat CSR Migrations with any combination of the input parameters.

Request

Responses

200

application/json returns list of CSR Migrations

400

Any errors encountered

Provides access to the Stat CSR Migration objects.

Request

Responses

200

application/json returns list of CSR Migrations Objects

400

Any errors encountered

404

Migration not found

Provides access to a Stat execution of a planned migration.

Request

Responses

200

application/json returns staus code of 0

400

Any errors encountered

Provides access to the Stat CSR Objects.

Request

Responses

200

application/json returns list of objects in the CSR

400

Any errors encountered

404

CSR not found

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating