Sequence Type REST Endpoint

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

Description

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

Endpoint
sequences/

Operations And Examples

The Sequence 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 Sequence type Object

Get Sequence type Objects

Get operation for fetching a single specific object.

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

Delete Sequence type Objects

Generate and Validate Operations for Sequence Objects

Operations to generate or validate values.

JSON Example

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

Show JSON Example
{
  "sequence" : {
    "oid" : "",
    "version" : "",
    "name" : "Employee Numbers",
    "metadata" : {},
    "operationExecution" : {},
    "iteration" : 0,
    "iterationToken" : "",
    "counter" : 10000,
    "maxUnusedValues" : 10
  }
}
Was this page helpful?
YES NO
Thanks for your feedback