Jump to

• Request
• Response

Get Service Configuration

get

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

Returns the configuration block for the specified service. Returns metadata about the configurations (e.g. who created it and when) along with a list of owner attributes. If zip extension is specified (add ".zip" at the end of the path), the attributes are exported as a zip file. NOTE: aiaOffers is a conventionally named endpoint that is expected by cc-admin as well as assembler.

Request

Supported Media Types

• application/json

Path Parameters

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

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json
• application/zip

200 Response

The service configuration.

Body ()

Root Schema : ServiceConfig

Contains configuration for services.

Match All

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(optional): 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(optional): 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(optional): 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(optional): string
  Default Value: configuration-service
• enabled(optional): boolean
• noOfRecommendations(optional): integer
• serviceUrl(optional): string

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

Back to Top