Objects Data Service: Get Object data
Details
Gets the whole Object with the specified Configuration Item name and object ID. The Service returns exclusively the data belonged to object (e.g. attributes, N:1 relations). Virtual attributes, like N:M or 0/1 to N relations are not returned and need to be obtained with the additional Web Service request.
Request
URL
GET http(s)://{server_domain}/M42Services/api/data/objects/{ciname}/{objectid}?full={full}
URL Attributes and Query Parameters
Element | Description | Type | Required |
---|---|---|---|
ciName | Technical name of the Configuration Item (e.g. for Incident is "SPSActivityTypeIncident") | string | Required |
objectId | Id of the Object of specified Configuration Item | GUID | Required |
full |
Signals to load the whole Object with all related multi-fragments data, otherwise, all multi-fragments are omitted. Default value: false | boolean | Optional |
Headers
For a list of available HTTP request headers see Web Services: REST API integration.
Element | Description | Type | Required |
---|---|---|---|
Explicit-Language |
Examples:
|
string | Optional |
Response
The whole Object with all defined Data Definitions and attributes. The Multi-fragments are present only when parameter full is set.
The result object has the following structure:
{
"ID":"{Object ID}",
"DataDefinitionName1":{
"ID":"{DataDefinitionName1 Fragment Id}",
"TimeStamp":"{Concurrecy Marker}",
"Attribute1":"Value for Attribute1",
"AttributeN":null
},
"MultiFragmentDataDefinitionName1":[{
"ID":"{MultiFragmentDataDefinitionName1Fragment Id}",
"TimeStamp":"{Concurrecy Marker}",
"Attribute1":"Value for Attribute1",
"AttributeN":null}]
}
TimeStamp is a special marker is used for the concurrency issues handling on modifying the Fragment. TimeStamp is generated for each Object Fragment.
Status codes and errors
Exception | Condition |
---|---|
404 | The object with the specified Configuration Item and Object ID is not present, or not allowed for the caller. |
Examples
Retrieve Category Object in German
http://{server_domain}/m42Services/api/data/objects/SPSScCategoryType/5261E772-9C19-E111-4789-005056C00008?full=false
Authorization: Bearer {token}
Explicit-Language: de
Response
{
"ID":"5261e772-9c19-e111-4789-005056c00008",
"SPSScCategoryClassBase":{
"ID":"5861e772-9c19-e111-4789-005056c00008",
"TimeStamp":"AAAAAAAFeWQ=",
"DefaultRecipientRole":"a3833cea-a219-e111-ea9f-00116755911a",
"Parent":"8fe597cd-9fbf-4552-a061-ca15defb1291",
"EscalationRole":"c885aba9-a419-e111-ea9f-00116755911a",
"DefaultSubject":null,
"Description":"Tickets im Zusammenhang mit dem automatisierten Enrollment mobiler Geräte.",
"DefaultImpact":2,
"Image":null,
"DefaultUrgency":2,
"Name":"MDM Geräteanmeldung",
"DefaultDescription":null,
"ObjectID":"ACT00088",
"DefaultDescriptionHTML":null,
"DefaultPriority":2,
"DefaultSolutionHTML":null,
"Hidden":0,
"DefaultSolution":null
},
"SPSCommonClassBase":{
"ID":"5961e772-9c19-e111-4789-005056c00008",
"TimeStamp":"AAAAAAADUso=",
"TypeID":"3355f9ef-08c5-4ccf-a2ef-671ab73ff62d",
"CostCenter":"816361e3-13e6-4b44-96a9-fb44c63a8e36",
"Location":"cf060d4d-5c47-462f-b5d1-7df6c865fd91",
"OU":"4df735f2-b4bc-4ce8-92ee-60f40fcf5653",
"Responsible":null,
"Security-OU":"4df735f2-b4bc-4ce8-92ee-60f40fcf5653",
"Security-Location":"cf060d4d-5c47-462f-b5d1-7df6c865fd91",
"Security-CostCenter":"816361e3-13e6-4b44-96a9-fb44c63a8e36",
"Category":3,
"SourceProcess":null,
"State":0,
"ValidFrom":null,
"Reason":null,
"ValidUntil":null,
"Validity":null
}
}