DataFlex / Salesforce Platform APIs / Get Most Recently Used List View Metadata
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sFieldApiName
String sLookupId
Boolean iSortable
Boolean iCloneable
Boolean iCreateable
Boolean iDeletable
String sETag
String sFilterLogicString
String sLabel
String sId
String sListViewApiName
String sObjectApiName
String sV_Type
Boolean iUpdateable
Integer iSite
Integer iOwner_Alias
Integer iPhone
Integer iName
Boolean iColumnWrapSite
Boolean iColumnWrapOwner_Alias
Boolean iColumnWrapPhone
Boolean iColumnWrapName
String sVisibility
Boolean iVisibilityEditable
Integer i
Integer iCount_i
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://domain.com/services/data/v{{version}}/ui-api/mru-list-info/:SOBJECT_API_NAME" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "cloneable": false,
// "createable": true,
// "deletable": false,
// "displayColumns": [
// {
// "fieldApiName": "Name",
// "label": "Account Name",
// "lookupId": null,
// "sortable": true
// },
// {
// "fieldApiName": "Site",
// "label": "Account Site",
// "lookupId": null,
// "sortable": true
// },
// {
// "fieldApiName": "Phone",
// "label": "Phone",
// "lookupId": null,
// "sortable": true
// },
// {
// "fieldApiName": "Owner.Alias",
// "label": "Account Owner Alias",
// "lookupId": null,
// "sortable": true
// }
// ],
// "eTag": "4c63719f66dbb57c7cb86c2effc5f08b",
// "filterLogicString": null,
// "filteredByInfo": [
// ],
// "label": "Recently Viewed",
// "listReference": {
// "id": null,
// "listViewApiName": null,
// "objectApiName": "Account",
// "type": "mru"
// },
// "objectApiNames": [
// ],
// "orderedByInfo": [
// ],
// "updateable": false,
// "userPreferences": {
// "columnWidths": {
// "Site": -1,
// "Owner.Alias": -1,
// "Phone": -1,
// "Name": -1
// },
// "columnWrap": {
// "Site": false,
// "Owner.Alias": false,
// "Phone": false,
// "Name": false
// }
// },
// "visibility": "Public",
// "visibilityEditable": false
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComBoolOf Of hoJResp "cloneable" To iCloneable
Get ComBoolOf Of hoJResp "createable" To iCreateable
Get ComBoolOf Of hoJResp "deletable" To iDeletable
Get ComStringOf Of hoJResp "eTag" To sETag
Get ComStringOf Of hoJResp "filterLogicString" To sFilterLogicString
Get ComStringOf Of hoJResp "label" To sLabel
Get ComStringOf Of hoJResp "listReference.id" To sId
Get ComStringOf Of hoJResp "listReference.listViewApiName" To sListViewApiName
Get ComStringOf Of hoJResp "listReference.objectApiName" To sObjectApiName
Get ComStringOf Of hoJResp "listReference.type" To sV_Type
Get ComBoolOf Of hoJResp "updateable" To iUpdateable
Get ComIntOf Of hoJResp "userPreferences.columnWidths.Site" To iSite
Get ComIntOf Of hoJResp 'userPreferences.columnWidths."Owner.Alias"' To iOwner_Alias
Get ComIntOf Of hoJResp "userPreferences.columnWidths.Phone" To iPhone
Get ComIntOf Of hoJResp "userPreferences.columnWidths.Name" To iName
Get ComBoolOf Of hoJResp "userPreferences.columnWrap.Site" To iColumnWrapSite
Get ComBoolOf Of hoJResp 'userPreferences.columnWrap."Owner.Alias"' To iColumnWrapOwner_Alias
Get ComBoolOf Of hoJResp "userPreferences.columnWrap.Phone" To iColumnWrapPhone
Get ComBoolOf Of hoJResp "userPreferences.columnWrap.Name" To iColumnWrapName
Get ComStringOf Of hoJResp "visibility" To sVisibility
Get ComBoolOf Of hoJResp "visibilityEditable" To iVisibilityEditable
Move 0 To i
Get ComSizeOfArray Of hoJResp "displayColumns" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "displayColumns[i].fieldApiName" To sFieldApiName
Get ComStringOf Of hoJResp "displayColumns[i].label" To sLabel
Get ComStringOf Of hoJResp "displayColumns[i].lookupId" To sLookupId
Get ComBoolOf Of hoJResp "displayColumns[i].sortable" To iSortable
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "filteredByInfo" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "objectApiNames" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "orderedByInfo" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/ui-api/mru-list-info/:SOBJECT_API_NAME
Postman Collection Item JSON
{
"name": "Get Most Recently Used List View Metadata",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/mru-list-info/:SOBJECT_API_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"mru-list-info",
":SOBJECT_API_NAME"
],
"variable": [
{
"key": "SOBJECT_API_NAME",
"value": "",
"description": "Object API name"
}
]
},
"description": "Returns metadata for an object’s most recently viewed (MRU) list view."
},
"response": [
{
"name": "Get Most Recently Used List View Metadata",
"originalRequest": {
"method": "GET",
"header": [
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/mru-list-info/:SOBJECT_API_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"mru-list-info",
":SOBJECT_API_NAME"
],
"variable": [
{
"key": "SOBJECT_API_NAME",
"value": "Account",
"description": "Object API name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Fri, 06 Oct 2023 10:00:00 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "ETag",
"value": "\"4c63719f66dbb57c7cb86c2effc5f08b--gzip\""
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"cloneable\": false,\n \"createable\": true,\n \"deletable\": false,\n \"displayColumns\": [\n {\n \"fieldApiName\": \"Name\",\n \"label\": \"Account Name\",\n \"lookupId\": null,\n \"sortable\": true\n },\n {\n \"fieldApiName\": \"Site\",\n \"label\": \"Account Site\",\n \"lookupId\": null,\n \"sortable\": true\n },\n {\n \"fieldApiName\": \"Phone\",\n \"label\": \"Phone\",\n \"lookupId\": null,\n \"sortable\": true\n },\n {\n \"fieldApiName\": \"Owner.Alias\",\n \"label\": \"Account Owner Alias\",\n \"lookupId\": null,\n \"sortable\": true\n }\n ],\n \"eTag\": \"4c63719f66dbb57c7cb86c2effc5f08b\",\n \"filterLogicString\": null,\n \"filteredByInfo\": [],\n \"label\": \"Recently Viewed\",\n \"listReference\": {\n \"id\": null,\n \"listViewApiName\": null,\n \"objectApiName\": \"Account\",\n \"type\": \"mru\"\n },\n \"objectApiNames\": [],\n \"orderedByInfo\": [],\n \"updateable\": false,\n \"userPreferences\": {\n \"columnWidths\": {\n \"Site\": -1,\n \"Owner.Alias\": -1,\n \"Phone\": -1,\n \"Name\": -1\n },\n \"columnWrap\": {\n \"Site\": false,\n \"Owner.Alias\": false,\n \"Phone\": false,\n \"Name\": false\n }\n },\n \"visibility\": \"Public\",\n \"visibilityEditable\": false\n}"
}
]
}
