Self Service Configuration

Overview

The Engagement Center Self Service UI Configuration service handles the required configuration for Self Service in the Engagement Center UI.

Please see the more details for settings at Engagement Center UI Configuration documentation.

Use the service to load default settings for:

UI layout of the Engagement Context in Engagement Center
- Action area views
- Business document types
- Work area views
Module configuration for the CECenter Agent Home
Interaction Log reasons for CECenter Self Service
Default Email Template for Product Registration
Add the required scopes for the CECenter Agent Home

Scopes prevent unauthorized access to the CECenter SelfService configuration service. The accepted scopes for the service are:

Scope	Description
hybris.ssrvc-configuration_view	Use this scope to see the default configurations status needed for CECenter Self Service.
hybris.ssrvc-configuration_manage	Use this scope to load default configurations needed for CECenter Self Service.

API Reference

/{tenant}/selfserviceconfigs

Self Service configurations

/{tenant}/selfserviceconfigs

get

Check the default settings for Self Service.This service call returns the settings with their statuses.

View the configured default settings in the Builder UI > Self Service Settings

View the settings table and statuses in the Builder UI. Select your project and click Client Project > Self Service > Self Service Settings.

The Load Default Configuration button loads the default settings. Required scope: hybris.ssrvc-configuration_view

Name	Status	Message
Email	true	This message shows whether this setting exists or does not exist.

Scope	Description
hybris.ssrvc-configuration_view	Use this scope to see the default configurations status needed for CECENTER SELF SERVICE.
hybris.ssrvc-configuration_manage	Use this scope to load default configurations needed for CECENTER SELF SERVICE.

post

Load the default settings for CECenter SelfService. Call the default settings on the configuration screen in the Builder UI > Client Project> Self Service> Self Service Settings. Click Load Default Configuration to load the default settings. Required scope: hybris.ssrvc-configuration_manage | Scope | Description | |---|---| |hybris.ssrvc-configuration_manage | Use this scope to load the default configurations for CECenter SelfService. |

Check the default settings for Self Service.This service call returns the settings with their statuses.

View the configured default settings in the Builder UI > Self Service Settings

View the settings table and statuses in the Builder UI. Select your project and click Client Project > Self Service > Self Service Settings.

The Load Default Configuration button loads the default settings. Required scope: hybris.ssrvc-configuration_view

Name	Status	Message
Email	true	This message shows whether this setting exists or does not exist.

Scope	Description
hybris.ssrvc-configuration_view	Use this scope to see the default configurations status needed for CECENTER SELF SERVICE.
hybris.ssrvc-configuration_manage	Use this scope to load default configurations needed for CECENTER SELF SERVICE.

Request
Response

URI Parameters

tenant: required (string)

Headers

Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```

HTTP status code 200

Get self service configuration successfully.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "Array of configuration status",
    "type": "array",
    "items": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Configuration Status",
        "type": "object",
        "properties": {
            "name": {
                "type": "string",
                "pattern": "^.+"
            },
            "serviceName": {
                "type": "string"
            },
            "status": {
                "type": "integer"
            },
            "message": {
                "type": "string"
            },
            "isExist": {
                "type": "boolean"
            },
            "dependentSettingsExist": {
                "type": "boolean"
            },
            "error": {
                "$ref": "https://api.yaas.io/patterns/v1/schema-error-message.json"
            }
        }
    }
}

Example:

[
    {
        "name": "ZSettingExample1",
        "serviceName": "ServiceName1",
        "status": 200,
        "message": "Message from end service",
        "isExist": true,
        "error": ""
    },
    {
        "name": "ZSettingExample2",
        "serviceName": "ServiceName2",
        "status": 500,
        "message": "Message from end Service",
        "isExist": false,
        "error": "Internal Server Error or some thing bad"
    }
]

HTTP status code 401

Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 401,
    "message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
    "type": "insufficient_credentials",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}

HTTP status code 403

Evaluated request scopes in access token are not sufficient and do not match required scopes.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 403,
    "message": "Given request does not have required scopes in access token. It is not authorized to perform this operation.",
    "type": "insufficient_permissions"
}

Request
Response

URI Parameters

tenant: required (string)

Headers

Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```

HTTP status code 201

Self service configuration created successfully.

Body

Type: application/json

Example:

{
    "status": "OK",
    "message": "Status of Settings"
}

HTTP status code 401

Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 401,
    "message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
    "type": "insufficient_credentials",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}

HTTP status code 403

Evaluated request scopes in access token are not sufficient and do not match required scopes.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 403,
    "message": "Given request does not have required scopes in access token. It is not authorized to perform this operation.",
    "type": "insufficient_permissions"
}

/{tenant}/selfserviceconfigs

Send feedback
If you find any information that is unclear or incorrect, please let us know so that we can improve the Dev Portal content.
Get Help
Use our private help channel. Receive updates over email and contact our specialists directly.
hybris Experts
If you need more information about this topic, visit hybris Experts to post your own question and interact with our community and experts.

Overview

API Reference

/{tenant}/selfserviceconfigs

/{tenant}/selfserviceconfigs

get /{tenant}/selfserviceconfigs

URI Parameters

Headers

HTTP status code 200

Body

HTTP status code 401

Body

HTTP status code 403

Body

post /{tenant}/selfserviceconfigs

URI Parameters

Headers

HTTP status code 201

Body

HTTP status code 401

Body

HTTP status code 403

Body