Use case: Customer wants to submit a request for DWPC service named “Report an issue” using Digital Workplace Catalog REST API via postman.

Before we start, you should always have the following information in mind:

Base URI

This base URI /api/myit-sb/ is always used for calling the BMC Helix Digital Workplace Catalog server, below are some base URI examples:
 

Header

The following header is the most common used for all requests:
 

• default-bundle-scope: myit-sb
• Content-Type: application/json
• X-Requested-By: <any_value>

Authentication

To be able to make REST API calls, you need to log in to the application by using the users/login endpoint to be granted a session token, which is valid for about 30 minutes. The system-generated token must be included in all subsequent calls for the system to trust requests from the application or script that has been granted that token. This token is typically sent back and forth as an AR-JWT cookie.

NOTE: Please make sure the user login id used to generate the authentication token must match with the login id present in the CTM:People form. If the login id does not match you may get the below error while trying to create a SB Request using end point  api/myit-sb/requests

Please note that for 21.x and above, the domain name doesn't need to be passed in the Login ID as it did in previous versions.

Following are the request activities used in Postman to submit a request using Digital Workplace Catalog Rest API.
 

1. Generate a token.

2. Search all Digital Workplace Catalog Services

For this use case i want to find DWPC service named “Report an issue”.

3. Initiate a Request

As we saw in previous activity, service named “Report an issue” has id: “103”, so will proceed to use it in the following activity:

Note: In the response we can see “requestId”: “38” was created, save that value, it will be used in next activities as well.
 

4. Get service questionnaire

Once we initiated a dwpc request, we need to get the questionnaire related to it, so in the request url you must include the “requestId” created in the previous activity, in this use case is 38
 

We can see following in questionnaire response, those values will be used in next activities.
"questionnaire": 
        "id": "21",

DWPC service has three questions which are the following:

• Question 1

"type": "TextField",
"id": "83cbabc6-df74-b5c1-0ed9-c659e147b367",
"label": "Issue Summary",

• Questions 2

"type": "TextArea",
"id": "057aacca-da48-813a-fee5-bde22663e086",
"label": "Issue Details",

• Question 3

"type": "Attachment",
"id": "69b51a25-7818-e8d0-d247-d90c95c2e3ed",
"label": "Attachment",



 

5. To send an answer to a first question

In the request url we included the “requestId”: “38” created in activity 3, in the body we included questionnaire info. We’ll send this request only for non-attachments questions, in a separate request we’ll the attachment question.
 

NOTE: you must send each question in a single request.

1. To send an answer for a 2^nd question

In the request url we included the “requestId”: “38” created in previous activities, and in the body, we included questionnaire info. We send only in this request a single non-attachments questions, in a separate request we’ll send it.
 

6. Prepare an attachment

Note: The Key file type must be “File”.

 

7. Submit an attachment

The question id we got t it from activity 4 Get service questionnaire, and the “answers” is the value of previous activity “contentId”, and in the url is included the serviceRequestId.

8. To submit a single DWPC request

As final activity, we submit a request, in the url includes values 103 & 38 which correspond to "serviceId" : "103" & "requestId": "38", obtained from activity 3.
 

Note: id 38 corresponds to DWPC Request ID and id 11 corresponds to Order ID.

9. UI validations

NOTE: Attached is the postman collection used and an extended version of this KA.



10: To Sync the status of the Request
https://customername-restapi.onbmc.com/api/myit-sb/requests/catalog request id/poll

DWPCatalog URL/api/myit-sb/requests/catalog request id/poll

Body to be kept blank