Service requests
Contributors
Download PDF of this page
Use the methods listed in the following table to create and retrieve service requests.
HTTP Method | Path | Description |
---|---|---|
|
|
Retrieve service requests. |
|
|
Retrieve a service request by ID. |
|
|
Create a service request. |
|
|
Retrieve service request categories. |
Service request attributes
The following table lists the service request attributes.
Attribute | Type | Description |
---|---|---|
|
String |
An identifier for the service request. For example: |
|
String |
The subject of the service request. |
|
String |
A comment on the service request |
|
String |
The category of the request: Backup, disaster recovery, technical, other, or subscription. |
|
String |
The priority of the service request: very low, low, normal, high, or urgent. |
|
String |
The Zuora subscription number. |
|
– |
Subscription commitment details, including:
|
|
String |
The zone name. |
|
String |
The subtenant identifier. |
|
String |
Storage object type: File server or block store. |
|
String |
The identifier of the storage object. |
|
String |
The service type: File services, block storage, or object storage. |
Retrieve service requests
Use the method listed in the following table to retrieve service request categories for the specified tenant.
HTTP Method | Path | Description | Parameters |
---|---|---|---|
|
|
Retrieve service requests. |
|
Required request body attributes: none
Request body example:
none
Response body example:
{ "status": { "user_message": "Okay. Returned 1 record.", "verbose_message": "", "code": 200 }, "result": { "returned_records": 1, "total_records": 34, "sort_by": "created", "order_by": "desc", "offset": 6, "limit": 1, "records": [ { "id": "SRQ0035952014", "subject": "DR Failover - fileserver", "description": "catgory:Disaster Recovery Failover \n subtenant: DefaultSubtenants2 \n region: au-east2 \n zone: au-east2-a \n fileserver: Demotsysserv1 \n tenant:MyOrg \n comments:comments", "priority": "Urgent", "status": "New", "createdDate": "2020-05-22T04:23:12+0000", "updatedDate": "2020-05-22T04:23:12+0000" } ] } }
Retrieve a service request by ID
Use the method listed in the following table to retrieve a service request by service request ID.
HTTP Method | Path | Description | Parameters |
---|---|---|---|
|
|
Retrieve a service request by ID. |
|
Required request body attributes: none
Request body example:
none
Response body example:
{ "status": { "user_message": "Okay. Returned 1 record.", "verbose_message": "", "code": 200 }, "result": { "returned_records": 1, "records": [ { "id": "SRQ0035952014", "subject": "DR Failover - fileserver", "description": "catgory:Disaster Recovery Failover \n subtenant: DefaultSubtenants2 \n region: au-east2 \n zone: au-east2-a \n fileserver: Demotsysserv1 \n tenant:MyOrg \n comments:comments", "priority": "Urgent", "status": "New", "createdDate": "2020-05-22T04:23:12+0000", "updatedDate": "2020-05-22T04:23:12+0000" } ] } }
Create a service request
Use the method listed in the following table to create a service request.
HTTP Method | Path | Description | Parameters |
---|---|---|---|
|
|
Create a service request. |
|
Required request body attributes: the required attributes are dependent on the category of service request. The following table lists the request body attributes.
Category | Required |
---|---|
Subscription |
|
Disaster recovery |
|
Technical |
|
Other |
Zone |
Request body example:
{ "subject": "string", "comment": "string", "category": "subscription", "priority": "Normal", "subscription": "A-S00003969", "commitment": { "service_level": "standard", "new_commitment": 10 }, "zone": "au-east1-a", "subtenant_id": "5d2fb0fb4f47df00015274e3", "storage_object_type": "fileserver", "storage_object_id": "5d2fb0fb4f47df00015274e3", "service_type": "File Services" }
Response body example:
{ "status": { "user_message": "string", "verbose_message": "string", "code": "string" }, "result": { "returned_records": 1, "records": [ { "id": "string", "subject": "string", "description": "string", "status": "New", "priority": "Normal", "createdDate": "2020-05-12T03:18:25+0000", "UpdatedDate": "2020-05-12T03:18:25+0000" } ] }
Retrieve service request categories
The following table lists the retrieve service request categories for a specified tenant.
HTTP Method | Path | Description | Parameters |
---|---|---|---|
|
|
Retrieve service requests categories. |
|
Required request body attributes: none
Request body example:
none
Response body example:
{ "status": { "user_message": "Okay. Returned 5 records.", "verbose_message": "", "code": 200 }, "result": { "returned_records": 5, "records": [ { "key": "dr", "value": "Disaster Recovery Failover" }, { "key": "technical", "value": "Technical Issue" }, { "key": "other", "value": "Other" }, { "key": "subscription", "value": "Subscription Management" }, { "key": "backup", "value": "Backup Restore" } ] } }