Stat 7.0 - System Administration Guide

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

Response/Status Code	Description
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

Response/Status Code	Description
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

Response/Status Code	Description
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

Response/Status Code	Description
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

Response/Status Code	Description
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

Response/Status Code	Description
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

Response/Status Code	Description
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

Response/Status Code	Description
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

Response/Status Code	Description
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

Response/Status Code	Description
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

Response/Status Code	Description
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

Response/Status Code	Description
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

Response/Status Code	Description
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

Response/Status Code	Description
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

Response/Status Code	Description
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

Response/Status Code	Description
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

Response/Status Code	Description
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

Response/Status Code	Description
200	application/json returns list of Users
400	Bad request
404	User not found

Provides access to the Stat CSR Types.

Request

Responses

Response/Status Code	Description
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

Response/Status Code	Description
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

Response/Status Code	Description
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

Response/Status Code	Description
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

Response/Status Code	Description
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

Response/Status Code	Description
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

Response/Status Code	Description
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

Response/Status Code	Description
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.

Request

Responses

Response/Status Code	Description
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

Response/Status Code	Description
200	application/json returns list of CSR Migrations
400	Any errors encountered

Provides access to the Stat CSR Migration objects.

Request

Responses

Response/Status Code	Description
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

Response/Status Code	Description
200	application/json returns staus code of 0
400	Any errors encountered

Provides access to the Stat CSR Objects.

Request

Responses

Response/Status Code	Description
200	application/json returns list of objects in the CSR
400	Any errors encountered
404	CSR not found

This API will be responsible to add new objects to a CSR.

Request

Example

Responses

Response/Status Code	Description
200	Objects added
400	Any errors encountered. Probably due to incorrect user input
500	Some unhandled exception

Error Handling

 

Example error response body

Scenario	Message	Response code
Compulsory parameter missing	<Parameter_Name> value Can’t be null or empty	-2
Wrong CSR, Service domain value provided	Provided value for csrId or sdCd is invalid	-3
Value not allowed	<Parameter_Name> value is invalid	-4
User doesn’t have the rights to do the specific operation	Access denied. User doesn’t at least one of these rights : <RIGHT_LIST>	-5
CSR is locked by someone else	CSR is locked by {LOCKED_BY_USER_ID}. User can't perform the following operation	-6
Trying to create a final archive set in a CSR which already has a final archive set.	Final archive set is already present. Can't add more final archive sets	-10
When the user chooses a dev environment for archive sets creation and also when the user has a file object in the list of objects that they want to archive, but they haven’t picked a “files from“ value	You must select Environment, VCM or working in filesFrom field	-11
When the archive set has no objects to add	No objects added in archive set.	-12
When user is trying to add a final archive set, however the final archive set doesn’t contain all CSR belonging to the chosen environment.	A final archive set must contain all CSR objects of the selected environment.	-13

Change the lock status of single or multiple objects.

 

Request

Example

Responses

Response/Status Code	Description
200	Lock status changed
400	Any errors encountered. Probably due to incorrect user input
500	Some unhandled exception

Error Handling

 

Example error response body

Scenario	Message	Error code
Compulsory parameter missing	<Parameter_Name> value Can’t be null or empty	-2
Wrong CSR, Service domain value provided	Provided value for csrId or sdCd is invalid	-3
Value not allowed	<Parameter_Name> value is invalid	-4
User doesn’t have the rights to do the specific operation	Access denied. <user> doesn’t have the rights to perform the following operation	-5
CSR is locked by someone else	Csr is locked by {LOCKED_BY_USER_ID}. User can't perform the following operation	-6
Assigned developer doesn't have access to that object	Assigned developer does not have access to the selected object type	-7
When another process is running in that CSR	Objects in process so You can't perform following action	-8

When this API is called, these objects will be removed from the CSR and all archive sets. The removal of the objects from the archive sets will be asynchronous.

Request

Example

{

"objList":

[

]

}

Responses

Response/Status Code	Description
200	Lock status changed
400	Any errors encountered. Probably due to incorrect user input
500	Some unhandled exception

Error Handling

Example error response body

Scenario	Message	Error code
Compulsory parameter missing	<Parameter_Name> value Can’t be null or empty	-2
Wrong CSR, Service domain value provided	Provided value for csrId or sdCd is invalid	-3
Value not allowed	<Parameter_Name> value is invalid	-4
User doesn’t have the rights to do the specific operation	Access denied. <user> doesn’t have the rights to perform the following operation	-5
CSR is locked by someone else	Csr is locked by {LOCKED_BY_USER_ID}. User can't perform the following operation	-6
Assigned developer doesn't have access to that object	Assigned developer does not have access to the selected object type	-7
When another process is running in that CSR	Objects in process so You can't perform following action	-8

With this API you can add objects of another CSR in your current CSR.

Request

Example

{

"sourceCsr": {

"csrId": 1,

"sdCd": "Dm1"

},

"objIds": [

2020,

2021

]

}

Responses

Response/Status Code	Description
200	Objects reassigned. Look out for partial failure scenarios which can happen when only some of the objects have been assigned successfully
400	Any errors encountered. Probably due to incorrect user input
500	Some unhandled exception

Error Handling

Example error response body

Scenario	Message	Error code
Compulsory parameter missing	<Parameter_Name> value Can’t be null or empty	-2
Wrong CSR, Service domain value provided	Provided value for csrId or sdCd is invalid	-3
Value not allowed	<Parameter_Name> value is invalid	-4
User doesn’t have the rights to do the specific operation	Access denied. <user> doesn’t have the rights to perform the following operation	-5
CSR is locked by someone else	Csr is locked by {LOCKED_BY_USER_ID}. User can't perform the following operation	-6
Assigned developer doesn't have access to that object	Assigned developer does not have access to the selected object type	-7
When another process is running in that CSR	Objects in process so You can't perform following action	-8

Remove archive sets from your CSR.

Request

 

Responses

Response/Status Code	Description
200	Objects reassigned. Look out for partial failure scenarios which can happen when only some of the objects have been assigned successfully
400	Any errors encountered. Probably due to incorrect user input
500	Some unhandled exception

Error Handling

Example error response body

Scenario	Message	Error code
Compulsory parameter missing	<Parameter_Name> value Can’t be null or empty	-2
Wrong CSR, Service domain value provided	Provided value for csrId or sdCd is invalid	-3
Value not allowed	<Parameter_Name> value is invalid	-4
User doesn’t have the rights to do the specific operation	Access denied. <user> doesn’t have the rights to perform the following operation	-5
CSR is locked by someone else	Csr is locked by {LOCKED_BY_USER_ID}. User can't perform the following operation	-6
Invalid archive set ID provided	Invalid archive set id. Make sure archive is not deleted	-9

Creates archive sets in your CSR.

Request

Example

{

}

Responses

Response/Status Code	Description
200	Archive set created
400	Any errors encountered. Probably due to incorrect user input
500	Some unhandled exception

Error Handling

Example error response body

Scenario	Message	Error code
Compulsory parameter missing	<Parameter_Name> value Can’t be null or empty	-2
Wrong CSR, Service domain value provided	Provided value for csrId or sdCd is invalid	-3
Value not allowed	<Parameter_Name> value is invalid	-4
User doesn’t have the rights to do the specific operation	Access denied. <user> doesn’t have the rights to perform the following operation	-5
CSR is locked by someone else	Csr is locked by {LOCKED_BY_USER_ID}. User can't perform the following operation	-6
When the archive set has no objects to add	No objects added in archive set.	-12
When user is trying to add a final archive set, however the final archive set doesn’t contain all CSR belonging to the chosen environment.	A final archive set must contain all CSR objects of the selected environment.	-13

This API is responsible to fetch all the logs of archive set.

Request

Responses

Response/Status Code	Description
200	Archive set logs fetched
400	Any errors encountered. Probably due to incorrect user input
500	Some unhandled exception

Error Handling

Example error response body

Scenario	Message	Error code
Compulsory parameter missing	<Parameter_Name> value Can’t be null or empty	-2
Wrong CSR, Service domain value provided	Provided value for csrId or sdCd is invalid	-3
Wrong Archive ID provided	Invalid archive set id. Make sure archive is not deleted	-9
User is trying to access a CSR to which they don’t have read access	You do not have access to perform read operations on this CSR.	-31

This API will be responsible to enable or disable the ready to migrate flag of archive set.

Request

Responses

Response/Status Code	Description
200	“Ready to migrate” flag changed
400	Any errors encountered. Probably due to incorrect user input
500	Some unhandled exception

Error Handling

Example error response body

Scenario	Message	Error code
Compulsory parameter missing	<Parameter_Name> value Can’t be null or empty	-2
Wrong CSR, Service domain value provided	Provided value for csrId or sdCd is invalid	-3
Value not allowed	<Parameter_Name> value is invalid	-4
Csr is locked by someone else	Csr is locked by {LOCKED_BY_USER_ID}. User can't perform the following operation	-6
Invalid archive set ID provided	Invalid archive set id. Make sure archive is not deleted	-9
Approvals are present	This action is not allowed. There are approvals present.	-14
Trying to change the ready to migrate flag to its current value.	A final archive set must contain all CSR objects of the selected environment.	-16

Downloads the archive set logs in TEXT/PLAIN format.

Request

Responses

Response/Status Code	Description
200	Logs will be downloaded.
400	Any errors encountered. Probably due to incorrect user input
500	Some unhandled exception

Error Handling

Example error response body

Scenario	Message	Error code
Compulsory parameter missing	<Parameter_Name> value Can’t be null or empty	-2
Wrong CSR, Service domain value provided	Provided value for csrId or sdCd is invalid	-3

Delete/Clear archive set logs.

Request

Responses

Response/Status Code	Description
200	Logs will be cleared.
400	Any errors encountered. Probably due to incorrect user input
500	Some unhandled exception

Error Handling

Example error response body

Scenario	Message	Error code
Compulsory parameter missing	<Parameter_Name> value Can’t be null or empty	-2
Wrong CSR, Service domain value provided	Provided value for csrId or sdCd is invalid	-3
Csr is locked by someone else	Csr is locked by {LOCKED_BY_USER_ID}. User can't perform the following operation	-6
Invalid archive set ID provided	Invalid archive set id. Make sure archive is not deleted	-9

Changes the migration order of objects to default migration order.

Request

Example

[

]

Responses

Response/Status Code	Description
200	Archive set object’s migration order will be changed to default migration order. Look out for partial failure scenarios where the API worked for only some of the objects.
400	Any errors encountered. Probably due to incorrect user input
500	Some unhandled exception

Error Handling

Example error response body

Scenario	Message	Error code
Compulsory parameter missing	<Parameter_Name> value Can’t be null or empty	-2
Wrong CSR, Service domain value provided	Provided value for csrId or sdCd is invalid	-3
User doesn’t have the rights to do the specific operation	Access denied. User doesn’t at least one of these rights : <RIGHT_LIST>	-5
Csr is locked by someone else	CSR is locked by {LOCKED_BY_USER_ID}. User can't perform the following operation	-6
Invalid archive set ID provided	Invalid archive set id. Make sure archive is not deleted	-9
Invalid Obj Id provided	One or more object Ids is invalid.	-18

Set migration order of archive set objects.

Request

Example

{

"request": [

{

"objId": <objId>,

"migrOrder": <migrOrder>

},

{

"objId": <objId>,

"migrOrder": <migrOrder>

}

]

}

Responses

Response/Status Code	Description
200	Archive set object’s migration order will be changed to the requested migration order. Look out for partial failure scenarios where the API worked for only some of the objects.
400	Any errors encountered. Probably due to incorrect user input
500	Some unhandled exception

Error Handling

Example error response body

Scenario	Message	Error code
Compulsory parameter missing	<Parameter_Name> value Can’t be null or empty	-2
Wrong CSR, Service domain value provided	Provided value for csrId or sdCd is invalid	-3
Value not allowed	<Parameter_Name> value is invalid	-4
User doesn’t have the rights to do the specific operation	Access denied. User doesn’t at least one of these rights : <RIGHT_LIST>	-5
Csr is locked by someone else	Csr is locked by {LOCKED_BY_USER_ID}. User can't perform the following operation	-6
Invalid archive set ID provided	Invalid archive set id. Make sure archive is not deleted	-9
Invalid object ID provided	One or more object Ids is invalid.	-18

Add Objects in Archive Set .

Request

Example

{

"syncPsObjFlag": <syncPsObjFlag>,

"objIds": [<objId1>, <objId2>]

}

Responses

Response/Status Code	Description
200	Archive set objects will be added. Look out for partial failure scenarios where the API worked for only some of the objects.
400	Any errors encountered. Probably due to incorrect user input
500	Some unhandled exception

Error Handling

Example error response body

Scenario	Message	Error code
Compulsory parameter missing	<Parameter_Name> value Can’t be null or empty	-2
Wrong CSR, Service domain value provided	Provided value for csrId or sdCd is invalid	-3
Value not allowed	<Parameter_Name> value is invalid	-4
User doesn’t have the rights to do the specific operation	Access denied. User doesn’t at least one of these rights : <RIGHT_LIST>	-5
Csr is locked by someone else	Csr is locked by {LOCKED_BY_USER_ID}. User can't perform the following operation	-6
Invalid archive set ID provided	Invalid archive set id. Make sure archive is not deleted	-9
Invalid object ID provided	One of the object IDS is either invalid or the user doesn't have permission to its object type.	-18

Export the list of archive set objects in plain text format.

Request

Responses

Response/Status Code	Description
200	Exported list of archive set objects as a txt file
400	Any errors encountered. Probably due to incorrect user input
500	Some unhandled exception

Error Handling

Example error response body

Scenario	Message	Error code
Compulsory parameter missing	<Parameter_Name> value Can’t be null or empty	-2
Wrong CSR, Service domain value provided	Provided value for csrId or sdCd is invalid	-3
Invalid archive set ID provided	Invalid archive set id. Make sure archive is not deleted	-9

Re-archive those objects which are eligible to re-archive the objects.

Request

Example

{

"objIds": [<objId1>,<objId2>]

}

Responses

Response/Status Code	Description
200	Archive set objects will be added. Look out for partial failure scenarios where the API worked for only some of the objects.
400	Any errors encountered. Probably due to incorrect user input
500	Some unhandled exception

Error Handling

Example error response body

Scenario	Message	Error code
Compulsory parameter missing	<Parameter_Name> value Can’t be null or empty	-2
Wrong CSR, Service domain value provided	Provided value for csrId or sdCd is invalid	-3
Value not allowed	<Parameter_Name> value is invalid	-4
User doesn’t have the rights to do the specific operation	Access denied. User doesn’t at least one of these rights : <RIGHT_LIST>	-5
Csr is locked by someone else	Csr is locked by {LOCKED_BY_USER_ID}. User can't perform the following operation	-6
Invalid archive set ID provided	Invalid archive set id. Make sure archive is not deleted	-9
Invalid object ID provided	One of the object IDS is either invalid or the user doesn't have permission to its object type.	-18
If archive set type is base and objects has not been locked.	One or more of the selected objects are not locked in this CSR.	-22
Objects need to honor either of these conditions to be fit for re-archival • Archive status should be Archive/Warn or Archive/Error • Already archived object’s are only eligible if its a base archive set.	This object is unfit for Re-archive object operation.	-23

Delete archive set objects

Request

Example

{

}

Responses

Response/Status Code	Description
200	Archive set objects will be deleted. Look out for partial failure scenarios where the API worked for only some of the objects.
400	Any errors encountered. Probably due to incorrect user input
500	Some unhandled exception

Error Handling

Example error response body

Scenario	Message	Error code
Compulsory parameter missing	<Parameter_Name> value Can’t be null or empty	-2
Wrong CSR, Service domain value provided	Provided value for csrId or sdCd is invalid	-3
Value not allowed	<Parameter_Name> value is invalid	-4
User doesn’t have the rights to do the specific operation	Access denied. User doesn’t at least one of these rights : <RIGHT_LIST>	-5
Csr is locked by someone else	Csr is locked by {LOCKED_BY_USER_ID}. User can't perform the following operation	-6
Invalid archive set ID provided	Invalid archive set id. Make sure archive is not deleted	-9
Invalid object ID provided	One of the object IDS is either invalid or the user doesn't have permission to its object type.	-18
If archive set’s type is base or final	Base archive set error message: Objects for a baseline Archive Set are managed dynamically. You cannot manually remove objects. Final archive set error message: Objects for a final Archive Set are managed dynamically. You cannot manually remove objects.	-21

Modify the action and upgrade values for eligible archive set objects.

Request

Example

{

"request": [

{

"objectId" : 2,

"action" : "delete",

"upgrade" : "N"

},

]

}

Responses

Response/Status Code	Description
200	Archive set objects’ migration flag will be updated. Look out for partial failure scenarios where the API worked for only some of the objects.
400	Any errors encountered. Probably due to incorrect user input
500	Some unhandled exception

Error Handling

Example error response body

Scenario	Message	Error code
Compulsory parameter missing	<Parameter_Name> value Can’t be null or empty	-2
Wrong CSR, Service domain value provided	Provided value for csrId or sdCd is invalid	-3
Value not allowed	<Parameter_Name> value is invalid	-4
User doesn’t have the rights to do the specific operation	Access denied. User doesn’t at least one of these rights : <RIGHT_LIST>	-5
Csr is locked by someone else	Csr is locked by {LOCKED_BY_USER_ID}. User can't perform the following operation	-6
Invalid archive set ID provided	Invalid archive set id. Make sure archive is not deleted	-9
Invalid object ID provided	One or more object Ids is invalid.	-18
User is trying to update the migration flag for those objects which are not eligible	This object is unfit for archive set objects migration flags modification	-27
If user has provided CopyProp action value but it doesn’t fit with that object	This object doesn't fit for CopyProp action	-28

Copy an existing archive set .

Request

Example

{

}

Responses

Response/Status Code	Description
200	Archive set will be copied.
400	Any errors encountered. Probably due to incorrect user input
500	Some unhandled exception

Error Handling

Example error response body

Scenario	Message	Error code
Compulsory parameter missing	<Parameter_Name> value Can’t be null or empty	-2
Wrong CSR, Service domain value provided	Provided value for csrId or sdCd is invalid	-3
Value not allowed	<Parameter_Name> value is invalid	-4
User doesn’t have the rights to do the specific operation	Access denied. User doesn’t at least one of these rights : <RIGHT_LIST>	-5
Csr is locked by someone else	Csr is locked by {LOCKED_BY_USER_ID}. User can't perform the following operation	-6
Trying to create a final archive set in a CSR which already has a final archive set.	Final archive set is already present. Can't add more final archive sets	-10
When the user chooses a dev environment for archive sets creation and also when the user has a file object in the list of objects that they want to archive, but they haven’t picked a “files from“ value	You must select Environment, VCM or working in filesFrom field	-11
When the archive set has no objects to add	No objects added in archive set.	-12
When user is trying to add a final archive set, however the final archive set doesn’t contain all CSR belonging to the chosen environment.	A final archive set must contain all CSR objects of the selected environment.	-13

Edit an existing archive set details.

Request

Example

{

},

},

}

}

Responses

Response/Status Code	Description
200	Archive set details will be updated.
400	Any errors encountered. Probably due to incorrect user input
500	Some unhandled exception

Error Handling

Example error response body

Scenario	Message	Error code
Compulsory parameter missing	<Parameter_Name> value Can’t be null or empty	-2
Wrong CSR, Service domain value provided	Provided value for csrId or sdCd is invalid	-3
Value not allowed	<Parameter_Name> value is invalid	-4
User doesn’t have the rights to do the specific operation	Access denied. User doesn’t at least one of these rights : <RIGHT_LIST>	-5
Csr is locked by someone else	Csr is locked by {LOCKED_BY_USER_ID}. User can't perform the following operation	-6
Invalid archive set ID provided	Invalid archive set id. Make sure archive is not deleted	-9
If User doesn’t provide value for shortDescr, comments or releaseDesc	At least one of the value is required	-26

Edit an existing archive set details.

Request

Responses

Response/Status Code	Description
200	Archive set object will be downloaded
400	Any errors encountered. Probably due to incorrect user input
500	Some unhandled exception

Error Handling

Example error response body

Scenario	Message	Error code
Compulsory parameter missing	<Parameter_Name> value Can’t be null or empty	-2
Wrong CSR, Service domain value provided	Provided value for csrId or sdCd is invalid	-3
Invalid archive set ID provided	Invalid archive set id. Make sure archive is not deleted	-9
User is trying to download non archived or not eligible object	This object is unfit to download	-29

Appendix: SOAP-Based 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, such as:

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, specifically for managing CSRs.

NOTE: Stat Web Services have been tested for Microsoft .NET Framework (2.0 or higher) and Java (JDK 1.5 or higher) development environments. They have not been validated on any other development environments.

Stat Web Services are implemented using the JAX-WS 2.0 technology available in JBoss application servers. When developing the interface for Web Services, the Top-Down approach (also known as WSDL-first approach) is used. All WSDL files are created using the Document/Literal Wrapped strategy.

NOTE: Sample code for Stat Web Services APIs is available on the Stat installation media under the folder web_services_sample.

Users accessing Stat through Web Services must establish a valid connection. The Stat Central Agent maintains a list of valid connections, which are refreshed each time a user makes a call to any service. The user should close the connection after making all the desired service calls. If a connection is left open longer than a specified period of time, the Stat Central Agent automatically closes the connection and the user will have to establish a new connection for any future service calls. The default session timeout value is set for 30 seconds (30000) in the System Maintenance window. For more information, see Parameters Tab .

Services and Exposed Methods

This section documents the Login Service, CSR Service, and Approval Service and their exposed Methods.