Oracle Cloud Infrastructure Documentation

Get Configuration Type Details

Use this API to get configuration type details.

API

/selfservice/v1/customers/services/{serviceType}/products/config/types/{type}

Scope and AuthZ

  • You must have mcs:oci:api:User scope to access this API.
  • You can access this information only for the service type that belongs to your customer.
  • You can use Configuration Metadata API only if your customer has opted-in for Configuration functionality.

Headers

  • Authorization: Bearer <Token>

    Where <Token> is the OAUTH token returned by the Authorization Server (JWT Token).

  • Identifier: <JWKS Identifier>

    Where <JWKS Identifier> is the GUID generated when JWKS URI is set by customer admin in self-service platform.

Dependency

Base Path

/selfservice/v1/

Functionality

This API exposes details as applicable to a configuration.

It includes list of allowed activities and its corresponding details like parameters.

{serviceType} and {type} can be retrieved from the dependency mentioned.

Verb

GET

Parameters

Name Type Description Mandatory
serviceType Path parameter Service type Yes
type Path parameter Configuration type (For example, Trace and Debug) Yes

Sample response

{
  "config": "Trace & Debug",
  "activities": [
    {
      "id": 1,
      "name": "FRD Enable/Disable",
      "uiType": "Toggle",
      "duration": {
        "unit": "hours",
        "value": 2
      },
      "serviceType": "Outage",
      "serviceMessage": "Any RFC Created for this Activity will perform a bounce.",
      "bounce": true,
      "active": true,
      "details": [
        {
          "type": "Enable",
          "scope": "Execution",
          "displayOnCreate": true,
          "parameters": [
            {
              "id": 1,
              "parameterId": 1,
              "parameterName": "UserName",
              "parameterType": "DETAIL",
              "uiDataType": "TEXT",
              "mandatory": true,
              "default": null,
              "active": true,
              "displayName": "UserName"
            },
            {
              "id": 21,
              "parameterId": 12,
              "parameterName": "Auto_Disable_Interval",
              "parameterType": "HEADER",
              "uiDataType": "LOV",
              "mandatory": true,
              "default": null,
              "active": true,
              "displayName": "Auto Disable Interval",
              "options": [
                {
                  "value": "3",
                  "label": "3 Hrs",
                  "active": true
                },
                {
                  "value": "4",
                  "label": "4 Hrs",
                  "active": true
                }
              ]
            }
          ]
        },
        {
          "type": "Disable",
          "scope": "Execution",
          "displayOnCreate": false,
          "parameters": [
            {
              "id": 5,
              "parameterId": 3,
              "parameterName": "OS_Process_Identifier",
              "parameterType": "DETAIL",
              "uiDataType": "TEXT",
              "mandatory": false,
              "default": null,
              "active": true,
              "displayName": "OS Process Identifier"
            },
            {
              "id": 21,
              "parameterId": 12,
              "parameterName": "Auto_Disable_Interval",
              "parameterType": "HEADER",
              "uiDataType": "LOV",
              "mandatory": true,
              "default": null,
              "active": true,
              "displayName": "Auto Disable Interval",
              "options": [
                {
                  "value": "3",
                  "label": "3 Hrs",
                  "active": true
                },
                {
                  "value": "4",
                  "label": "4 Hrs",
                  "active": true
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "id": 2,
      "name": "FND Enable/Disable",
      "uiType": "Toggle",
      "duration": {
        "unit": "hours",
        "value": 2
      },
      "serviceType": "Normal",
      "serviceMessage": null,
      "bounce": false,
      "active": true,
      "details": [
        {
          "type": "Enable",
          "scope": "Execution",
          "displayOnCreate": true,
          "parameters": [
            {
              "id": 1,
              "parameterId": 1,
              "parameterName": "Debug_log_Module",
              "parameterType": "DETAIL",
              "uiDataType": "TEXT",
              "mandatory": false,
              "default": "%",
              "active": true,
              "displayName": "Debug Log Module"
            }
          ]
        },
        {
          "type": "Update",
          "parentActivityType": "Enable"
          "scope": "PostExecution",
          "displayOnCreate": false,
          "parameters": [
            {
              "id": 29,
              "parameterId": 13,
              "parameterName": "Log_Transfer",
              "parameterType": "HEADER",
              "uiDataType": "CHECKBOX_COUNTER",
              "mandatory": true,
              "active": true,
              "displayName": "Log Transfer"
            },
            {
              "id": 16,
              "parameterId": 3,
              "parameterName": "OS_Process_Identifier",
              "parameterType": "DETAIL",
              "uiDataType": "TEXT",
              "mandatory": false,
              "default": false,
              "active": true,
              "displayName": "OS Process Identifier"
            }
          ]
        }
      ]
    }
  ]
}