Models are listed once here and can also be expanded directly from the endpoints that use them.
Hypothesis14 fields
idinteger · int32
Id.
namestring
Name.
previousStartDatestring · date-time
Previous Start Date.
startDatestring · date-time
Start Date.
endDatestring · date-time
End Date.
modelIdinteger · int64
Model Id.
modelArticlestring
Model Article.
viewIdinteger · int64
View Id.
productIdinteger · int64
Product Id.
organizationIdinteger · int64
Organization Id.
createdDatestring · date-time
Created Date.
createdUserstring
Created User.
servicestring
Service.
successStatusstring
Success Status.
FindResponseHypothesis1 fields
rowsHypothesis[]
Rows.
Error contract
How application errors are returned
The error code is identical in every locale, while the user-facing message is translated by the server. Build application logic around error and use localMessage for display only.
error
Stable machine-readable code for integration logic.
localMessage
Display-ready message in the API token user's language.
params
Values interpolated by the server into the localized message template.
文
localMessage uses the lang field of the user who owns the API token. The documentation language and Accept-Language header do not change it; Russian is used when the user has no language configured.
RUUser locale is ru
{
"error": "error_brand_already_exists",
"localMessage": "Бренд Base уже существует",
"params": {
"name": "Base"
}
}
Application errors are normally returned as JSON with error, localMessage, and params. Branch on error; localized text may change. How application errors are returned ↑
401auth_required
Authentication required
Authorization is missing, empty, or contains an invalid token.
400error_access_denied
Insufficient permissions
The token exists, but its role cannot perform this operation.
500error_unknown
Unexpected error
Internal failure. Save the request time and contact support; do not blindly retry a mutation.
400error_empty_end_date
End date not specified
Endpoint-specific error. Use the stable error_empty_end_date code in application logic; localMessage contains the translation shown above.
400error_empty_name
Title not specified
Endpoint-specific error. Use the stable error_empty_name code in application logic; localMessage contains the translation shown above.
400error_empty_start_date
Start date not specified
Endpoint-specific error. Use the stable error_empty_start_date code in application logic; localMessage contains the translation shown above.
400error_end_less_then_start_date
End date must be greater than start date
Endpoint-specific error. Use the stable error_end_less_then_start_date code in application logic; localMessage contains the translation shown above.
400error_no_client
The client was not found or has been deleted. Write to support
Endpoint-specific error. Use the stable error_no_client code in application logic; localMessage contains the translation shown above.
GET
Id
/api/hypothesis/{id}
Token with read access
Id using GET /api/hypothesis/{id}.
Path parameters
Field
Type
Required
Description
id
integer · int32
Yes
Id.
curl --request GET 'https://api.selsup.ru/api/hypothesis/1001' \
--header 'Authorization: YOUR_API_TOKEN'
Application errors are normally returned as JSON with error, localMessage, and params. Branch on error; localized text may change. How application errors are returned ↑
401auth_required
Authentication required
Authorization is missing, empty, or contains an invalid token.
400error_access_denied
Insufficient permissions
The token exists, but its role cannot perform this operation.
500error_unknown
Unexpected error
Internal failure. Save the request time and contact support; do not blindly retry a mutation.
400error_no_client
The client was not found or has been deleted. Write to support
Endpoint-specific error. Use the stable error_no_client code in application logic; localMessage contains the translation shown above.
PATCH
Patch Hypothesis
/api/hypothesis/{id}
Token with write access
Patch Hypothesis using PATCH /api/hypothesis/{id}.
Application errors are normally returned as JSON with error, localMessage, and params. Branch on error; localized text may change. How application errors are returned ↑
401auth_required
Authentication required
Authorization is missing, empty, or contains an invalid token.
400error_access_denied
Insufficient permissions
The token exists, but its role cannot perform this operation.
500error_unknown
Unexpected error
Internal failure. Save the request time and contact support; do not blindly retry a mutation.
400error_empty_end_date
End date not specified
Endpoint-specific error. Use the stable error_empty_end_date code in application logic; localMessage contains the translation shown above.
400error_empty_id
Identifier not specified
Endpoint-specific error. Use the stable error_empty_id code in application logic; localMessage contains the translation shown above.
400error_empty_name
Title not specified
Endpoint-specific error. Use the stable error_empty_name code in application logic; localMessage contains the translation shown above.
400error_empty_start_date
Start date not specified
Endpoint-specific error. Use the stable error_empty_start_date code in application logic; localMessage contains the translation shown above.
400error_end_less_then_start_date
End date must be greater than start date
Endpoint-specific error. Use the stable error_end_less_then_start_date code in application logic; localMessage contains the translation shown above.
400error_no_client
The client was not found or has been deleted. Write to support
Endpoint-specific error. Use the stable error_no_client code in application logic; localMessage contains the translation shown above.
DELETE
Delete Hypothesis
/api/hypothesis/{id}
Token with write access
Delete Hypothesis using DELETE /api/hypothesis/{id}.
Application errors are normally returned as JSON with error, localMessage, and params. Branch on error; localized text may change. How application errors are returned ↑
401auth_required
Authentication required
Authorization is missing, empty, or contains an invalid token.
400error_access_denied
Insufficient permissions
The token exists, but its role cannot perform this operation.
500error_unknown
Unexpected error
Internal failure. Save the request time and contact support; do not blindly retry a mutation.
400error_no_client
The client was not found or has been deleted. Write to support
Endpoint-specific error. Use the stable error_no_client code in application logic; localMessage contains the translation shown above.
Application errors are normally returned as JSON with error, localMessage, and params. Branch on error; localized text may change. How application errors are returned ↑
401auth_required
Authentication required
Authorization is missing, empty, or contains an invalid token.
400error_access_denied
Insufficient permissions
The token exists, but its role cannot perform this operation.
500error_unknown
Unexpected error
Internal failure. Save the request time and contact support; do not blindly retry a mutation.
400error_no_client
The client was not found or has been deleted. Write to support
Endpoint-specific error. Use the stable error_no_client code in application logic; localMessage contains the translation shown above.