REST Resources

/api/space/application-management/applications/{id}/settings-config

The following operations are supported on this resource:

  • GET - Get the configurable settings for this application
  • PUT - Update the configurable settings for this application
GET /applications/{id}/settings-config Version 2

This API retrieves the configurable settings for an application.

Note: This API does not support field selection.

See Info Service to retrieve schema corresponding to the configuration settings for an application.
.

Sample Usage

GET /applications/{id}/settings-config


  • Parameters:
    Name Type URI Type Description Required
    app-id int Path The application ID. Y
  • Sample Output XML:
    <HelloWorld-settings>
    <configuration>
        <Hello-World-Configuration>
           <Schedule-After>10</Schedule-After>
        </Hello-World-Configuration>
    </configuration>
    </HelloWorld-settings>

  • Sample Output JSON:
    {
      "HelloWorld-settings": {
        "configuration": {
           "Hello-World-Configuration":{
              "Schedule-After": "10"
           }
        }
      }
    }

    • Access Control

    The following capabilities are required to access this API: ModifyApplicationSetting

      For other non-deprecated versions of this API, refer to :
    • version 1


    PUT /applications/{id}/settings-config Version 2

    This API updates the configurable settings for an application.

    See Info Service to retrieve schema corresponding to the configuration settings for an application.
    .

    Sample Usage

    PUT /applications/{id}/settings-config


    • Parameters:
      Name Type URI Type Description Required
      app-id int Path The application ID. Y
  • Sample Input XML:
    <HelloWorld-settings>
    <configuration>
        <Hello-World-Configuration>
           <Schedule-After>10</Schedule-After>
        </Hello-World-Configuration>
    </configuration>
    </HelloWorld-settings>

  • Sample Output XML:
    <HelloWorld-settings>
    <configuration>
        <Hello-World-Configuration>
           <Schedule-After>10</Schedule-After>
        </Hello-World-Configuration>
    </configuration>
    </HelloWorld-settings>

  • Sample Input JSON:
    {
      "HelloWorld-settings": {
         "configuration": {
             "Hello-World-Configuration": {
                 "Schedule-After": "10"
             }
         }
      }
    }

  • Sample Output JSON:
    {
      "HelloWorld-settings": {
           "configuration": {
                "Hello-World-Configuration": {
                     "Schedule-After": "10"
               }
           }
      }
    }

    • Access Control

    The following capabilities are required to access this API: ModifyApplicationSetting

      For other non-deprecated versions of this API, refer to :
    • version 1