GET api/RoutingFormTemplate?idRoutingFormTemplate={idRoutingFormTemplate}&idPresonStartFrom={idPresonStartFrom}
Returns RF template
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| idRoutingFormTemplate |
ID template |
integer |
Required |
| idPresonStartFrom |
Id Person - from which start RF |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
RoutingFormStepPostAPI| Name | Description | Type | Additional information |
|---|---|---|---|
| sequence |
List of tasks to be done in RF step |
Collection of RoutingFormStepSequencePostAPI |
None. |
| modelData |
Inforamtion about RF step |
routing_form_step_API |
None. |
| goToNext |
If value set 0 - creates RF and stay at current step. If value set to x > 0 creates RF, step will complete and passed to x step. Value must be ID from RF template_step according to current template |
integer |
None. |
| idRoutingFormTemplate |
ID RF template #Readonly |
integer |
None. |
| IdPresonStartFrom |
ID person, responsible of statring RF |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"sequence": [
{
"_fields": [
{
"_custom_field": {
"id": 1,
"name": "sample string 2",
"type": 3,
"show": true,
"description": "sample string 5",
"is_required": true,
"id_routing_form_template_step_sequence": 1,
"company_custom_field_data_att": [
{
"id": 1,
"name": "sample string 2",
"mark_to_delete": true,
"id_person": 4,
"id_company_custom_field": 5,
"id_company_custom_field_data": 1
},
{
"id": 1,
"name": "sample string 2",
"mark_to_delete": true,
"id_person": 4,
"id_company_custom_field": 5,
"id_company_custom_field_data": 1
}
],
"company_custom_field_list_item": [
{
"id": 1,
"list_id": 2,
"item_name": "sample string 3"
},
{
"id": 1,
"list_id": 2,
"item_name": "sample string 3"
}
]
},
"_field_data_id": 1,
"_integer_data": 1,
"_text_data": "sample string 2",
"_datetime_data": "2024-11-16T04:34:23.1838183+00:00",
"_bit_data": true,
"_floating_data": 1.1
},
{
"_custom_field": {
"id": 1,
"name": "sample string 2",
"type": 3,
"show": true,
"description": "sample string 5",
"is_required": true,
"id_routing_form_template_step_sequence": 1,
"company_custom_field_data_att": [
{
"id": 1,
"name": "sample string 2",
"mark_to_delete": true,
"id_person": 4,
"id_company_custom_field": 5,
"id_company_custom_field_data": 1
},
{
"id": 1,
"name": "sample string 2",
"mark_to_delete": true,
"id_person": 4,
"id_company_custom_field": 5,
"id_company_custom_field_data": 1
}
],
"company_custom_field_list_item": [
{
"id": 1,
"list_id": 2,
"item_name": "sample string 3"
},
{
"id": 1,
"list_id": 2,
"item_name": "sample string 3"
}
]
},
"_field_data_id": 1,
"_integer_data": 1,
"_text_data": "sample string 2",
"_datetime_data": "2024-11-16T04:34:23.1838183+00:00",
"_bit_data": true,
"_floating_data": 1.1
}
],
"modelData": {
"id": 1,
"id_routing_form_template_step_sequence": 2,
"is_finished": true,
"dt_end": "2024-11-16T04:34:23.1838183+00:00",
"routing_form_template_step_sequence": {
"id": 1,
"number": 2,
"description": "sample string 3",
"is_conditional": true,
"id_routing_form_template_step": 5
}
},
"number": 1
},
{
"_fields": [
{
"_custom_field": {
"id": 1,
"name": "sample string 2",
"type": 3,
"show": true,
"description": "sample string 5",
"is_required": true,
"id_routing_form_template_step_sequence": 1,
"company_custom_field_data_att": [
{
"id": 1,
"name": "sample string 2",
"mark_to_delete": true,
"id_person": 4,
"id_company_custom_field": 5,
"id_company_custom_field_data": 1
},
{
"id": 1,
"name": "sample string 2",
"mark_to_delete": true,
"id_person": 4,
"id_company_custom_field": 5,
"id_company_custom_field_data": 1
}
],
"company_custom_field_list_item": [
{
"id": 1,
"list_id": 2,
"item_name": "sample string 3"
},
{
"id": 1,
"list_id": 2,
"item_name": "sample string 3"
}
]
},
"_field_data_id": 1,
"_integer_data": 1,
"_text_data": "sample string 2",
"_datetime_data": "2024-11-16T04:34:23.1838183+00:00",
"_bit_data": true,
"_floating_data": 1.1
},
{
"_custom_field": {
"id": 1,
"name": "sample string 2",
"type": 3,
"show": true,
"description": "sample string 5",
"is_required": true,
"id_routing_form_template_step_sequence": 1,
"company_custom_field_data_att": [
{
"id": 1,
"name": "sample string 2",
"mark_to_delete": true,
"id_person": 4,
"id_company_custom_field": 5,
"id_company_custom_field_data": 1
},
{
"id": 1,
"name": "sample string 2",
"mark_to_delete": true,
"id_person": 4,
"id_company_custom_field": 5,
"id_company_custom_field_data": 1
}
],
"company_custom_field_list_item": [
{
"id": 1,
"list_id": 2,
"item_name": "sample string 3"
},
{
"id": 1,
"list_id": 2,
"item_name": "sample string 3"
}
]
},
"_field_data_id": 1,
"_integer_data": 1,
"_text_data": "sample string 2",
"_datetime_data": "2024-11-16T04:34:23.1838183+00:00",
"_bit_data": true,
"_floating_data": 1.1
}
],
"modelData": {
"id": 1,
"id_routing_form_template_step_sequence": 2,
"is_finished": true,
"dt_end": "2024-11-16T04:34:23.1838183+00:00",
"routing_form_template_step_sequence": {
"id": 1,
"number": 2,
"description": "sample string 3",
"is_conditional": true,
"id_routing_form_template_step": 5
}
},
"number": 1
}
],
"modelData": {
"id": 1,
"id_routing_form_template_step": 2,
"id_routing_form": 3,
"id_position": 1,
"status": 4,
"dt_start": "2024-11-16T04:34:23.1838183+00:00",
"dt_end": "2024-11-16T04:34:23.1838183+00:00",
"dt_term": "2024-11-16T04:34:23.1838183+00:00",
"unfinished_description": "sample string 6"
},
"goToNext": 1,
"idRoutingFormTemplate": 2,
"IdPresonStartFrom": 3
}