System Configuration Type REST Endpoint

Last modified 13 Mar 2024 13:32 +01:00
Table of Contents

Description

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

Endpoint
systemConfigurations/

Operations And Examples

The System Configuration 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:

How to use MidPoint REST examples

Create System Configuration type Object

Get System Configuration type Objects

Get operation for fetching a single specific object.

Search for System Configuration 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 System Configuration type Objects

Delete System Configuration type Objects

Generate and Validate Operations for System Configuration Objects

Operations to generate or validate values.

JSON Example

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

Show JSON Example

See Also

Was this page helpful?
YES NO
Thanks for your feedback