Jump to

• Request
• Response

Updates Service configuration

put

/gsadmin/v1/{appName}/configuration/services/{serviceName}

Updates the service configuration. While any service can be defined, aiaOffers is an expected service configuration.

Request

Supported Media Types

• application/json
• application/zip

Path Parameters

• appName(required): string
  Specifies the name of your application. For example, "cloud".
• serviceName(required): string
  Specifies the name of your the service to define. For example aiaOffers.

Body ()

The configurtion for a service.

Root Schema : ServiceConfig

Contains configuration for services.

Match All

Contains configuration for services.

Contains configuration for services.

Show Source

• object BaseECR
• object ServiceConfig-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/BaseECR"
        },
        {
            "properties":{
                "ecr:type":{
                    "type":"string",
                    "default":"configuration-service"
                },
                "serviceUrl":{
                    "type":"string"
                },
                "enabled":{
                    "type":"boolean"
                },
                "noOfRecommendations":{
                    "type":"integer"
                }
            }
        }
    ],
    "description":"Contains configuration for services."
}

Nested Schema : BaseECR

Type: object

Show Source

• ecr:createDate: string
  Date this object was first created. Found in responses. Ignored in POST/PUT payloads.

  Example: 2018-01-01T13:41:03.858-04:00
• ecr:lastModified: string
  Date this object was last modified. Found in responses. Ignored in POST/PUT payloads.

  Example: 2018-01-01T13:41:03.858-04:00
• ecr:lastModifiedBy: string
  User who last modified this object. Found in responses. Ignored in POST/PUT payloads.

  Example: admin

{
    "type":"object",
    "properties":{
        "ecr:createDate":{
            "type":"string",
            "example":"2018-01-01T13:41:03.858-04:00",
            "description":"Date this object was first created. Found in responses. Ignored in POST/PUT payloads."
        },
        "ecr:lastModified":{
            "type":"string",
            "example":"2018-01-01T13:41:03.858-04:00",
            "description":"Date this object was last modified. Found in responses. Ignored in POST/PUT payloads."
        },
        "ecr:lastModifiedBy":{
            "type":"string",
            "example":"admin",
            "description":"User who last modified this object. Found in responses. Ignored in POST/PUT payloads."
        }
    }
}

Nested Schema : ServiceConfig-allOf[1]

Type: object

Show Source

• ecr:type: string
  Default Value: configuration-service
• enabled: boolean
• noOfRecommendations: integer
• serviceUrl: string

{
    "properties":{
        "ecr:type":{
            "type":"string",
            "default":"configuration-service"
        },
        "serviceUrl":{
            "type":"string"
        },
        "enabled":{
            "type":"boolean"
        },
        "noOfRecommendations":{
            "type":"integer"
        }
    }
}

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json

202 Response

Services configuration successfully updated.

Body ()

Root Schema : Response

Type: object

Show Source

• message: string
• status: integer(int32)

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Back to Top