Generic Object Type REST Endpoint

Last modified 13 Mar 2024 13:32 +01:00

Description

Here we are describing the Generic Object type in relation to midPoints REST API. The Generic objects are a part of the REST API web resources.

Endpoint
genericObjects/

Operations And Examples

The Generic Object 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 Generic Object Type Object

Get Generic Object Type Objects

Get operation for fetching a single specific object.

Search for Generic Object 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 Generic Object Type Objects

Delete Generic Object Type Objects

Generate and Validate Operations for Generic Object Type Objects

Operations to generate or validate values.

JSON Example

Example output of information regarding a specific Generic object. Metadata is usually a part of the output, yet it was removed for the purpose of the example.

Show JSON Example
Was this page helpful?
YES NO
Thanks for your feedback