Search

Overview

The Search service is deprecated. New subscriptions are unavailable. The service is available for existing subscribers only until July 1st, 2017.

This service provides Elasticsearch functionality, including:

Advanced search functionality (full text search, search ahead, filtering by terms and ranges)
Data analytics
Data separation
CRUD operation on documents, including versioning

For more information about Search service best practices, see Best Practices. For more information about Search service limitations, see Limitations.

API Reference

/{tenant}/{client}

post

The index operation automatically creates an index if it has not been created already (see the create index API for manually creating an index), and also automatically creates a dynamic type mapping for the specific type if one has not yet been created (see the put mapping API for manually creating a type mapping).

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

put

The create index API enables you to instantiate an index. Elasticsearch provides support for multiple indices, including executing operations across several indices.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

delete

The delete index API enables you to delete an existing index.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

get

Used to retrieve the index (or indices) definition.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

head

Used to check whether or not the index (or indices) exists. For example: curl -XHEAD 'http://localhost:9200/twitter'

The HTTP status code indicates whether or not the index exists. A status code of 404 means it does not exist, and 200 means it does.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "settings": {
            "type": "object",
            "required": false,
            "properties": {
                "index": {
                    "type": "object",
                    "required": false,
                    "properties": {
                        "mapping.allow_type_wrapper": {
                            "type": "boolean",
                            "required": false
                        }
                    }
                }
            }
        }
    }
}

Example:

{
    "settings": {
        "index": {
            "mapping.allow_type_wrapper": true
        }
    }
}

HTTP status code 200

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "acknowledged": {
            "type": "boolean",
            "required": false
        }
    }
}

Example:

{
    "acknowledged": true
}

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)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "settings": {
            "type": "object",
            "required": false,
            "properties": {
                "index": {
                    "type": "object",
                    "required": false,
                    "properties": {
                        "mapping.allow_type_wrapper": {
                            "type": "boolean",
                            "required": false
                        }
                    }
                }
            }
        }
    }
}

Example:

{
    "settings": {
        "index": {
            "mapping.allow_type_wrapper": true
        }
    }
}

HTTP status code 200

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "acknowledged": {
            "type": "boolean",
            "required": false
        }
    }
}

Example:

{
    "acknowledged": true
}

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)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

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)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

HTTP status code 200

Body

Type: application/json

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

HTTP status code 404

Used to check whether or not the index (or indices) exists. For example: curl -XHEAD 'http://localhost:9200/twitter'

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

HTTP status code 200

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

HTTP status code 404

/{tenant}/{client}/{type}

post

The index operation can be executed without specifying the ID. In such a case, an ID will be generated automatically. In addition, the op_type will automatically be set to create. Following is an example (note the POST used instead of PUT).

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

head

Used to check if a type (or types) exists in an index (or indices). The HTTP status code indicates whether or not the type exists. A status code of 404 means it does not exist, and 200 means it does.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

delete

Enables you to delete a mapping (type) along with its data.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.

Headers

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

Query Parameters

version: (string)
Each indexed document is given a version number. The associated version number is returned as part of the response to the index API request. The index API optionally allows for optimistic concurrency control when the version parameter is specified. This will control the version of the document the operation is intended to be executed against. A good example of a use case for versioning is performing a transactional read-then-update. Specifying a version from the document initially read ensures no changes have happened in the meantime (when reading in order to update, it is recommended to set preference to _primary).
Example:
```
version=2
```
version_type: (one of external_gt, external, force, internal, external_gte, external_gt, external, force, internal, external_gte)
Next to the internal & external version types explained above, Elasticsearch also supports other types for specific use cases. This is an overview of the different version types and their semantics.
routing: (string)
By default, the shard placement's id value. For more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the routing parameter.
Example:
```
kimchy
```
parent: (string)
A child document can be indexed by specifying its parent when indexing.
Example:
```
1111
```
timestamp: (string)
A document can be indexed with a timestamp associated with it. The timestamp value of a document can be set using the timestamp parameter.
Example:
```
2009-11-15T14%3A12%3A12
```
ttl: (string)
A document can be indexed with a ttl (time to live) associated with it. Expired documents will be expunged automatically. The expiration date that will be set for a document with a provided ttl is relative to the timestamp of the document, meaning it can be based on the time of indexing or on any time provided. The provided ttl must be strictly positive and can be a number (in milliseconds) or any valid time value
Example:
```
86400000
```
consistency: (one of quorum, one, all, quorum, one, all)
To prevent writes from taking place on the "wrong" side of a network partition, by default, index operations only succeed if a quorum (>replicas/2+1) of active shards are available. This default can be overridden on a node-by-node basis using the action.write_consistency setting. To alter this behavior per-operation, the consistency request parameter can be used.
replication: (one of async, async)
By default, the index operation only returns after all shards within the replication group have indexed the document (sync replication). To enable asynchronous replication, causing the replication process to take place in the background, set the replication parameter to async. When asynchronous replication is used, the index operation will return as soon as the operation succeeds on the primary shard.
refresh: (boolean)
To refresh the index immediately after the operation occurs so that the document appears in search results immediately, the refresh parameter can be set to true. Setting this option to true should ONLY be done after careful thought and verification that it does not lead to poor performance, both from an indexing and a search standpoint. Note, getting a document using the get API is completely real-time.
timeout: (string)
The primary shard assigned to perform the index operation might not be available when the index operation is executed. Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation. By default, the index operation will wait on the primary shard to become available for up to one minute before failing and responding with an error. The timeout parameter can be used to explicitly specify how long it waits.
Example:
```
5m
```
pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (such as "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "user": {
            "type": "string",
            "required": false
        },
        "post_date": {
            "type": "string",
            "required": false
        },
        "message": {
            "type": "string",
            "required": false
        }
    }
}

Example:

{
    "user": "kimchy",
    "post_date": "2009-11-15T14:12:12",
    "message": "trying out Elasticsearch"
}

HTTP status code 200

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "_index": {
            "type": "string",
            "required": false
        },
        "_type": {
            "type": "string",
            "required": false
        },
        "_id": {
            "type": "string",
            "required": false
        },
        "_version": {
            "type": "number",
            "required": false
        },
        "created": {
            "type": "boolean",
            "required": false
        }
    }
}

Example:

{
    "_index": "twitter",
    "_type": "tweet",
    "_id": "1",
    "_version": 1,
    "created": true
}

HTTP status code 201

Body

Type: application/json

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)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.

Headers

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

HTTP status code 200

HTTP status code 400

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)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.

Headers

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

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}/{client}/{type}/{id}

get

The get API enables you to get a typed JSON document from the index based on its ID.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

put

The index API adds or updates a typed JSON document in a specific index, making it searchable.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

head

The API also enables you to check for the existence of a document using HEAD.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

delete

The delete API enables you to delete a typed JSON document from a specific index based on its ID.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.
id: required (string)

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```
realtime: (boolean)
In order to disable real-time GET, you can either set the real-time parameter to false or set it globally by setting the action.get.realtime to false in the node configuration.
fields: (string)
When getting a document, you can specify which fields to fetch from it. These fields will, when possible, be fetched as stored fields (fields mapped as stored in the mapping).
Example:
```
title,content
```
_source: (string)
By default, the GET operation returns the contents of the _source field unless you have used the fields parameter or if the _source field is disabled. You can turn off _source retrieval by using the _source parameter.
Example:
```
*.id,retweeted
```
_source_include: (string)
If you only need one or two fields from the complete _source, you can use the _source_include and _source_exclude parameters to include or filter out the parts that you need. This can be especially helpful with large documents where partial retrieval can save on network overhead. Both parameters take a comma-separated list of fields or wildcard expressions.
Example:
```
*.id&_source_exclude=entities
```
_source_exclude: (string)
If you only need one or two fields from the complete _source, you can use the _source_include and _source_exclude parameters to include or filter out the parts that you need. This can be especially helpful with large documents where partial retrieval can save on network overhead. Both parameters take a comma-separated list of fields or wildcard expressions.
Example:
```
*.id&_source_exclude=entities
```
routing: (string)
When indexing using the ability to control the routing, in order to get a document, the routing value should also be provided.
Example:
```
kimchy
```
preference: (one of _primary, _local)
This controls a preference of which shard replicas the get request should be executed upon. By default, the operation is randomized between the shard replicas. A custom value is used to guarantee that the same shards are used for the same custom value. This can help with "jumping values" when hitting different shards in different refresh states. A sample value can be something like the web session ID or the user name.
version: (string)
You can use the version parameter to retrieve the document only if its current version is equal to the specified one.
Example:
```
111
```
version_type: (one of FORCE)
This behavior is the same for all version types with the exception of version type FORCE, which always retrieves the document.

HTTP status code 200

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "_index": {
            "type": "string",
            "required": false
        },
        "_type": {
            "type": "string",
            "required": false
        },
        "_id": {
            "type": "string",
            "required": false
        },
        "_version": {
            "type": "number",
            "required": false
        },
        "found": {
            "type": "boolean",
            "required": false
        },
        "_source": {
            "type": "object",
            "required": false,
            "properties": {
                "user": {
                    "type": "string",
                    "required": false
                },
                "postDate": {
                    "type": "string",
                    "required": false
                },
                "message": {
                    "type": "string",
                    "required": false
                }
            }
        }
    }
}

Example:

{
    "_index": "twitter",
    "_type": "tweet",
    "_id": "1",
    "_version": 1,
    "found": true,
    "_source": {
        "user": "kimchy",
        "postDate": "2009-11-15T14:12:12",
        "message": "trying out Elasticsearch"
    }
}

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)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.
id: required (string)

Headers

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

Query Parameters

version: (string)
Each indexed document is given a version number. The associated version number is returned as part of the response to the index API request. The index API optionally allows for optimistic concurrency control when the version parameter is specified. This will control the version of the document the operation is intended to be executed against. A good example of a use case for versioning is performing a transactional read-then-update. Specifying a version from the document initially read ensures no changes have happened in the meantime (when reading in order to update, it is recommended to set preference to _primary).
Example:
```
version=2
```
version_type: (one of external_gt, external, force, internal, external_gte, external_gt, external, force, internal, external_gte)
Next to the internal & external version types explained above, Elasticsearch also supports other types for specific use cases. This is an overview of the different version types and their semantics.
routing: (string)
By default, the shard placement's id value. For more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the routing parameter.
Example:
```
kimchy
```
parent: (string)
A child document can be indexed by specifying its parent when indexing.
Example:
```
1111
```
timestamp: (string)
A document can be indexed with a timestamp associated with it. The timestamp value of a document can be set using the timestamp parameter.
Example:
```
2009-11-15T14%3A12%3A12
```
ttl: (string)
A document can be indexed with a ttl (time to live) associated with it. Expired documents will be expunged automatically. The expiration date that will be set for a document with a provided ttl is relative to the timestamp of the document, meaning it can be based on the time of indexing or on any time provided. The provided ttl must be strictly positive and can be a number (in milliseconds) or any valid time value
Example:
```
86400000
```
consistency: (one of quorum, one, all, quorum, one, all)
To prevent writes from taking place on the "wrong" side of a network partition, by default, index operations only succeed if a quorum (>replicas/2+1) of active shards are available. This default can be overridden on a node-by-node basis using the action.write_consistency setting. To alter this behavior per-operation, the consistency request parameter can be used.
replication: (one of async, async)
By default, the index operation only returns after all shards within the replication group have indexed the document (sync replication). To enable asynchronous replication, causing the replication process to take place in the background, set the replication parameter to async. When asynchronous replication is used, the index operation will return as soon as the operation succeeds on the primary shard.
refresh: (boolean)
To refresh the index immediately after the operation occurs so that the document appears in search results immediately, the refresh parameter can be set to true. Setting this option to true should ONLY be done after careful thought and verification that it does not lead to poor performance, both from an indexing and a search standpoint. Note, getting a document using the get API is completely real-time.
timeout: (string)
The primary shard assigned to perform the index operation might not be available when the index operation is executed. Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation. By default, the index operation will wait on the primary shard to become available for up to one minute before failing and responding with an error. The timeout parameter can be used to explicitly specify how long it waits.
Example:
```
5m
```
pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (such as "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When the flat_settings` flag is true, settings are returned in a flat format.
op_type: (string)
The index operation also accepts an op_type that can be used to force a create operation, allowing for "put-if-absent" behavior. When create is used, the index operation will fail if a document by that ID already exists in the index.
Example:
```
create
```

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "user": {
            "type": "string",
            "required": false
        },
        "post_date": {
            "type": "string",
            "required": false
        },
        "message": {
            "type": "string",
            "required": false
        }
    }
}

Example:

{
    "user": "kimchy",
    "post_date": "2009-11-15T14:12:12",
    "message": "trying out Elasticsearch"
}

HTTP status code 200

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "_index": {
            "type": "string",
            "required": false
        },
        "_type": {
            "type": "string",
            "required": false
        },
        "_id": {
            "type": "string",
            "required": false
        },
        "_version": {
            "type": "number",
            "required": false
        },
        "created": {
            "type": "boolean",
            "required": false
        }
    }
}

Example:

{
    "_index": "twitter",
    "_type": "tweet",
    "_id": "1",
    "_version": 1,
    "created": true
}

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)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.
id: required (string)

Headers

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

HTTP status code 200

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)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.
id: required (string)

Headers

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

Query Parameters

version: (string)
Each document indexed is versioned. When deleting a document, the version can be specified to make sure the relevant document that you are trying to delete is actually being deleted and has not changed in the meantime. Every write operation executed upon a document, including deletes, causes its version to be incremented.
parent: (string)
The parent parameter can be set, which will basically be the same as setting the routing parameter. Note that deleting a parent document does not automatically delete its children. One way of deleting all child documents with a parent ID is to perform a delete by query on the child index with the automatically generated (and indexed) field _parent, which is in the format parent_type#parent_id.
replication: (one of async)
The replication of the operation can be done in an asynchronous manner to the replicas (the operation will return once it has be executed on the primary shard). The replication parameter can be set to async (defaults to sync) in order to enable it.
consistency: (one of quorum, one, all)
Control if the operation will be allowed to execute based on the number of active shards within that partition (replication group). The values allowed are one, quorum, and all. The parameter to set it is consistency, and it defaults to the node level setting of action.write_consistency which in turn defaults to quorum.
refresh: (boolean)
The refresh parameter can be set to true in order to refresh the relevant shard after the delete operation is performed and make it searchable. Before setting this to true, you should verify that it will not cause a heavy load on the system. Setting this to true will slow down indexing.
timeout: (string)
The primary shard assigned to perform the delete operation might not be available when the delete operation is executed. Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation. By default, the delete operation waits for the primary shard to become available for up to one minute before failing and responding with an error. The timeout parameter can be used to explicitly specify how long it waits.
Example:
```
5m
```

HTTP status code 200

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "found": {
            "type": "boolean",
            "required": false
        },
        "_index": {
            "type": "string",
            "required": false
        },
        "_type": {
            "type": "string",
            "required": false
        },
        "_id": {
            "type": "string",
            "required": false
        },
        "_version": {
            "type": "number",
            "required": false
        }
    }
}

Example:

{
    "found": true,
    "_index": "twitter",
    "_type": "tweet",
    "_id": "1",
    "_version": 2
}

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}/{client}/{type}/{id}/_create

put

This is an example of using the option to specify create.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.
id: required (string)

Headers

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

Query Parameters

version: (string)
Each indexed document is given a version number. The associated version number is returned as part of the response to the index API request. The index API optionally allows for optimistic concurrency control when the version parameter is specified. This will control the version of the document the operation is intended to be executed against. A good example of a use case for versioning is performing a transactional read-then-update. Specifying a version from the document initially read ensures no changes have happened in the meantime (when reading in order to update, it is recommended to set preference to _primary).
Example:
```
version=2
```
version_type: (one of external_gt, external, force, internal, external_gte, external_gt, external, force, internal, external_gte)
Next to the internal & external version types explained above, Elasticsearch also supports other types for specific use cases. This is an overview of the different version types and their semantics.
routing: (string)
By default, the shard placement's id value. For more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the routing parameter.
Example:
```
kimchy
```
parent: (string)
A child document can be indexed by specifying its parent when indexing.
Example:
```
1111
```
timestamp: (string)
A document can be indexed with a timestamp associated with it. The timestamp value of a document can be set using the timestamp parameter.
Example:
```
2009-11-15T14%3A12%3A12
```
ttl: (string)
A document can be indexed with a ttl (time to live) associated with it. Expired documents will be expunged automatically. The expiration date that will be set for a document with a provided ttl is relative to the timestamp of the document, meaning it can be based on the time of indexing or on any time provided. The provided ttl must be strictly positive and can be a number (in milliseconds) or any valid time value
Example:
```
86400000
```
consistency: (one of quorum, one, all, quorum, one, all)
To prevent writes from taking place on the "wrong" side of a network partition, by default, index operations only succeed if a quorum (>replicas/2+1) of active shards are available. This default can be overridden on a node-by-node basis using the action.write_consistency setting. To alter this behavior per-operation, the consistency request parameter can be used.
replication: (one of async, async)
By default, the index operation only returns after all shards within the replication group have indexed the document (sync replication). To enable asynchronous replication, causing the replication process to take place in the background, set the replication parameter to async. When asynchronous replication is used, the index operation will return as soon as the operation succeeds on the primary shard.
refresh: (boolean)
To refresh the index immediately after the operation occurs so that the document appears in search results immediately, the refresh parameter can be set to true. Setting this option to true should ONLY be done after careful thought and verification that it does not lead to poor performance, both from an indexing and a search standpoint. Note, getting a document using the get API is completely real-time.
timeout: (string)
The primary shard assigned to perform the index operation might not be available when the index operation is executed. Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation. By default, the index operation will wait on the primary shard to become available for up to one minute before failing and responding with an error. The timeout parameter can be used to explicitly specify how long it waits.
Example:
```
5m
```
pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (such as "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When the flat_settings` flag is true, settings are returned in a flat format.

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "user": {
            "type": "string",
            "required": false
        },
        "post_date": {
            "type": "string",
            "required": false
        },
        "message": {
            "type": "string",
            "required": false
        }
    }
}

Example:

{
    "user": "kimchy",
    "post_date": "2009-11-15T14:12:12",
    "message": "trying out Elasticsearch"
}

HTTP status code 200

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "_index": {
            "type": "string",
            "required": false
        },
        "_type": {
            "type": "string",
            "required": false
        },
        "_id": {
            "type": "string",
            "required": false
        },
        "_version": {
            "type": "number",
            "required": false
        },
        "created": {
            "type": "boolean",
            "required": false
        }
    }
}

Example:

{
    "_index": "twitter",
    "_type": "tweet",
    "_id": "1",
    "_version": 1,
    "created": true
}

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}/{client}/{type}/{id}/_source

get

Use the endpoint to get just the _source field of the document, without any additional content around it.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

head

There is also a HEAD variant for the _source endpoint to efficiently test for document existence.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.
id: required (string)

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```

HTTP status code 200

Body

Type: application/json

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)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.
id: required (string)

Headers

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

HTTP status code 200

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}/{client}/{type}/{id}/_mlt

The API executes a search request with a More Like This Query (MLT Query) (http parameters match the parameters to the more_like_this query). This means that the body of the request can optionally include all of the request body options in the search API (aggs, from/to, and so on). Internally, the more like this API is equivalent to performing a Boolean query of more_like_this_field queries, with one query per specified mlt_fields.

Rest parameters relating to search are also allowed, including search_type, search_indices, search_types, search_scroll, search_size and search_from.

When no mlt_fields are specified, all of the fields of the document are used in the more_like_this query that is generated.

By default, the queried document is excluded from the response (include set to false).

Note: In order to use the MLT feature, an mlt_field needs to be either stored, store term_vector, or source needs to be enabled.

get

The more like this (mlt) API enables you to get documents that are "like" a specified document.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.
id: required (string)

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```
mlt_fields: (string)
Fields of the document that are used in the more_like_this query generated.
min_doc_freq: (number)
include: (boolean)

HTTP status code 200

Body

Type: application/json

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}/{client}/{type}/{id}/_termvector

get

Returns information and statistics on terms in the fields of a particular document as stored in the index.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.
id: required (string)

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```
fields: (string)
Optionally, you can specify the fields for which the information is retrieved with a parameter in the URL.

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "fields": {
            "type": "array",
            "required": false,
            "items": [
                {
                    "type": "string"
                }
            ]
        },
        "offsets": {
            "type": "boolean",
            "required": false
        },
        "payloads": {
            "type": "boolean",
            "required": false
        },
        "positions": {
            "type": "boolean",
            "required": false
        },
        "term_statistics": {
            "type": "boolean",
            "required": false
        },
        "field_statistics": {
            "type": "boolean",
            "required": false
        }
    }
}

Example:

{
    "fields": [
        "text"
    ],
    "offsets": true,
    "payloads": true,
    "positions": true,
    "term_statistics": true,
    "field_statistics": true
}

HTTP status code 200

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "_id": {
            "type": "string",
            "required": false
        },
        "_index": {
            "type": "string",
            "required": false
        },
        "_type": {
            "type": "string",
            "required": false
        },
        "_version": {
            "type": "number",
            "required": false
        },
        "found": {
            "type": "boolean",
            "required": false
        },
        "term_vectors": {
            "type": "object",
            "required": false,
            "properties": {
                "text": {
                    "type": "object",
                    "required": false,
                    "properties": {
                        "field_statistics": {
                            "type": "object",
                            "required": false,
                            "properties": {
                                "doc_count": {
                                    "type": "number",
                                    "required": false
                                },
                                "sum_doc_freq": {
                                    "type": "number",
                                    "required": false
                                },
                                "sum_ttf": {
                                    "type": "number",
                                    "required": false
                                }
                            }
                        },
                        "terms": {
                            "type": "object",
                            "required": false,
                            "properties": {
                                "test": {
                                    "type": "object",
                                    "required": false,
                                    "properties": {
                                        "doc_freq": {
                                            "type": "number",
                                            "required": false
                                        },
                                        "term_freq": {
                                            "type": "number",
                                            "required": false
                                        },
                                        "tokens": {
                                            "type": "array",
                                            "required": false,
                                            "items": [
                                                {
                                                    "type": "object",
                                                    "properties": {
                                                        "end_offset": {
                                                            "type": "number",
                                                            "required": false
                                                        },
                                                        "payload": {
                                                            "type": "string",
                                                            "required": false
                                                        },
                                                        "position": {
                                                            "type": "number",
                                                            "required": false
                                                        },
                                                        "start_offset": {
                                                            "type": "number",
                                                            "required": false
                                                        }
                                                    }
                                                }
                                            ]
                                        },
                                        "ttf": {
                                            "type": "number",
                                            "required": false
                                        }
                                    }
                                },
                                "twitter": {
                                    "type": "object",
                                    "required": false,
                                    "properties": {
                                        "doc_freq": {
                                            "type": "number",
                                            "required": false
                                        },
                                        "term_freq": {
                                            "type": "number",
                                            "required": false
                                        },
                                        "tokens": {
                                            "type": "array",
                                            "required": false,
                                            "items": [
                                                {
                                                    "type": "object",
                                                    "properties": {
                                                        "end_offset": {
                                                            "type": "number",
                                                            "required": false
                                                        },
                                                        "payload": {
                                                            "type": "string",
                                                            "required": false
                                                        },
                                                        "position": {
                                                            "type": "number",
                                                            "required": false
                                                        },
                                                        "start_offset": {
                                                            "type": "number",
                                                            "required": false
                                                        }
                                                    }
                                                }
                                            ]
                                        },
                                        "ttf": {
                                            "type": "number",
                                            "required": false
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Example:

{
    "_id": "1",
    "_index": "twitter",
    "_type": "tweet",
    "_version": 1,
    "found": true,
    "term_vectors": {
        "text": {
            "field_statistics": {
                "doc_count": 2,
                "sum_doc_freq": 6,
                "sum_ttf": 8
            },
            "terms": {
                "test": {
                    "doc_freq": 2,
                    "term_freq": 3,
                    "tokens": [
                        {
                            "end_offset": 12,
                            "payload": "d29yZA==",
                            "position": 1,
                            "start_offset": 8
                        },
                        {
                            "end_offset": 17,
                            "payload": "d29yZA==",
                            "position": 2,
                            "start_offset": 13
                        },
                        {
                            "end_offset": 22,
                            "payload": "d29yZA==",
                            "position": 3,
                            "start_offset": 18
                        }
                    ],
                    "ttf": 4
                },
                "twitter": {
                    "doc_freq": 2,
                    "term_freq": 1,
                    "tokens": [
                        {
                            "end_offset": 7,
                            "payload": "d29yZA==",
                            "position": 0,
                            "start_offset": 0
                        }
                    ],
                    "ttf": 2
                }
            }
        }
    }
}

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}/{client}/{type}/_bulk

post

The bulk API makes it possible to perform many index/delete operations in a single API call. This can greatly increase the indexing speed.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (such as "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.

Body

Type: text/plain

Example:

{ "index" : { "_type" : "type1", "_id" : "1" } }
{ "field1" : "value1" }
{ "create" : { "_type" : "type1", "_id" : "3" } }
{ "field1" : "value3" }
{ "update" : { "_id" : "1", "_type" : "type1" } }
{ "doc" : { "field2" : "value2" } }

HTTP status code 200

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
        "took": {
            "type": "integer"
        },
        "errors": {
            "type": "boolean"
        },
        "items": {
            "type": "array",
            "items": [
                {
                    "type": "object",
                    "properties": {
                        "create": {
                            "type": "object",
                            "properties": {
                                "_index": {
                                    "type": "string"
                                },
                                "_type": {
                                    "type": "string"
                                },
                                "_id": {
                                    "type": "string"
                                },
                                "status": {
                                    "type": "integer"
                                },
                                "error": {
                                    "type": "string"
                                }
                            }
                        }
                    }
                },
                {
                    "type": "object",
                    "properties": {
                        "update": {
                            "type": "object",
                            "properties": {
                                "_index": {
                                    "type": "string"
                                },
                                "_type": {
                                    "type": "string"
                                },
                                "_id": {
                                    "type": "string"
                                },
                                "_version": {
                                    "type": "integer"
                                },
                                "status": {
                                    "type": "integer"
                                }
                            }
                        }
                    }
                },
                {
                    "type": "object",
                    "properties": {
                        "index": {
                            "type": "object",
                            "properties": {
                                "_index": {
                                    "type": "string"
                                },
                                "_type": {
                                    "type": "string"
                                },
                                "_id": {
                                    "type": "string"
                                },
                                "_version": {
                                    "type": "integer"
                                },
                                "status": {
                                    "type": "integer"
                                }
                            }
                        }
                    }
                },
                {
                    "type": "object",
                    "properties": {
                        "delete": {
                            "type": "object",
                            "properties": {
                                "_index": {
                                    "type": "string"
                                },
                                "_type": {
                                    "type": "string"
                                },
                                "_id": {
                                    "type": "string"
                                },
                                "_version": {
                                    "type": "integer"
                                },
                                "status": {
                                    "type": "integer"
                                },
                                "found": {
                                    "type": "boolean"
                                }
                            }
                        }
                    }
                }
            ]
        }
    },
    "required": [
        "took",
        "errors",
        "items"
    ]
}

Example:

{
    "took": 2,
    "errors": false,
    "items": [
        {
            "index": {
                "_type": "type1",
                "_id": "1",
                "_version": 2,
                "status": 200
            }
        }
    ]
}

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}/{client}/{type}/_query

delete

The delete by query API enables you to delete documents from one or more indices and one or more types based on a query. The query can either be provided using a simple query string as a parameter or using the Query DSL defined within the request body.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.

Headers

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

Query Parameters

q: required (string)
Example:
```
user:kimchy
```
df: (string)
The default field to use when no field prefix is defined within the query.
analyzer: (string)
The analyzer name to be used when analyzing the query string.
default_operator: (one of AND, OR, AND, OR)
The default operator to be used.
replication: (one of async, async)
The replication of the operation can be done in an asynchronous manner to the replicas (the operation will return once it has be executed on the primary shard).
consistency: (one of quorum, one, all, quorum, one, all)

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "query": {
            "type": "object",
            "required": false,
            "properties": {
                "term": {
                    "type": "object",
                    "required": false,
                    "properties": {
                        "user": {
                            "type": "string",
                            "required": false
                        }
                    }
                }
            }
        }
    }
}

Example:

{
    "query": {
        "term": {
            "user": "kimchy"
        }
    }
}

HTTP status code 200

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "_indices": {
            "type": "object",
            "required": false,
            "properties": {
                "twitter": {
                    "type": "object",
                    "required": false,
                    "properties": {
                        "_shards": {
                            "type": "object",
                            "required": false,
                            "properties": {
                                "total": {
                                    "type": "number",
                                    "required": false
                                },
                                "successful": {
                                    "type": "number",
                                    "required": false
                                },
                                "failed": {
                                    "type": "number",
                                    "required": false
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Example:

{
    "_indices": {
        "twitter": {
            "_shards": {
                "total": 5,
                "successful": 5,
                "failed": 0
            }
        }
    }
}

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}/{client}/{type}/_search

post

Supports OAuth 2.0 for authenticating all API requests.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (such as "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
q: (string)
The query string. Maps to the query_string query. See Query String Query for more details.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.
Example:
```
user:kimchy
```
df: (string)
The default field to use when no field prefix is defined within the query.
analyzer: (string)
The analyzer name to be used when analyzing the query string.
default_operator: (string)
The default operator to be used. Can be AND or OR. Defaults to OR.
explain: (string)
Contains an explanation of how the scoring of the hits was computed for each hit.
fields: (string)
The selective stored fields of the document to return for each hit in a comma-delimited format. If no values are specified, no fields are returned.
sort: (string)
Sorting to perform. Can either be in the form of fieldName or fieldName:asc/fieldName:desc. The fieldName can either be an actual field within the document or the special _score name to indicate sorting based on scores. There can be several sort parameters. The order of the sort parameters is important.
track_scores: (string)
When sorting, set this to true in order to track scores and return them as part of each hit.
timeout: (string)
A search timeout, bounding the search request to be executed within the specified time value and bail with the hits accumulated up to that point when expired. Defaults to no timeout.
from: (string)
The starting from index of the hits to return. Defaults to 0.
size: (string - default: 10)
The number of hits to return. Defaults to 10.
search_type: (string)
The type of search operation to perform. Can be dfs_query_then_fetch, dfs_query_and_fetch, query_then_fetch, query_and_fetch, count, or scan. Defaults to query_then_fetch. See Search Type for more details on the different types of searches that can be performed.
lowercase_expanded_terms: (boolean - default: true)
Specifies whether terms should be automatically lowercased or not. Defaults to true.
analyze_wildcard: (boolean)
Specifies whether wildcard and prefix queries should be analyzed or not. Defaults to false.

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "query": {
            "type": "object",
            "required": false,
            "properties": {
                "term": {
                    "type": "object",
                    "required": false,
                    "properties": {
                        "user": {
                            "type": "string",
                            "required": false
                        }
                    }
                }
            }
        }
    }
}

Example:

{
    "query": {
        "term": {
            "user": "kimchy"
        }
    }
}

HTTP status code 200

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "_shards": {
            "type": "object",
            "required": false,
            "properties": {
                "total": {
                    "type": "number",
                    "required": false
                },
                "successful": {
                    "type": "number",
                    "required": false
                },
                "failed": {
                    "type": "number",
                    "required": false
                }
            }
        },
        "hits": {
            "type": "object",
            "required": false,
            "properties": {
                "total": {
                    "type": "number",
                    "required": false
                },
                "hits": {
                    "type": "array",
                    "required": false,
                    "items": [
                        {
                            "type": "object",
                            "properties": {
                                "_index": {
                                    "type": "string",
                                    "required": false
                                },
                                "_type": {
                                    "type": "string",
                                    "required": false
                                },
                                "_id": {
                                    "type": "string",
                                    "required": false
                                },
                                "_source": {
                                    "type": "object",
                                    "required": false,
                                    "properties": {
                                        "user": {
                                            "type": "string",
                                            "required": false
                                        },
                                        "postDate": {
                                            "type": "string",
                                            "required": false
                                        },
                                        "message": {
                                            "type": "string",
                                            "required": false
                                        }
                                    }
                                }
                            }
                        }
                    ]
                }
            }
        }
    }
}

Example:

{
    "_shards": {
        "total": 5,
        "successful": 5,
        "failed": 0
    },
    "hits": {
        "total": 1,
        "hits": [
            {
                "_index": "twitter",
                "_type": "tweet",
                "_id": "1",
                "_source": {
                    "user": "kimchy",
                    "postDate": "2009-11-15T14:12:12",
                    "message": "trying out Elasticsearch"
                }
            }
        ]
    }
}

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}/{client}/{type}/_count

get

The count API enables you to easily execute a query and get the number of matches for that query.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```
df: (string)
The default field to use when no field prefix is defined within the query.
analyzer: (string)
The analyzer name to be used when analyzing the query string.
default_operator: (string - default: OR)
The default operator to be used. Can be AND or OR. Defaults to OR.

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "query": {
            "type": "object",
            "required": false,
            "properties": {
                "term": {
                    "type": "object",
                    "required": false,
                    "properties": {
                        "user": {
                            "type": "string",
                            "required": false
                        }
                    }
                }
            }
        }
    }
}

Example:

{
    "query": {
        "term": {
            "user": "kimchy"
        }
    }
}

HTTP status code 200

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "count": {
            "type": "number",
            "required": false
        },
        "_shards": {
            "type": "object",
            "required": false,
            "properties": {
                "total": {
                    "type": "number",
                    "required": false
                },
                "successful": {
                    "type": "number",
                    "required": false
                },
                "failed": {
                    "type": "number",
                    "required": false
                }
            }
        }
    }
}

Example:

{
    "count": 1,
    "_shards": {
        "total": 5,
        "successful": 5,
        "failed": 0
    }
}

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}/{client}/{type}/_mapping

put

The put mapping API enables you to register specific mapping definition for a specific type.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

delete

This enables you to delete a mapping (type) along with its data.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (such as "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When the flat_settings` flag is true, settings are returned in a flat format.
ignore_conflicts: (boolean)
When an existing mapping already exists under the given type, the two mapping definitions (the one already defined and the new one) are merged. The ignore_conflicts parameters can be used to control if conflicts should be ignored or not. By default, it is set to false, which means conflicts are not ignored.

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "tweet": {
            "type": "object",
            "required": false,
            "properties": {
                "properties": {
                    "type": "object",
                    "required": false,
                    "properties": {
                        "message": {
                            "type": "object",
                            "required": false,
                            "properties": {
                                "type": {
                                    "type": "string",
                                    "required": false
                                },
                                "store": {
                                    "type": "boolean",
                                    "required": false
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Example:

{
    "tweet": {
        "properties": {
            "message": {
                "type": "string",
                "store": true
            }
        }
    }
}

HTTP status code 200

Body

Type: application/json

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)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.

Headers

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

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}/{client}/{type}/_mapping/field/{fields}

get

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.
fields: required (string)

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```
include_defaults: (boolean)
Adding include_defaults=true to the query string causes the response to include default values, which are typically suppressed.
Example:
```
true
```

HTTP status code 200

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "twitter": {
            "type": "object",
            "required": false,
            "properties": {
                "tweet": {
                    "type": "object",
                    "required": false,
                    "properties": {
                        "text": {
                            "type": "object",
                            "required": false,
                            "properties": {
                                "full_name": {
                                    "type": "string",
                                    "required": false
                                },
                                "mapping": {
                                    "type": "object",
                                    "required": false,
                                    "properties": {
                                        "text": {
                                            "type": "object",
                                            "required": false,
                                            "properties": {
                                                "type": {
                                                    "type": "string",
                                                    "required": false
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Example:

{
    "twitter": {
        "tweet": {
            "text": {
                "full_name": "text",
                "mapping": {
                    "text": {
                        "type": "string"
                    }
                }
            }
        }
    }
}

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}/{client}/{type}/_warmer/{warmer}

get

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

put

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.
warmer: required (string)

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```

HTTP status code 200

Body

Type: application/json

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

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.
warmer: required (string)

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (such as "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When the flat_settings` flag is true, settings are returned in a flat format.

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "query": {
            "type": "object",
            "required": false,
            "properties": {
                "match_all": {
                    "type": "object",
                    "required": false
                }
            }
        },
        "aggs": {
            "type": "object",
            "required": false,
            "properties": {
                "aggs_1": {
                    "type": "object",
                    "required": false,
                    "properties": {
                        "terms": {
                            "type": "object",
                            "required": false,
                            "properties": {
                                "field": {
                                    "type": "string",
                                    "required": false
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Example:

{
    "query": {
        "match_all": {}
    },
    "aggs": {
        "aggs_1": {
            "terms": {
                "field": "field"
            }
        }
    }
}

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}/{client}/{type}/_mtermvectors

get

The multi termvectors API enables you to get multiple termvectors based on an index, type, and ID. The response includes a docs array with all the fetched termvectors, with each element having the structure provided by the termvectors API.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "docs": {
            "type": "array",
            "required": false,
            "items": [
                {
                    "type": "object",
                    "properties": {
                        "_index": {
                            "type": "string",
                            "required": false
                        },
                        "_type": {
                            "type": "string",
                            "required": false
                        },
                        "_id": {
                            "type": "string",
                            "required": false
                        },
                        "term_statistics": {
                            "type": "boolean",
                            "required": false
                        }
                    }
                },
                {
                    "type": "object",
                    "properties": {
                        "_index": {
                            "type": "string",
                            "required": false
                        },
                        "_type": {
                            "type": "string",
                            "required": false
                        },
                        "_id": {
                            "type": "string",
                            "required": false
                        },
                        "fields": {
                            "type": "array",
                            "required": false,
                            "items": [
                                {
                                    "type": "string"
                                }
                            ]
                        }
                    }
                }
            ]
        }
    }
}

Example:

{
    "docs": [
        {
            "_index": "testidx",
            "_type": "test",
            "_id": "2",
            "term_statistics": true
        },
        {
            "_index": "testidx",
            "_type": "test",
            "_id": "1",
            "fields": [
                "text"
            ]
        }
    ]
}

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}/{client}/{type}/_mget

get

The multi GET API enables you to get multiple documents based on an index, type (optional), and id (and possibly routing). The response includes a docs array with all the fetched documents, each element similar in structure to a document provided by the get API.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "docs": {
            "type": "array",
            "required": false,
            "items": [
                {
                    "type": "object",
                    "properties": {
                        "_index": {
                            "type": "string",
                            "required": false
                        },
                        "_type": {
                            "type": "string",
                            "required": false
                        },
                        "_id": {
                            "type": "string",
                            "required": false
                        }
                    }
                }
            ]
        }
    }
}

Example:

{
    "docs": [
        {
            "_index": "test",
            "_type": "type",
            "_id": "1"
        },
        {
            "_index": "test",
            "_type": "type",
            "_id": "2"
        }
    ]
}

HTTP status code 200

Body

Type: application/json

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}/{client}/{type}/_validate/query

get

The validate API enables you to validate a potentially expensive query without executing it.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```

HTTP status code 200

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "valid": {
            "type": "boolean",
            "required": false
        },
        "_shards": {
            "type": "object",
            "required": false,
            "properties": {
                "total": {
                    "type": "number",
                    "required": false
                },
                "successful": {
                    "type": "number",
                    "required": false
                },
                "failed": {
                    "type": "number",
                    "required": false
                }
            }
        }
    }
}

Example:

{
    "valid": true,
    "_shards": {
        "total": 1,
        "successful": 1,
        "failed": 0
    }
}

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}/{client}/{type}/_msearch

get

The multi search API enables you to execute several search requests within the same API.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

post

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.

Headers

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

Body

Type: text/plain

Example:

{\"index\" : \"test\"} \n
{\"query\" : {\"match_all\" : {}}, \"from\" : 0, \"size\" : 10} \n
{\"index\" : \"test\", \"search_type\" : \"count\"} \n
{\"query\" : {\"match_all\" : {}}} \n
{} \n
{\"query\" : {\"match_all\" : {}}} \n

HTTP status code 200

Body

Type: application/json

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)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
type: required (string)
All search APIs can be applied across multiple types within an index and across multiple indices with support for the multi-index syntax. You can also search within specific types: /http://localhost:9200/twitter/tweet,user/_search?q=user:kimchy' Set it to _all in order to fetch the first document matching the ID across all types.

Headers

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

Body

Type: text/plain

Example:

{\"index\" : \"test\"} \n
{\"query\" : {\"match_all\" : {}}, \"from\" : 0, \"size\" : 10} \n
{\"index\" : \"test\", \"search_type\" : \"count\"} \n
{\"query\" : {\"match_all\" : {}}} \n
{} \n
{\"query\" : {\"match_all\" : {}}} \n

HTTP status code 200

Body

Type: application/json

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}/{client}/_bulk

post

The bulk API enables you to perform many index/delete operations in a single API call. This can greatly increase the indexing speed.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (such as "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.

Body

Type: text/plain

Example:

{ "index" : { "_type" : "type1", "_id" : "1" } }
{ "field1" : "value1" }
{ "create" : { "_type" : "type1", "_id" : "3" } }
{ "field1" : "value3" }
{ "update" : { "_id" : "1", "_type" : "type1" } }
{ "doc" : { "field2" : "value2" } }

HTTP status code 200

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
        "took": {
            "type": "integer"
        },
        "errors": {
            "type": "boolean"
        },
        "items": {
            "type": "array",
            "items": [
                {
                    "type": "object",
                    "properties": {
                        "create": {
                            "type": "object",
                            "properties": {
                                "_index": {
                                    "type": "string"
                                },
                                "_type": {
                                    "type": "string"
                                },
                                "_id": {
                                    "type": "string"
                                },
                                "status": {
                                    "type": "integer"
                                },
                                "error": {
                                    "type": "string"
                                }
                            }
                        }
                    }
                },
                {
                    "type": "object",
                    "properties": {
                        "update": {
                            "type": "object",
                            "properties": {
                                "_index": {
                                    "type": "string"
                                },
                                "_type": {
                                    "type": "string"
                                },
                                "_id": {
                                    "type": "string"
                                },
                                "_version": {
                                    "type": "integer"
                                },
                                "status": {
                                    "type": "integer"
                                }
                            }
                        }
                    }
                },
                {
                    "type": "object",
                    "properties": {
                        "index": {
                            "type": "object",
                            "properties": {
                                "_index": {
                                    "type": "string"
                                },
                                "_type": {
                                    "type": "string"
                                },
                                "_id": {
                                    "type": "string"
                                },
                                "_version": {
                                    "type": "integer"
                                },
                                "status": {
                                    "type": "integer"
                                }
                            }
                        }
                    }
                },
                {
                    "type": "object",
                    "properties": {
                        "delete": {
                            "type": "object",
                            "properties": {
                                "_index": {
                                    "type": "string"
                                },
                                "_type": {
                                    "type": "string"
                                },
                                "_id": {
                                    "type": "string"
                                },
                                "_version": {
                                    "type": "integer"
                                },
                                "status": {
                                    "type": "integer"
                                },
                                "found": {
                                    "type": "boolean"
                                }
                            }
                        }
                    }
                }
            ]
        }
    },
    "required": [
        "took",
        "errors",
        "items"
    ]
}

Example:

{
    "took": 2,
    "errors": false,
    "items": [
        {
            "index": {
                "_type": "type1",
                "_id": "1",
                "_version": 2,
                "status": 200
            }
        }
    ]
}

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}/{client}/_query

delete

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Query Parameters

q: required (string)
Example:
```
user:kimchy
```
df: (string)
The default field to use when no field prefix is defined within the query.
analyzer: (string)
The analyzer name to be used when analyzing the query string.
default_operator: (one of AND, OR, AND, OR)
The default operator to be used.
replication: (one of async, async)
The replication of the operation can be done in an asynchronous manner to the replicas (the operation will return once it has be executed on the primary shard).
consistency: (one of quorum, one, all, quorum, one, all)

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "query": {
            "type": "object",
            "required": false,
            "properties": {
                "term": {
                    "type": "object",
                    "required": false,
                    "properties": {
                        "user": {
                            "type": "string",
                            "required": false
                        }
                    }
                }
            }
        }
    }
}

Example:

{
    "query": {
        "term": {
            "user": "kimchy"
        }
    }
}

HTTP status code 200

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "_indices": {
            "type": "object",
            "required": false,
            "properties": {
                "twitter": {
                    "type": "object",
                    "required": false,
                    "properties": {
                        "_shards": {
                            "type": "object",
                            "required": false,
                            "properties": {
                                "total": {
                                    "type": "number",
                                    "required": false
                                },
                                "successful": {
                                    "type": "number",
                                    "required": false
                                },
                                "failed": {
                                    "type": "number",
                                    "required": false
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Example:

{
    "_indices": {
        "twitter": {
            "_shards": {
                "total": 5,
                "successful": 5,
                "failed": 0
            }
        }
    }
}

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}/{client}/_search_shards

The search shards API returns the indices and shards that a search request would be executed against. This can give useful feedback for working out issues or planning optimizations with routing and shard preferences.

get

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```

HTTP status code 200

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "nodes": {
            "type": "object",
            "required": false,
            "properties": {
                "JklnKbD7Tyqi9TP3_Q_tBg": {
                    "type": "object",
                    "required": false,
                    "properties": {
                        "name": {
                            "type": "string",
                            "required": false
                        },
                        "transport_address": {
                            "type": "string",
                            "required": false
                        }
                    }
                }
            }
        },
        "shards": {
            "type": "array",
            "required": false,
            "items": [
                {
                    "type": "array"
                }
            ]
        }
    }
}

Example:

{
    "nodes": {
        "JklnKbD7Tyqi9TP3_Q_tBg": {
            "name": "Rl'nnd",
            "transport_address": "inet[/192.168.1.113:9300]"
        }
    },
    "shards": [
        [
            {
                "index": "twitter",
                "node": "JklnKbD7Tyqi9TP3_Q_tBg",
                "primary": true,
                "relocating_node": null,
                "shard": 3,
                "state": "STARTED"
            }
        ],
        [
            {
                "index": "twitter",
                "node": "JklnKbD7Tyqi9TP3_Q_tBg",
                "primary": true,
                "relocating_node": null,
                "shard": 4,
                "state": "STARTED"
            }
        ],
        [
            {
                "index": "twitter",
                "node": "JklnKbD7Tyqi9TP3_Q_tBg",
                "primary": true,
                "relocating_node": null,
                "shard": 0,
                "state": "STARTED"
            }
        ],
        [
            {
                "index": "twitter",
                "node": "JklnKbD7Tyqi9TP3_Q_tBg",
                "primary": true,
                "relocating_node": null,
                "shard": 2,
                "state": "STARTED"
            }
        ],
        [
            {
                "index": "twitter",
                "node": "JklnKbD7Tyqi9TP3_Q_tBg",
                "primary": true,
                "relocating_node": null,
                "shard": 1,
                "state": "STARTED"
            }
        ]
    ]
}

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}/{client}/_search

post

Supports OAuth 2.0 for authenticating all API requests.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (such as "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
q: (string)
The query string. Maps to the query_string query. See Query String Query for more details.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.
Example:
```
user:kimchy
```
df: (string)
The default field to use when no field prefix is defined within the query.
analyzer: (string)
The analyzer name to be used when analyzing the query string.
default_operator: (string)
The default operator to be used. Can be AND or OR. Defaults to OR.
explain: (string)
Contains an explanation of how the scoring of the hits was computed for each hit.
fields: (string)
The selective stored fields of the document to return for each hit in a comma-delimited format. If no values are specified, no fields are returned.
sort: (string)
Sorting to perform. Can either be in the form of fieldName or fieldName:asc/fieldName:desc. The fieldName can either be an actual field within the document or the special _score name to indicate sorting based on scores. There can be several sort parameters. The order of the sort parameters is important.
track_scores: (string)
When sorting, set this to true in order to track scores and return them as part of each hit.
timeout: (string)
A search timeout, bounding the search request to be executed within the specified time value and bail with the hits accumulated up to that point when expired. Defaults to no timeout.
from: (string)
The starting from index of the hits to return. Defaults to 0.
size: (string - default: 10)
The number of hits to return. Defaults to 10.
search_type: (string)
The type of search operation to perform. Can be dfs_query_then_fetch, dfs_query_and_fetch, query_then_fetch, query_and_fetch, count, or scan. Defaults to query_then_fetch. See Search Type for more details on the different types of searches that can be performed.
lowercase_expanded_terms: (boolean - default: true)
Specifies whether terms should be automatically lowercased or not. Defaults to true.
analyze_wildcard: (boolean)
Specifies whether wildcard and prefix queries should be analyzed or not. Defaults to false.

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "query": {
            "type": "object",
            "required": false,
            "properties": {
                "term": {
                    "type": "object",
                    "required": false,
                    "properties": {
                        "user": {
                            "type": "string",
                            "required": false
                        }
                    }
                }
            }
        }
    }
}

Example:

{
    "query": {
        "term": {
            "user": "kimchy"
        }
    }
}

HTTP status code 200

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "_shards": {
            "type": "object",
            "required": false,
            "properties": {
                "total": {
                    "type": "number",
                    "required": false
                },
                "successful": {
                    "type": "number",
                    "required": false
                },
                "failed": {
                    "type": "number",
                    "required": false
                }
            }
        },
        "hits": {
            "type": "object",
            "required": false,
            "properties": {
                "total": {
                    "type": "number",
                    "required": false
                },
                "hits": {
                    "type": "array",
                    "required": false,
                    "items": [
                        {
                            "type": "object",
                            "properties": {
                                "_index": {
                                    "type": "string",
                                    "required": false
                                },
                                "_type": {
                                    "type": "string",
                                    "required": false
                                },
                                "_id": {
                                    "type": "string",
                                    "required": false
                                },
                                "_source": {
                                    "type": "object",
                                    "required": false,
                                    "properties": {
                                        "user": {
                                            "type": "string",
                                            "required": false
                                        },
                                        "postDate": {
                                            "type": "string",
                                            "required": false
                                        },
                                        "message": {
                                            "type": "string",
                                            "required": false
                                        }
                                    }
                                }
                            }
                        }
                    ]
                }
            }
        }
    }
}

Example:

{
    "_shards": {
        "total": 5,
        "successful": 5,
        "failed": 0
    },
    "hits": {
        "total": 1,
        "hits": [
            {
                "_index": "twitter",
                "_type": "tweet",
                "_id": "1",
                "_source": {
                    "user": "kimchy",
                    "postDate": "2009-11-15T14:12:12",
                    "message": "trying out Elasticsearch"
                }
            }
        ]
    }
}

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}/{client}/_count

get

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```
df: (string)
The default field to use when no field prefix is defined within the query.
analyzer: (string)
The analyzer name to be used when analyzing the query string.
default_operator: (string - default: OR)
The default operator to be used. Can be AND or OR. Defaults to OR.

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "query": {
            "type": "object",
            "required": false,
            "properties": {
                "term": {
                    "type": "object",
                    "required": false,
                    "properties": {
                        "user": {
                            "type": "string",
                            "required": false
                        }
                    }
                }
            }
        }
    }
}

Example:

{
    "query": {
        "term": {
            "user": "kimchy"
        }
    }
}

HTTP status code 200

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "count": {
            "type": "number",
            "required": false
        },
        "_shards": {
            "type": "object",
            "required": false,
            "properties": {
                "total": {
                    "type": "number",
                    "required": false
                },
                "successful": {
                    "type": "number",
                    "required": false
                },
                "failed": {
                    "type": "number",
                    "required": false
                }
            }
        }
    }
}

Example:

{
    "count": 1,
    "_shards": {
        "total": 5,
        "successful": 5,
        "failed": 0
    }
}

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}/{client}/_open

The open and close index APIs enable you to close an index and then open it later. A closed index has almost no overhead on the cluster (except for maintaining its metadata) and is blocked for read/write operations. A closed index can be opened, which then goes through the normal recovery process.

post

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (such as "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.

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}/{client}/_close

post

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (such as "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.

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}/{client}/_mapping

get

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```
include_defaults: (boolean)
Adding include_defaults=true to the query string causes the response to include default values, which are typically suppressed.
Example:
```
true
```

HTTP status code 200

Body

Type: application/json

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}/{client}/_mapping/{types}

get

put

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

delete

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
types: required (string)

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```
include_defaults: (boolean)
Adding include_defaults=true to the query string causes the response to include default values, which are typically suppressed.
Example:
```
true
```

HTTP status code 200

Body

Type: application/json

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

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
types: required (string)

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (such as "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When the flat_settings` flag is true, settings are returned in a flat format.
ignore_conflicts: (boolean)
When an existing mapping already exists under the given type, the two mapping definitions (the one already defined and the new one) are merged. The ignore_conflicts parameters can be used to control if conflicts should be ignored or not. By default, it is set to false, which means conflicts are not ignored.

HTTP status code 200

Body

Type: application/json

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

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
types: required (string)

Headers

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

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}/{client}/_mapping/{types}/{fields}

get

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
types: required (string)
fields: required (string)

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```
include_defaults: (boolean)
Adding include_defaults=true to the query string causes the response to include default values, which are typically suppressed.
Example:
```
true
```

HTTP status code 200

Body

Type: application/json

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}/{client}/_settings

get

Retrieve settings of index or indices.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

put

Enables you to control the allocation of indices on nodes based on include/exclude filters. The filters can be set both on the index level and on the cluster level. This example is of setting it on the cluster level. You can create an index that only deploys on nodes that have tag set to value1 and value2 by setting index.routing.allocation.include.tag to value1,value2.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```

HTTP status code 200

Body

Type: application/json

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)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (such as "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When the flat_settings` flag is true, settings are returned in a flat format.

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "index.routing.allocation.include.tag": {
            "type": "string",
            "required": false
        }
    }
}

Example:

{
    "index.routing.allocation.include.tag": "value1,value2"
}

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}/{client}/_analyze

get

Performs the analysis process on a text and return the token's breakdown of the text.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```
analyzer: (string)
Can be used without specifying an index against one of the many built-in analyzers.
Example:
```
standard
```
tokenizer: (string)
Example:
```
keyword
```
filters: (string)
Example:
```
lowercase
```
text: (string)
Example:
```
this+is+a+test
```

HTTP status code 200

Body

Type: application/json

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}/{client}/_warmer/{warmerName}

get

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

put

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
warmerName: required (string)

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```

HTTP status code 200

Body

Type: application/json

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

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
warmerName: required (string)

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (such as "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When the flat_settings` flag is true, settings are returned in a flat format.

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "query": {
            "type": "object",
            "required": false,
            "properties": {
                "match_all": {
                    "type": "object",
                    "required": false
                }
            }
        },
        "aggs": {
            "type": "object",
            "required": false,
            "properties": {
                "aggs_1": {
                    "type": "object",
                    "required": false,
                    "properties": {
                        "terms": {
                            "type": "object",
                            "required": false,
                            "properties": {
                                "field": {
                                    "type": "string",
                                    "required": false
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Example:

{
    "query": {
        "match_all": {}
    },
    "aggs": {
        "aggs_1": {
            "terms": {
                "field": "field"
            }
        }
    }
}

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}/{client}/_warmers/{warmerName}

get

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

put

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
warmerName: required (string)

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```

HTTP status code 200

Body

Type: application/json

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

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
warmerName: required (string)

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (such as "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When the flat_settings` flag is true, settings are returned in a flat format.

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "query": {
            "type": "object",
            "required": false,
            "properties": {
                "match_all": {
                    "type": "object",
                    "required": false
                }
            }
        },
        "aggs": {
            "type": "object",
            "required": false,
            "properties": {
                "aggs_1": {
                    "type": "object",
                    "required": false,
                    "properties": {
                        "terms": {
                            "type": "object",
                            "required": false,
                            "properties": {
                                "field": {
                                    "type": "string",
                                    "required": false
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Example:

{
    "query": {
        "match_all": {}
    },
    "aggs": {
        "aggs_1": {
            "terms": {
                "field": "field"
            }
        }
    }
}

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}/{client}/_status

The indices status API enables you to get comprehensive status information of one or more indices.

get

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```

HTTP status code 200

Body

Type: application/json

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}/{client}/_stats

Indices level stats provide statistics on different operations happening on an index. The API provides statistics on the index level scope (although most stats can also be retrieved using node level scope).

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

get

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```

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}/{client}/_stats/{statSpec}

get

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.
statSpec: required (one of warmer, flush, get, store, search, docs, indexing, merge, fielddata, suggest, completion, refresh)

Headers

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

HTTP status code 200

Body

Type: application/json

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}/{client}/_segments

get

Provide low level segments information with which a Lucene index (shard level) is built. Can be used to provide more information on the state of a shard and an index, such as optimization information, data "wasted" on deletes, and so on.'

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```

HTTP status code 200

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "_3": {
            "type": "object",
            "required": false,
            "properties": {
                "generation": {
                    "type": "number",
                    "required": false
                },
                "num_docs": {
                    "type": "number",
                    "required": false
                },
                "deleted_docs": {
                    "type": "number",
                    "required": false
                },
                "size_in_bytes": {
                    "type": "number",
                    "required": false
                },
                "memory_in_bytes": {
                    "type": "number",
                    "required": false
                },
                "committed": {
                    "type": "boolean",
                    "required": false
                },
                "search": {
                    "type": "boolean",
                    "required": false
                },
                "version": {
                    "type": "string",
                    "required": false
                },
                "compound": {
                    "type": "boolean",
                    "required": false
                }
            }
        },
        "_4": {
            "type": "object",
            "required": false,
            "properties": {
                "generation": {
                    "type": "number",
                    "required": false
                },
                "num_docs": {
                    "type": "number",
                    "required": false
                },
                "deleted_docs": {
                    "type": "number",
                    "required": false
                },
                "size_in_bytes": {
                    "type": "number",
                    "required": false
                },
                "memory_in_bytes": {
                    "type": "number",
                    "required": false
                },
                "committed": {
                    "type": "boolean",
                    "required": false
                },
                "search": {
                    "type": "boolean",
                    "required": false
                },
                "version": {
                    "type": "string",
                    "required": false
                },
                "compound": {
                    "type": "boolean",
                    "required": false
                }
            }
        }
    }
}

Example:

{
    "_3": {
        "generation": 3,
        "num_docs": 1121,
        "deleted_docs": 53,
        "size_in_bytes": 228288,
        "memory_in_bytes": 3211,
        "committed": true,
        "search": true,
        "version": "4.6",
        "compound": true
    }
}

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}/{client}/_recovery

get

The indices recovery API provides insight into ongoing index shard recoveries. Recovery status may be reported for specific indices or cluster-wide.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_view scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```
detailed: (boolean)
Display a detailed view. This is primarily useful for viewing the recovery of physical index files.
active_only: (boolean)
Display only those recoveries that are currently ongoing.

HTTP status code 200

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "index1": {
            "type": "object",
            "required": false,
            "properties": {
                "shards": {
                    "type": "array",
                    "required": false,
                    "items": [
                        {
                            "type": "object",
                            "properties": {
                                "id": {
                                    "type": "number",
                                    "required": false
                                },
                                "type": {
                                    "type": "string",
                                    "required": false
                                },
                                "stage": {
                                    "type": "string",
                                    "required": false
                                },
                                "primary": {
                                    "type": "boolean",
                                    "required": false
                                },
                                "start_time": {
                                    "type": "string",
                                    "required": false
                                },
                                "stop_time": {
                                    "type": "number",
                                    "required": false
                                },
                                "total_time_in_millis": {
                                    "type": "number",
                                    "required": false
                                },
                                "source": {
                                    "type": "object",
                                    "required": false,
                                    "properties": {
                                        "repository": {
                                            "type": "string",
                                            "required": false
                                        },
                                        "snapshot": {
                                            "type": "string",
                                            "required": false
                                        },
                                        "index": {
                                            "type": "string",
                                            "required": false
                                        }
                                    }
                                },
                                "target": {
                                    "type": "object",
                                    "required": false,
                                    "properties": {
                                        "id": {
                                            "type": "string",
                                            "required": false
                                        },
                                        "hostname": {
                                            "type": "string",
                                            "required": false
                                        },
                                        "ip": {
                                            "type": "string",
                                            "required": false
                                        },
                                        "name": {
                                            "type": "string",
                                            "required": false
                                        }
                                    }
                                },
                                "index": {
                                    "type": "object",
                                    "required": false,
                                    "properties": {
                                        "files": {
                                            "type": "object",
                                            "required": false,
                                            "properties": {
                                                "total": {
                                                    "type": "number",
                                                    "required": false
                                                },
                                                "reused": {
                                                    "type": "number",
                                                    "required": false
                                                },
                                                "recovered": {
                                                    "type": "number",
                                                    "required": false
                                                },
                                                "percent": {
                                                    "type": "string",
                                                    "required": false
                                                }
                                            }
                                        },
                                        "bytes": {
                                            "type": "object",
                                            "required": false,
                                            "properties": {
                                                "total": {
                                                    "type": "number",
                                                    "required": false
                                                },
                                                "reused": {
                                                    "type": "number",
                                                    "required": false
                                                },
                                                "recovered": {
                                                    "type": "number",
                                                    "required": false
                                                },
                                                "percent": {
                                                    "type": "string",
                                                    "required": false
                                                }
                                            }
                                        },
                                        "total_time_in_millis": {
                                            "type": "number",
                                            "required": false
                                        }
                                    }
                                },
                                "translog": {
                                    "type": "object",
                                    "required": false,
                                    "properties": {
                                        "recovered": {
                                            "type": "number",
                                            "required": false
                                        },
                                        "total_time_in_millis": {
                                            "type": "number",
                                            "required": false
                                        }
                                    }
                                },
                                "start": {
                                    "type": "object",
                                    "required": false,
                                    "properties": {
                                        "check_index_time": {
                                            "type": "number",
                                            "required": false
                                        },
                                        "total_time_in_millis": {
                                            "type": "number",
                                            "required": false
                                        }
                                    }
                                }
                            }
                        }
                    ]
                }
            }
        }
    }
}

Example:

{
    "index1": {
        "shards": [
            {
                "id": 0,
                "type": "snapshot",
                "stage": "index",
                "primary": true,
                "start_time": "2014-02-24T12:15:59.716",
                "stop_time": 0,
                "total_time_in_millis": 175576,
                "source": {
                    "repository": "my_repository",
                    "snapshot": "my_snapshot",
                    "index": "index1"
                },
                "target": {
                    "id": "ryqJ5lO5S4-lSFbGntkEkg",
                    "hostname": "my.fqdn",
                    "ip": "10.0.1.7",
                    "name": "my_es_node"
                },
                "index": {
                    "files": {
                        "total": 73,
                        "reused": 0,
                        "recovered": 69,
                        "percent": "94.5%"
                    },
                    "bytes": {
                        "total": 79063092,
                        "reused": 0,
                        "recovered": 68891939,
                        "percent": "87.1%"
                    },
                    "total_time_in_millis": 0
                },
                "translog": {
                    "recovered": 0,
                    "total_time_in_millis": 0
                },
                "start": {
                    "check_index_time": 0,
                    "total_time_in_millis": 0
                }
            }
        ]
    }
}

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}/{client}/_cache/clear

post

The clear cache API enables you to clear either all caches or specific caches associated with one ore more indices.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (such as "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
filter: (boolean)
The API clears all caches by default. Specific caches can be cleaned explicitly by setting filter, field_data, or id_cache to true.
field_data: (boolean)
The API clears all caches by default. Specific caches can be cleaned explicitly by setting filter, field_data, or id_cache to true.
id_cache: (boolean)
The API clears all caches by default. Specific caches can be cleaned explicitly by setting filter, field_data, or id_cache to true.

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}/{client}/_flush

post

The flush API enables you to flush one or more indices through an API. The flush process of an index frees memory from the index by flushing data to the index storage and clearing the internal transaction log. By default, Elasticsearch uses memory heuristics to automatically trigger flush operations as required in order to clear memory.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (such as "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.

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}/{client}/_refresh

post

The refresh API enables you to explicitly refresh one or more index, making all operations performed since the last refresh available for search. The (near) real-time capabilities depend on the index engine used. For example, the internal one requires refresh to be called, but by default a refresh is scheduled periodically.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (such as "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.

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}/{client}/_optimize

post

The optimize API enables you to optimize one or more indices through an API. The optimize process optimizes the index for faster search operations and relates to the number of segments a Lucene index holds within each shard. The optimize operation enables you to reduce the number of segments by merging them.

Security / Access Control:
To access this method, access token must be issued for tenant and client and have hybris.search_manage scope to manage this resource.

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (such as "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
max_num_segments: (string)
The number of segments to optimize to. To fully optimize the index, set it to 1. Defaults to simply checking if a merge needs to execute, and if so, executes it.
only_expunge_deletes: (string)
Specifies whether the optimize process should only expunge segments with deletes in it. In Lucene, a document is not deleted from a segment, just marked as deleted. During a merge process of segments, a new segment is created that does not have those deletes. This flag enables you to only merge segments that have deletes. Defaults to false. Note that this will not override the index.merge.policy.expunge_deletes_allowed threshold.
flush: (boolean - default: true)
Specifies whether a flush should be performed after the optimize. Defaults to true.
wait_for_merge: (boolean - default: true)
Specifies whether the request should wait for the merge to end. Defaults to true. A merge can potentially be a very heavy operation, so you may want to run it set to false.
force: (string)
Force a merge operation, even if there is a single segment in the shard with no deletions.

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}/{client}/_mtermvectors

get

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "docs": {
            "type": "array",
            "required": false,
            "items": [
                {
                    "type": "object",
                    "properties": {
                        "_index": {
                            "type": "string",
                            "required": false
                        },
                        "_type": {
                            "type": "string",
                            "required": false
                        },
                        "_id": {
                            "type": "string",
                            "required": false
                        },
                        "term_statistics": {
                            "type": "boolean",
                            "required": false
                        }
                    }
                },
                {
                    "type": "object",
                    "properties": {
                        "_index": {
                            "type": "string",
                            "required": false
                        },
                        "_type": {
                            "type": "string",
                            "required": false
                        },
                        "_id": {
                            "type": "string",
                            "required": false
                        },
                        "fields": {
                            "type": "array",
                            "required": false,
                            "items": [
                                {
                                    "type": "string"
                                }
                            ]
                        }
                    }
                }
            ]
        }
    }
}

Example:

{
    "docs": [
        {
            "_index": "testidx",
            "_type": "test",
            "_id": "2",
            "term_statistics": true
        },
        {
            "_index": "testidx",
            "_type": "test",
            "_id": "1",
            "fields": [
                "text"
            ]
        }
    ]
}

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}/{client}/_mget

get

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "docs": {
            "type": "array",
            "required": false,
            "items": [
                {
                    "type": "object",
                    "properties": {
                        "_index": {
                            "type": "string",
                            "required": false
                        },
                        "_type": {
                            "type": "string",
                            "required": false
                        },
                        "_id": {
                            "type": "string",
                            "required": false
                        }
                    }
                }
            ]
        }
    }
}

Example:

{
    "docs": [
        {
            "_index": "test",
            "_type": "type",
            "_id": "1"
        },
        {
            "_index": "test",
            "_type": "type",
            "_id": "2"
        }
    ]
}

HTTP status code 200

Body

Type: application/json

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}/{client}/_validate/query

get

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Query Parameters

pretty: (boolean)
When appending ?pretty=true to any request made, the JSON returned is pretty formatted. Use this for debugging only.
Example:
```
true
```
format: (string)
Another option is to set format=yaml, which causes the result to be returned in the more readable YAML format.
Example:
```
yaml
```
human: (boolean - default: true)
Statistics are returned in a format suitable for humans (such as "exists_time": "1h" or "size": "1kb") and for computers (eg "exists_time_in_millis": 3600000` or "size_in_bytes": 1024). The human-readable values can be turned off by adding ?human=false to the query string. This makes sense when the stats results are being consumed by a monitoring tool rather than intended for human consumption. The default for the human flag is false.
flat_settings: (boolean)
The flat_settings flag affects rendering of the lists of settings. When flat_settings` flag is true, settings are returned in a flat format.
case: (string)
All REST APIs accept the case parameter. When set to camelCase, all field names in the result are returned in camel casing. Otherwise, underscore casing is used. This does not apply to the source document indexed.
Example:
```
camelCase
```
callback: (string)
By default, JSONP responses are enabled. All REST APIs accept a callback parameter resulting in a JSONP result.
Example:
```
JSONP
```

HTTP status code 200

Body

Type: application/json

Schema:

{
    "required": true,
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "valid": {
            "type": "boolean",
            "required": false
        },
        "_shards": {
            "type": "object",
            "required": false,
            "properties": {
                "total": {
                    "type": "number",
                    "required": false
                },
                "successful": {
                    "type": "number",
                    "required": false
                },
                "failed": {
                    "type": "number",
                    "required": false
                }
            }
        }
    }
}

Example:

{
    "valid": true,
    "_shards": {
        "total": 1,
        "successful": 1,
        "failed": 0
    }
}

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}/{client}/_msearch

get

post

Request
Response

URI Parameters

tenant: required (string)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Body

Type: text/plain

Example:

{\"index\" : \"test\"} \n
{\"query\" : {\"match_all\" : {}}, \"from\" : 0, \"size\" : 10} \n
{\"index\" : \"test\", \"search_type\" : \"count\"} \n
{\"query\" : {\"match_all\" : {}}} \n
{} \n
{\"query\" : {\"match_all\" : {}}} \n

HTTP status code 200

Body

Type: application/json

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)
The tenant string is the project's Identifier from the Builder. This parameter restricts the scope of the request to a specified tenant. Every tenant has its own data separated from other tenants.
client: required (string)
Restricts the scope of the request to a specified client. Client combined with tenant specifies the index at which the request will be performed.

Headers

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

Body

Type: text/plain

Example:

{\"index\" : \"test\"} \n
{\"query\" : {\"match_all\" : {}}, \"from\" : 0, \"size\" : 10} \n
{\"index\" : \"test\", \"search_type\" : \"count\"} \n
{\"query\" : {\"match_all\" : {}}} \n
{} \n
{\"query\" : {\"match_all\" : {}}} \n

HTTP status code 200

Body

Type: application/json

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}/{client}

Security

The Search service is a container for your data. You control the data stored in the Search service, and only you know whether the document contains personal data and which data subject the data relates to. Therefore, to meet the data privacy requirements, you must map documents containing personal data to corresponding data subjects, and implement a logic to serve the data subject's requests related to its personal data, such as requests for information or deletion. To meet these goals, follow the instructions provided in the Developer Guidelines for Data Privacy.

Scopes

The Search service requires scopes for viewing and managing data. All operations with a GET method require hybris.search_view scope. All operations with a POST, PUT, or DELETE method require the hybris.search_manage scope. The only exception is an operation with a POST method and with a path structure of /*/*/_search or /*/*/*/_search that requires the hybris.search_view scope instead of hybris.search_manage. These scopes should be granted in an access token received from the OAuth 2.0 service. You can find more information about scopes and access tokens in the following documents:

Best Practices

Use analyzers to avoid issues with queries

The Search service is backed by Elasticsearch and offers full text search and matching. To make it work efficiently, fields are set to be analyzed by default. When a field is set as analyzed, Elasticsearch applies tokenization of strings for full text search.

Such fields do not work properly with queries using terms and/or filters. For such fields, you need to set the field to not-analyzed.

The following example demonstrates how to define fields to be not_analyzed for type books.

Method: PUT
Request URL: https://api.beta.yaas.io/hybris/search/v1/{tenant}/{client}/_mappings/books
URI parameters:
- Required:
  - tenant: The project that requests this resource. Must match the project that is associated with the access token in the Authorization header.
- client: The name of the client.

Body:

{
  "books": {
      "properties" : {
          "english_title": {
              "type":     "string",
              "analyzer": "english"
          },
          "tags" : {
              "type" : "string",
              "index" : "not_analyzed"
          },
          "status" : {
              "type" : "string",
              "index" : "not_analyzed"
          }
      }
  }
}

In the following example, the field english_title is defined to be analyzed using the English analyzer, and the fields tags and status are set to be not analyzed.

Method: POST
Request URL: https://api.beta.yaas.io/hybris/search/v1/{tenant}/{client}/books/_search
URI parameters:
- Required:
  - tenant: The project that requests this resource. Must match the project that is associated with the access token in the Authorization header.
- client: The name of the client.

Body:

{
  "query": {
     "filtered": {
         "query" : {
              "bool" : {
                  "must" : [
                      { "term" : {"status": "ACTIVE"}},
                      { "term" : {"tags": "horror"}}
                  ]
              }

         }
      }
  }
}

By default, Elasticsearch applies the standard analyzer for all string fields.

For more information about analyzers in Elasticsearch, see Analyzers and Configuring Analyzers in the Elasticsearch documentation.

Once a type or field mapping is set to analyzed or not_analyzed, it cannot be changed. You can still extend mapping by adding new fields, but you cannot change fields that are already indexed.

Count your documents

You can count your documents by query using the _count endpoint.

Method: POST
Request URL: https://api.beta.yaas.io/hybris/search/v1/{tenant}/{client}/books/_count
URI parameters:
- Required:
  - tenant: The project that requests this resource. Must match the project that is associated with the access token in the Authorization header.
- client: The name of the client.

Body:

{
  "query": {
     "filtered": {
         "query" : {
              "bool" : {
                  "must" : [
                      { "term" : {"status": "ACTIVE"}},
                      { "term" : {"tags": "horror"}}
                  ]
              }

         }
      }
  }
}

Use aggregation for analytics

The Search service can be used for aggregations that you can use for your data analytics. The following example demonstrates how to calculate an average price:

Method: POST
Request URL: https://api.beta.yaas.io/hybris/search/v1/{tenant}/{client}/books/_search
URI parameters:
- Required:
  - tenant: The project that requests this resource. Must match the project that is associated with the access token in the Authorization header.
- client: The name of the client.

Body:

{
  "size" : 0,
  "query": {
     "filtered": {
         "query" : {
              "bool" : {
                  "must" : [
                      { "term" : {"status": "ACTIVE"}}
                  ]^
              }

         }
      }
  },
  "aggs" : {
      "avg_prive" : { "avg" : { "field" : "price" } }
  }
}

The field size is set to 0, which means that the aggregation result will be returned without the documents matched by query.

Use analyzer to check how text is being processed

The Search service enables you to check how fields are being analyzed using the _analyze endpoint, which reveals how text is being tokenized.

In these calls, the body must be provided as plain text.

Method: POST
Request URL: https://api.beta.yaas.io/hybris/search/v1/{tenant}/{client}/_analyze?analyzer=english
URI parameters:
- Required:
  - tenant: The project that requests this resource. Must match the project that is associated with the access token in the Authorization header.
- client: The name of the client.
Body:
```
This is the text that will be analyzed
```
For more examples of how to use the _analyze endpoint, see Analyze in the Elasticsearch documentation.

For more information about Elasticsearch, see the Elasticsearch documentation.

Limitations

Implicit index creation - one index per tenant

The index name is a combination of your {tenant} and {client} names. This way, there is only one index available for each {tenant} and {client} pair, and it is created automatically with the first call to the Search service.

Index and tenant - data separation

The Search service separates data by {tenant} and {client}, which are combined to create the index name. There must be a valid {tenant} and {client} passed to the Search service through the path parameters {tenant} and {client}.

Passing an index in a query to the Search service

The Search service gets the index name from {tenant} and {client} passed in URL. You cannot pass explicit index name in a request body.

You cannot use any kind of scripts for Elasticsearch in the Search service. Therefore, the _update operation is disabled.
You cannot create index aliases in the Search service. Therefore, _alias operation is disabled.

Introduction

Tutorials for the Search service are based on the following scenario:

The {tenant} in the example is a bookstore.
The {client} in the example is called mycomicsstore.
You have a bookstore and create online catalog for it.
The bookstore can have many types of books in its catalog, such as comic books.
This tutorial demonstrates how to search for these books using the Search service.

Remember to replace {tenant} with your Project ID and {client} with your YaaS Client. YaaS Client can be obtained from service definition in builder.

Perform Simple Operations on Index

Get all your variables in one place

The following variables are used within this tutorial:

tenant = {{projectId}};
client = {{clientName}};
AccessToken = {{token}};

Create API client for Search service

API.createClient('searchService',
'/services/search/latest/api.raml');

Create index with mapping

Request

Method: POST
Request URL: https://api.beta.yaas.io/hybris/search/v1/{tenant}/{client}
URI parameters:
- Required:
  - tenant: The project that requests this resource. Must match the project that is associated with the access token in the Authorization header.
- client: The name of the client.
Response:
- Status code: 200

searchService.tenant(tenant).client(client).post(
  {
    "settings" : {
      "index" : {
        "mapping.allow_type_wrapper" : true
      }
    }
  },
  {
    headers: {
      'Authorization': 'Bearer ' + AccessToken
    }
  }).body

Retrieve index definition

Request

Method: GET
Request URL: https://api.beta.yaas.io/hybris/search/v1/{tenant}/{client}
URI parameters:
- Required:
  - tenant: The project that requests this resource. Must match the project that is associated with the access token in the Authorization header.
- client: The name of the client.
Response:
- Status code: 200

searchService.tenant(tenant).client(client).get(null,
  {
    headers: {
      'Authorization': 'Bearer ' + AccessToken
    }
  }).body

Perform Operations on Documents

Get all your variables in one place

The following variables are used within this tutorial:

tenant = {{projectId}};
client = {{clientName}};
AccessToken = {{token}};

Create API client for Search service

API.createClient('searchService',
'/services/search/latest/api.raml');

Insert documents into an index

Request

Method: PUT
Request URL: https://api.beta.yaas.io/hybris/search/v1/{tenant}/{client}/{type}/{id}
URI parameters:
- Required:
  - tenant: The project that requests this resource. Must match the project that is associated with the access token in the Authorization header.
- client: The name of the YaaS client.
- type: The type of the resource, like books.
- id: The id of the resource to be inserted. For example, comic1.
- client: The name of the client.
Response:
- Status code: 200

comic_obj1 = searchService.tenant(tenant).client(client).type('books').id('comic1').put(
  {
    "name": "Thorgal",
    "title": "The Three Elders of Aran",
    "price": 15.99,
    "cover": "hardcover",
    "type": "comic book"
  },
  {
    headers: {
      'Authorization': 'Bearer ' + AccessToken
    }
  }).body

comic_obj2 = searchService.tenant(tenant).client(client).type('books').id('comic1').put(
  {
    "name": "Thorgal",
    "title": "The Three Elders of Aran",
    "price": 15.99,
    "cover": "hardcover",
    "type": "comic book"
  },
  {
    headers: {
      'Authorization': 'Bearer ' + AccessToken
    }
  }).body

Search documents with a query

Request

Method: POST
Request URL: https://api.beta.yaas.io/hybris/search/v1/{tenant}/{client}/{_type}/_search
URI parameters:
- Required:
  - tenant: The project that requests this resource. Must match the project that is associated with the access token in the Authorization header.
- client: The name of the client.
- _type: The type of the resource, like books.
Query parameters:
Response:
- Status code: 200

searchService.tenant(tenant).client(client).type('books')._search.post(null,
  {
    headers: {
      'Authorization': 'Bearer ' + AccessToken,
      'Content-type' : 'application/json'
    },
    query: {"match":
    {"_all":"Elders"}
  }
}).body

Further information

The Search service is backed by Elasticsearch. For more information about all of the search possibilities with Elasticsearch, see the Elasticsearch documentation.

Elasticsearch does not guarantee full persistence of the data, therefore the Search service, which is built on top of it, should not be used as a primary data storage.

The following links point to the newest Elasticsearch documentation. However, the Search service may not always be connected to the newest version. To check which version of Elasticsearch version is currently connected to the Search service, see the Search service release notes.

Having a solid understanding of Elasticsearch query theory enables you to benefit fully from the rich functionality of the Search service and use it effectively.

Security

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}/{client}

/{tenant}/{client}

post /{tenant}/{client}

URI Parameters

Headers

Body

HTTP status code 200

Body

HTTP status code 401

Body

HTTP status code 403

Body

put /{tenant}/{client}

URI Parameters

Headers

Body

HTTP status code 200

Body

HTTP status code 401

Body

HTTP status code 403

Body

delete /{tenant}/{client}

URI Parameters

Headers

HTTP status code 401

Body

HTTP status code 403

Body

get /{tenant}/{client}

URI Parameters

Headers

HTTP status code 200

Body

HTTP status code 401

Body

HTTP status code 403

Body

HTTP status code 404

head /{tenant}/{client}

URI Parameters

Headers

HTTP status code 200

HTTP status code 401

Body

HTTP status code 403

Body

HTTP status code 404

/{tenant}/{client}/{type}

post /{tenant}/{client}/{type}

URI Parameters

Headers

Query Parameters

Body

HTTP status code 200

Body

HTTP status code 201

Body

HTTP status code 401

Body

HTTP status code 403

Body

head /{tenant}/{client}/{type}

URI Parameters

Headers

HTTP status code 200

HTTP status code 400

HTTP status code 401

Body

HTTP status code 403

Body

delete /{tenant}/{client}/{type}

URI Parameters

Headers

HTTP status code 401

Body

HTTP status code 403