Skip to main content

Appendix

Generic response format for updates and new The following is the standard response for API calls that update existing objects unless otherwise specified. Updates are used to configure objects in the system such as Algorithm and Page objects.

export interface UpdateResponseItem {
id: string;
code: number;
message: string;
}

export interface UpdateResponse {
items: UpdateResponseItem[];
}
NameTypeComment
idStringUnique internal id of item being updated.
codenumberStatus code for this update, same as HTTP status codes.
messageStringHuman consumable message. Indicates reason if an error.