Jump to

• Request
• Response
• Examples

Get Pending Configurations

get

/rest/v19/pendingConfigurations

Use this endpoint to retrieve all pending configurations for the current user.

Request

Supported Media Types

• application/json

Query Parameters

• fields: string
  Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
• limit: integer
  The requested page size, which limits the number of elements the collection should max return.
• offset: integer
  The offset of the page. By default, offset is 0, which means first page will be returned.
• orderby: string
  Specifies a comma-separated list of pairs to order the response by.
• q: string
  Allows to specify one or more filtering criteria. By default, no filtering is applied.
• totalResults: boolean
  Specifies that the total count of records should be included in the response when doing pagination.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Pending Configuration Collection Definitions

Type: object

Title: Pending Configuration Collection Definitions

Show Source

• count: integer
  The number of resource instances returned in the current range.
• hasMore: boolean
  Returns true if more resources are available on the server than the subset returned in current page.
• items: array items
• limit: integer
  The actual paging size used by the server.
• offset: integer
  The offset used in the current page.
• totalResults: integer
  Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "totalResults":{
            "type":"integer",
            "description":"Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/pendingConfigurations"
            }
        }
    },
    "title":"Pending Configuration Collection Definitions"
}

Nested Schema : items

Type: array

Show Source

• Array of: object Pending Configuration Instance Definitions
  Title: Pending Configuration Instance Definitions

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/pendingConfigurations"
    }
}

Nested Schema : Pending Configuration Instance Definitions

Type: object

Title: Pending Configuration Instance Definitions

Show Source

• id: integer
  Title: Id

  Primary Key of the Pending Configuration resource
• modelHierarchy: string
  Title: Model Hierarchy

  Hierarchy path of the configured model
• modelLabel: string
  Title: Model Label

  Label of the configured model
• savedDate: string
  Title: Saved Date

  Date of configuration

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Primary Key of the Pending Configuration resource",
            "title":"Id"
        },
        "modelHierarchy":{
            "type":"string",
            "description":"Hierarchy path of the configured model",
            "title":"Model Hierarchy"
        },
        "modelLabel":{
            "type":"string",
            "description":"Label of the configured model",
            "title":"Model Label"
        },
        "savedDate":{
            "type":"string",
            "description":"Date of configuration",
            "title":"Saved Date"
        }
    },
    "title":"Pending Configuration Instance Definitions"
}

Back to Top

Examples

The following example shows how to retrieve all pending configurations for the current user by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET -H "Authorization: Bearer <token>" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/pendingConfigurations

Response Body Sample

{
  "hasMore": false,
  "links": [{
      "rel": "self",
      "href": "http://sitename.oracle.com/rest/v19/pendingConfigurations"
    }
  ],
  "items": [{
      "modelHierarchy": "Testbed > Recommended Items > Quick Items (Performance)",
      "id": 3023277453,
      "modelLabel": "Quick Items (Performance)",
      "savedDate": "2024-08-16 08:25:07",
      "links": [{
          "rel": "self",
          "href": "http://sitename.oracle.com/rest/v19/pendingConfigurations/3023277453"
        }
      ]
    }, {
      "modelHierarchy": "Testbed > ABO (Asset Based Ordering) > Basic Asset",
      "id": 3023276599,
      "modelLabel": "Basic Asset",
      "savedDate": "2024-08-15 12:07:19",
      "links": [{
          "rel": "self",
          "href": "http://sitename.oracle.com/rest/v19/pendingConfigurations/3023276599"
        }
      ]
    }, {
      "modelHierarchy": "Testbed > Recommended Items > Standard",
      "id": 3023277456,
      "modelLabel": "Standard",
      "savedDate": "2024-08-16 08:28:18",
      "links": [{
          "rel": "self",
          "href": "http://sitename.oracle.com/rest/v19/pendingConfigurations/3023277456"
        }
      ]
    }
  ]
}

Back to Top