Obtenir les détails du type de configuration

Utilisez cette API pour obtenir les détails du type de configuration.

API

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

Portée et autorisation

  • Vous devez disposer de la portée mcs:oci:api:User pour accéder à cette API.
  • Vous ne pouvez accéder à ces informations que pour le type de service qui appartient à un client.
  • Vous ne pouvez utiliser l'API de gestion des métadonnées de configuration que si le client a accepté la fonctionnalité de configuration.

En-têtes

  • Autorisation : <Jeton> du porteur

    Où <Jeton> est le jeton OAUTH retourné par le serveur d'autorisation (jeton JWT).

  • Identificateur : <Identificateur JWKS>

    Où <Identificateur JWKS> est le GUID généré lorsque l'URI JWKS est défini par l'administrateur du client dans la plate-forme en libre-service.

Dépendance

Chemin de base

/selfservice/v1/

Fonctionnalité

Cette API présente les détails applicables à une configuration.

Elle comprend la liste des activités autorisées et les détails correspondants, tels que les paramètres.

{serviceType} et {type} peuvent être extraits de la dépendance mentionnée.

Verbe

GET

Paramètres

Nom Type Description Obligatoire
serviceType Paramètre de chemin Type de service Oui
type Paramètre de chemin Type de configuration (par exemple Trace et Débogage) Oui

Exemple de réponse

{
  "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"
            }
          ]
        }
      ]
    }
  ]
}