Service Process Update

Retrieve or update a service process.

Resource 

1/connect/service-excellence/service-catalog-request/{svcCatalogRequestId}

The {svcCatalogRequestId} parameter is the ID of the service catalog request.

Available Version 

57.0

Requires Chatter 

No

HTTP Methods 

GET PATCH

Response Body for GET 

Service Process Record

Request Body for PATCH 

JSON Example 

1{
2  "attributes": {
3    "data": {
4      "IncidentDate": {
5        "value": "2023-03-10"
6      },
7      "ProductType": {
8        "value": "ATM / debit card"
9      },
10      "CaseParticipantInfo": {
11        "value": [
12          {
13            "Participant": "003xx000004WhGKAA0",
14            "Status": "Active",
15            "age_of_participant": 30
16          },
17          {
18            "Participant": "003xx000004WhGdAAK",
19            "Status": "Active",
20            "age_of_participant": 20
21          }
22        ]
23      },
24      "accountInfo": {
25        "value": [
26          {
27            "accountId": "001B000001UZDhOIAX",
28            "accountName": "Rachael Adams"
29          },
30          {
31            "accountId": "001B000001Ua331IAB",
32            "accountName": "Robert Williams"
33          }
34        ]
35      },
36      "case_status": {
37        "value": "Active"
38      },
39      "case_description": {
40        "value": "Sample test"
41      },
42      "base_field": {
43        "value": "Value on base field"
44      },
45      "cities": {
46        "value": [
47          "Delhi",
48          "Hyderabad"
49        ]
50      }
51    }
52  },
53  "documentInfo": {
54    "data": [
55      {
56        "id": "069xx0000004C92AAE",
57        "name": "Addhar",
58        "typeId": "2F0dexx0000000001"
59      }
60    ]
61  },
62  "svcCatalogItemDefApiName": "fsc_complaint_management"
63}

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
attributesMap<String, Generic Object>Field name-value pairs, object names and field name-value pairs, or both. The attributes property populates the base and extended attributes defined in Service Process Studio and must match their structure.Required57.0
caseInfoMap<String, Generic Object>Field name-value pairs for the Case object.Optional57.0
documentInfoDocument Info Attributes[]List of documents.Optional57.0
svcCatalogItem​DefApiNameStringAPI Name of the related Service Catalog Item Definition. See SvcCatalogItemDef.Required57.0

Request Parameters for PATCH 

Parameter NameTypeDescriptionRequired or OptionalAvailable Version
serviceProcessRequestDataObjectTop-level parameter for the request body.Required58.0

Response Body for PATCH 

Service Process Output