REST APIs : Retrieving the IDs of objects : How to retrieve an object's internal ID
  
How to retrieve an object's internal ID
Retrieving the ID of a object (user, widget, dashboard, etc.) allows you to use the ID in subsequent requests that require it. Every object has an internal ID.
An active session
Knowledge of your base URI
Write permission
You likely have several objects of a specific type, but to modify a specific object you must use its internal ID. The internal ID does not change, so while attributes such as the title, owner, or the maximum number of items that can be shown can change, the ID remains constant.
Video 2: Extracting data from a dashboard
1. Issue a GET base-uri/session.
For this Observer Apex object...
Use this endpoint
alarm
/alarms
business group
/businessGroups
certificate
/certificates
dashboard
/dashboards
gigastor
/gigastors
observer
/observers
user
/users
widget
/widgets
For this Observer Management Server (OMS) object...
Use this endpoint
asset
/assets
asset group
/assetGroups
asset policy
/assetPolicies
asset upgrade policy
/relationships
certificate
/certificates
license
/licenses
permission
/permissions
server upgrade policy
/upgradepolicies
user
/users
user group
/userGroups
For this Observer Analyzer object...
Use this endpoint
GigaStor
/gs/traces
Jobs
/jobs
System
/about
The server returns a response body that contains something similar to this JSON example. This example is for Apex widgets. The basic structure is similar for the other object types.
Figure 3: Select All
{
"data": {
"widgets": [
{
"id": "01DFB2A2-464C-11E4-9BCF-BCAEC5015590",
"title": "Application Performance Summary Table",
"category": "AGGREGATE",
"widgetType": "TABLE",
"maxItems": 10,
"owner": {
"ownerType": "SYSTEM"
},
"options": {
"numberFormat": "METRIC"
},
"fields": [],
"etag": "2ACD95DD7846E4119BCFBCAEC5015590"
},
{
"id": "0591DFF5-D23C-11E4-A203-000C29055050",
"title": "Corporate Office HTTP Traffic",
"category": "AGGREGATE",
"widgetType": "GRAPH",
"maxItems": 10,
"owner": {
"ownerType": "USER",
"userId": "A3BD18A4-48C2-11E4-8F60-0050562B9EF5"
},
"options": {
"numberFormat": "METRIC",
"graphType": "BAR"
},
"fields": [],
"etag": "F6DF91053CD2E411A203000C29055050"
}
]
}
}
2. Review the response body and find the name or title of the object you want to use. The ID you seek is nearby.
If you have many items to search through, you may want to search the text in a text editor.
The ID may be above or below the name or title field.
3. Copy the ID.
 
After you know the internal ID you can save the query, because you know the ID will not change.