You are browsing the documentation for iTop 2.7 which is not the current version.

Consider browsing to iTop 3.1 documentation

๐Ÿ”™ Back

RestResult

api

Minimal REST response structure. Derive this structure to add response data and error codes.

Tags

since 2.0.1

Constants

INTERNAL_ERROR

Result: the operation could not be performed, see the message for troubleshooting

INVALID_JSON

Result: the input structure is not a valid JSON string

INVALID_PAGE

Result: the request page number is not valid. It must be an integer greater than 0

MISSING_AUTH_PWD

Result: the parameter 'auth_pwd' is missing, authentication aborted

MISSING_AUTH_USER

Result: the parameter 'auth_user' is missing, authentication aborted

MISSING_JSON

Result: the parameter 'json_data' is missing

MISSING_VERSION

Result: the parameter 'version' is missing

OK

Result: no issue has been encountered

UNAUTHORIZED

Result: missing/wrong credentials or the user does not have enough rights to perform the requested operation

UNKNOWN_OPERATION

Result: the requested operation is not valid for the specified version

UNSAFE

Result: the requested operation cannot be performed because it can cause data (integrity) loss

UNSUPPORTED_VERSION

Result: no operation is available for the specified version

๐Ÿ”™ Back

2_7_0/customization/api/extensions/restresult.txt ยท Last modified: 2020/04/15 15:23 (external edit)
Back to top
Contact us