objectCollections/
Object Collection Type REST Endpoint
Description
Here we are describing the Object Collection object type in relation to midPoints REST API. The Object Collection objects are a part of the REST API web resources.
Operations And Examples
The Object Collection type endpoint operations and examples.
In our examples we are authenticating with the credentials, name "administrator" and password "y0uR_P455woR*d" on a localhost instance running on port 8080. |
For some help regarding the REST examples please see this link:
Create Object Collection type Object
Get Object Collection type Objects
Get operation for fetching a single specific object.
Search for Object Collection type Objects
Search operation usable for fetching the full list of objects or a list based on filter.
Show data source example for "Search for all" | GitHub
{
"query" : ""
}
The response is an HTTP 200 code in case of success with a response body containing the queried items.
Example Output is a list of objects.
{
"@ns" : "http://prism.evolveum.com/xml/ns/public/types-3",
"object" : {
"@type" : "http://midpoint.evolveum.com/xml/ns/public/common/api-types-3#ObjectListType",
"object" : [ {
"@type" : "",
"oid" : "",
"version" : "",
"name" : "",
"metadata" : {},
"operationExecution": {},
"indestructible": ,
"iteration" : ,
"iterationToken" : "",
"archetypeRef": {},
"roleMembershipRef": {},
"activation": {}
}, {
"@type" : "",
"oid" : "",
"version" : "",
"name" : "",
"metadata" : {},
"operationExecution": {},
"indestructible": ,
"iteration" : ,
"iterationToken" : "",
"archetypeRef": {},
"roleMembershipRef": {},
"activation": {}
} ]
}
}
Modify Object Collection type Objects
Delete Object Collection type Objects
Generate and Validate Operations for Object Collection Objects
Operations to generate or validate values.
JSON Example
Example output of information regarding a specific Object Collection object. Metadata is usually a part of the output, yet it was removed for the purpose of the example.
Show JSON Example
{
"objectCollection" : {
"oid" : "00000000-0000-0000-0001-000000000005",
"version" : "",
"name" : "Active tasks",
"metadata" : {},
"operationExecution" : {
"@id" : 4,
"recordType" : "simple",
"timestamp" : "",
"operation" : {},
"status" : "success",
"channel" : "http://midpoint.evolveum.com/xml/ns/public/common/channels-3#init"
},
"assignment" : {},
"iteration" : 0,
"iterationToken" : "",
"type" : "#TaskType",
"filter" : {
"text" : "executionState = \"runnable\" and parent not exists"
},
"domain" : {
"collectionRef" : {
"oid" : "00000000-0000-0000-0001-000000000007",
"relation" : "org:default",
"type" : "c:ObjectCollectionType"
}
}
}
}