ApiEndpoints class
Constructors
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
createAction(
String formId) → String -
Returns the path to create a new action for a form
Example:
/form/formId/action -
deleteAction(
String formId, String actionId) → String -
Returns the path to delete an action
Example:
/form/formId/action/actionId -
deleteForm(
String formId) → String -
Returns the path to delete a form
Example:
/form/formId -
deleteRole(
String roleId) → String -
Returns the path to delete a role
Example:
/role/roleId -
deleteSubmission(
String formPath, String id) → String -
Returns the path to delete a submission
Example:
/registration/submission/submissionId -
deleteUser(
String userId) → String -
Returns the path to delete a user
Example:
/user/userId -
getAction(
String formId, String actionId) → String -
Returns the path to get a specific action
Example:
/form/formId/action/actionId -
getForm(
String path) → String -
Returns the full path to fetch a form schema.
Example:
/registration -
getRole(
String roleId) → String -
Returns the path to get a specific role
Example:
/role/roleId -
getSubmissionById(
String formPath, String id) → String -
Returns the path to fetch a specific submission.
Example:
/registration/submission/submissionId -
getUser(
String userId) → String -
Returns the path to get a specific user
Example:
/user/userId -
listActions(
String formId) → String -
Returns the path to list all actions for a form
Example:
/form/formId/action -
listSubmissions(
String formPath) → String -
Returns the path to list all submissions for a form
Example:
/registration/submission -
patchSubmission(
String formPath, String id) → String -
Returns the path to partially update a submission
Example:
/registration/submission/submissionId -
postSubmission(
String formPath) → String -
Returns the path to create a new submission.
Example:
/registration/submission -
updateAction(
String formId, String actionId) → String -
Returns the path to update an action
Example:
/form/formId/action/actionId -
updateForm(
String formId) → String -
Returns the path to update a form
Example:
/form/formId -
updateRole(
String roleId) → String -
Returns the path to update a role
Example:
/role/roleId -
updateSubmission(
String formPath, String id) → String -
Returns the path to update a submission
Example:
/registration/submission/submissionId -
updateUser(
String userId) → String -
Returns the path to update a user
Example:
/user/userId -
userExists(
String email) → String -
Returns the path to check if a user exists by email
Example:
/user/exists?email=test@example.com
Constants
- createForm → const String
-
Returns the path to create a new form
Example:
/form - createRole → const String
- Returns the path to create a new role
- currentUser → const String
- Returns the current user profile endpoint.
- listForms → const String
-
Returns the path to list all forms
Example:
/form - listRoles → const String
- Returns the path to list all roles
- listUsers → const String
- Returns the path to list all users
- login → const String
- Returns the login endpoint (if using Form.io authentication).
- logout → const String
- Returns the logout endpoint
- projectConfig → const String
- Returns a path to fetch project or form-level configuration.
- register → const String
- Returns the registration endpoint.