Agendize Developers API

Agendize forms API

Routing

Resource representation

{ "id": {string}, "name": {string}, "routes": { "id": {string}, "action": { "type": "link", "parameters": { {string}: {value} } }, "filterGroups": [ { "filters": [ { "fieldId": {string}, "valueId": {string}, "comparator": {string} } ] } ], "default": false }, "objectOwner": { "id": {string}, "type": {string} } }
Parameter name Value Description
id string Identifier of the routing. Read-only
name string Name of the routing. Max length: 255.
routes list List of route.
routes[].id string Identifier of the route
routes[].action object Action of the route
routes[].action.type string Type of action. Values: "link", "message".
routes[].action.parameters list

Parameters of the action.

For "link" type:

  • "link": URL of the link

For "message" type:

  • "message": Content of the message
routes[].filterGroups[] list Groups of filters
routes[].filterGroups[].filters[] list Filters
routes[].filterGroups[].filters[].fieldId list Identifier of the form's field.
routes[].filterGroups[].filters[].comparator list Comparator on the form's field value. Values: "eq", "ne", "lt", "gt", "contains", "notContains".
routes[].filterGroups[].filters[].value list Value of the form's field.
objectOwner object Object owner of the routing
objectOwner.id string Identifier of the object
objectOwner.type string Type of the object. Values: "form".

Delete

Deletes an entry on the routing list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

DELETE https://api.agendize.com/api/2.3/routing/{routingId}

Parameters

Parameter name Value Description
Path parameters
routingId string Routing identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.

Get

Returns an entry of the routing list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/api/2.3/routing/{routingId}

Parameters

Parameter name Value Description
Path parameters
routingId string Routing identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Routing resource in the response body.

List

Returns entries on the routing list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/api/2.3/routing

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{ [Routing Resource] }

Insert

Adds an entry to the routing list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

POST https://api.agendize.com/api/2.3/routing

Request body

In the request body, supply a Routing Resource with the following properties:

Parameter name Value Description
Required Properties
objectOwner object Object owner of the routing
objectOwner.id string Identifier of the object
objectOwner.type string Type of the object. Values: "form".
Optional Properties
name string Name of the routing. Max length: 255.
routes list List of route.
routes[].id string Identifier of the route
routes[].action object Action of the route
routes[].action.type string Type of action. Values: "link", "message".
routes[].action.parameters list

Parameters of the action.

For "link" type:

  • "link": URL of the link

For "message" type:

  • "message": Content of the message
routes[].filterGroups[] list Groups of filters
routes[].filterGroups[].filters[] list Filters
routes[].filterGroups[].filters[].fieldId list Identifier of the form's field.
routes[].filterGroups[].filters[].comparator list Comparator on the form's field value. Values: "eq", "ne", "lt", "gt", "contains", "notContains".
routes[].filterGroups[].filters[].value list Value of the form's field.

Response

If successful, this method returns a Form resource in the response body.

Update

Updates an entry on the routing list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

PUT https://api.agendize.com/api/2.3/routing/{routingId}

Parameters

Parameter name Value Description
Path parameters
routingId string Routing identifier.

Request body

In the request body, supply a Routing resource with the following properties:

Parameter name Value Description
Optional Properties
name string Name of the routing. Max length: 255.
routes list List of route.
routes[].id string Identifier of the route
routes[].action object Action of the route
routes[].action.type string Type of action. Values: "link", "message".
routes[].action.parameters list

Parameters of the action.

For "link" type:

  • "link": URL of the link

For "message" type:

  • "message": Content of the message
routes[].filterGroups[] list Groups of filters
routes[].filterGroups[].filters[] list Filters
routes[].filterGroups[].filters[].fieldId list Identifier of the form's field.
routes[].filterGroups[].filters[].comparator list Comparator on the form's field value. Values: "eq", "ne", "lt", "gt", "contains", "notContains".
routes[].filterGroups[].filters[].value list Value of the form's field.

Response

If successful, this method returns a Form resource in the response body.

Get

Evaluate a routing.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/api/2.3/routing/evaluate

Parameters

Parameter name Value Description
Query parameters
formResultId string Result identifier identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Route action resource in the response body.

{ "type": {string}, "link": {string}, "title": {string}, "message": {string} }
Parameter name Value Description
type string Type of action. Values: "link", "message".
link String For "link" type of route. The link to redirect.
title String For "message" type of route. The title of the message to display.
message String For "message" type of route. The message to display.

Agendize | Support | Status

Last update: Oct 15, 2024 - Copyright © 2024 Agendize. All rights reserved.