Overview
This is the REST documentation for TASKANA's routing REST endpoints.
For all Query Parameters:
Whenever a parameter is an array type, several values can be passed by declaring that parameter multiple times.
Whenever a parameter is a complex type, the attributes of the value-object can be passed as a json.
For example, a complex parameter with the name "complex-query-param" and attributes "attribute1" and "attribute2"
would be specified in the following way:
complex-query-param={"attribute1":"value1","attribute2":"value2"}
Hypermedia Support
HATEOAS support is still in development. Please have a look at example responses for each resource to determine the available links. |
TASKANA uses the HATEOAS (Hypermedia as the Engine of Application State) REST constraint.
Most of our resources contain a _links
section which contains navigation links.
Besides, helping to navigate through our REST API, the navigation links also encapsulate the API.
Using HATEOAS allows us to change some endpoints without modifying your frontend.
Errors
In order to support multilingual websites, TASKANA uses error codes to define which error occurred. Additionally, an optional set of message variables, containing some technical information, is added, so that the website can describe the error with all details.
DMN routing Upload
Convert And Upload
PUT /api/v1/routing-rules/default
This endpoint converts an excel file to a DMN table and saves it on the filesystem. file.
Path parameters
No parameters.
Query parameters
Parameter | Type | Optional | Description |
---|---|---|---|
excelRoutingFile |
Object |
false |
The excel file containing the routing rules. |
Request fields
No parameters.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
amountOfImportedRows |
Integer |
true |
The total amount of imported rows from the provided excel sheet. |
result |
String |
true |
A human readable String that contains the amount of imported rows. |
Example request
PUT /api/v1/routing-rules/default HTTP/1.1
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Type: application/hal+json; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Authorization: Basic YWRtaW46YWRtaW4=
Host: localhost:8080
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=excelRoutingFile
PK ! $k6�i � [Content_Types].xml �(� ̔�J�0��ߡ�V�lDd�.�s����t
K������=�6�����$����_�C2��-!�v�`}�c��)mg{�>��,�(���Y(���G�g���fTm�`u��F,kh$r���N�B##-�LxY��Ġ��l�c��F�;�����~E�7$��vs��*����RF"K����[N�����a0����|o��{�h�V�Md���!�2�ͅ��ss�_���U�.A�r�P} �����i��v���Oœ�<R�~O�˩��= A�>���H-8���m��C�m�)i�8���Ix_���q�G�n;�4ߒ$s���ԗ.�r�e ���'�����}� �� PK ! �U0#� L _rels/.rels �(� ��MO�0��H�����ݐBKwAH�!T~�I����$ݿ'T�G�~����<���!��4��;#�w����qu*&r�Fq���v�����GJy(v��*����K��#F��D��.W ��=��Z�MY�b���BS���7��ϛז��
?�9L�ҙ�sbgٮ|�l!��USh9i�b�r:"y_dl��D���|-N��R"4�2�G�%��Z�4�˝y�7 ë��ɂ��� �� PK ! t5�j� xl/workbook.xml�Umo�0�>i��; ��T�Z���ڬ�X9`+��1 Q���3 �Y�)�Pb����^|\��Y�m�(�_�H�y�c�/��<�=����1IyNhGKt3���z��z��Z�����E`e��)�xAs�$\dD�R,�����R���e�����=B .��I�":�Q��\�AM���e��E��eD��B�xV Ă�L�P�eQ0[�\�E
n���j?��jO��Q�/y"� �ؓ>���'!��cp�m�a*�+�~���a�G0l�7��jj%��}��Yhx�����KW#E�@2��i))�4f��ԇ%�ң�F���Q�R�Z����v��(4��T<
�!���b��*�s(��@�[�e�jo-�6��Rh�>���g�B�v|���载ߺ����T��q��f��=<��[:��[s���%� ⤒���
s�l��LuO�V�͠b���w���j�mhu�u�_ݖ�p��V��<�[-pf�� mۨ^Y,W�;�~P�\_���K��:�=�]
't�O|����Y˛L7��k*�x%�aA�R�EE�&u���X��y�,h�R���=�w��_�{��έ�){�e�4�"RSC�Ǧ�)Z˻R6�V �9�����n�� ��>���L�Ǔ�� U��
1���f7%����d�u��� ��^p��I
�&M��w������×
����m��װ���5 !��6-F�A� �� PK ! � �( � xl/_rels/workbook.xml.rels �(� ���j�0���}q�ne�:��A�[� &Q���6��'o?�C�@�.��$�}?Ч����j�U�%)���Z�(�8�><� ֶҝ��`@�Cq��Ns�D��$��%��襤�`�)qm��.��c�uy�
�<M�2�Հb�)���p�6 N����k��nK|q�g���X�o�d9��� +�Z$��&�� ���7�ɗ`��dK0�5a���;��B��j�^�yZ��.�~
������O /�c)�wڇ��b� �� PK ! x9,� 3
xl/worksheets/sheet1.xml �� ����ێ� ��+��1�9m�8�jWQ�����q��rXU}������ֲ�����d49���69�IJ 4Җ��������DS
m��+x����au�n�k�@�����!�KƼ�������3"��2�:e'2�ei:cF��� Kw�V���l��@�Z��ת���{pF�ݾIkZDJ���A)1r��m��ƺO|"$99�3|ƃM7~�d�t��*$Hf�o�_��B���.�07���ޗ�^X�6~'lv���r˽*s�'�F���s�zU*��XqP��_n([����S�ѿ� �o�A@NI<�������H���(dPx�s�����ߝI��x��~��Hq��J�ux���*C��E�'�,��a�=~���4�di5b�%F����lĩ��3"�P"�>X�3y/;p!;�^0I�9O�9���FE��BТ����p��)��b�C�Y2��c�M�u%� �� �����n�0F_����DM�����m*���l�%���U�Ir�bj���}���;��~V�����[
�ܨ�NU
�W��+T����팚�Q�q�$���|���P8Z�K�V��^���y���)[}bK� &v(�Q�B�P�%�I$�˵B��cbǢU��Y�"?@����D3\��'2̽0��mh1'-����}o#~��",ߺ��EMN�;y16-G2 ,mI ϟ�G@�J�����~3��h��p�w���U}D���x�y&���Y\��k��`1�5e�)�Y���_ �� ���)HLO�M,J��+V�IM+�U2�3WR(�Lπ�K����J
I�%%��0^FjbJj�g�����_������eg���� �� PK ! �ꊯ� � xl/worksheets/sheet2.xml �� �����n� @����
v5���j5���r&xl�� '���{��,�/Q���fH{Y�-+��pR�@q�Uf��}<`dS9����ŋ��]��fc+ �<A�W�5 !�W �
u�K
m$s~iJb,�/ɚĔN�dB�!1�0tQϚ��;@��y�m%{�I~
N2�i��k�x�Z��}�P�$OV�҆�k��>3����ط�QM�?�$7��
�L6ݟ�a�D�&[����o3)��X�6�6=���2I+�����1�:Ш�.�/�����B�?F���>y>���u���z� V^펒��e����P��vO����2<�1��|�����r�OL<� �� ���)�HM-qI,IԷ �� ���)HLO�M,J��+V�IM+�U2�3WR(�Lπ�K����J
I�%%��0^FjbJj�g�����_������eg���� �� PK ! 7ϴl� � xl/worksheets/sheet3.xml �� �����j�0@����ݖ�,4�N(-������c[D���,��{e�N
���#��ь��^
�c�V9��#PL\U9�x_YGUA�V��X����e;m6�p���q�\�bY
��P7����FR痦"�1@���$��)��+|$���.K��Y�V�rG�A���ּ�M�kp��M�L��#�\pw�I��*�
]��>S����ķѠ�߿�$93��҅�L�6_�?#3Bىt��U�xLly�3*�ͤxrb%g��F���ˤ-/r�����q�EA�s��
�<�
�#�y��9~�1�g}�|r��s���Z�M'XyQw�\�]���jP%m�{�����,���4��A��w/����?1�_ �� ���)�HM-qI,IԷ �� ���)HLO�M,J��+V�IM+�U2�3WR(�Lπ�K����J
I�%%��0^FjbJj�g�����_������eg���� �� PK ! ����K " xl/theme/theme1.xml�ZKo7�� ��X�%�2"�,�I����ȑZQ����I�ѭH�
M�^
��C�6@����)��_�\IK����E_v�x���١o�z�0tL��<��� �4�=�F��~�}m%@RᴇOI=�Z{���xU�$!�S���A�T��� Cx��u�����H��[-�>� [X,��L� �8���>
�h��ڈy��m��~2q�Y��`{Ge��C�dcV`�?�G*@K/�A��k7�jN���]���t9A�hѬ)��x�r�R��1�o LM�Z�V�U�3 �����ȳ�^)7F< {9ͻY��*.��iJ�Z�Ѩ�rY,S���)�Ji�����
��S�Jc��\v�d��S����r��P�hz4��m�s�cH��M/|�+�>AA4��K/�穚k >�
dX��aF�8�(n�+(P�S.�Ai��.-���_�\U��x���}ʩGZ$CA3U�נ y���7/��7/��>~q����'ONoy9��8��������/?D�=������xY����G?����5�����~y������S|]�nޡ �h���}��n�0��+��Ę:8��-;��!f>\���{ ���������(�Y�^�8�m�Y����
��ȿ�q���n��qmk�AM����}3&��{�
G$%
�w���CJ�n�Pp��
=�����$�uiB�I���' �ڱ����̧�9v���y����6(��Xvp��*� y0aג
<�Q�G����
з��{�����l��H�葏�漈��G�'�Wf��E�y!��W>�6w3D߃p:��(q�}~!�O#G�I��7���m��|�>&�*�.���C
�EGc9��E�'�G��#A�g��'Bߍ��l_`��n����H�t33��[T:!{@">C����3�i��,�;�u'tao��]�;z>��Qv%�(wk;�����x
��1���y�h��4P�/l�f����`��|�H�OH��j�^����7@7�49 M���0
<��T�:۲��xfU��3}�,ܿ�����t���2]������&��77�r����ji�Z�G�_��L�hp&3�If�{���5ddK�����^�Q��G��Y�ZX��E$����� ���fxɜu$Q�%̌�c3F%gx��(����qV����Ob��{��Rq�9fc���$u�Вfp�Ŗn��be+�L�����h�cpT��M<��X5x8�&|1#��+/ðY�s4h�{���G#��/�E2�o��GZ�i���F�2������X���j5��V�����Uf,7�xi4��xI��tdi19Y�N�A��X
P��zЇ-\&x]���"8���an2�p�x���2�ܭݧv�@&���2��a^�!�R3N6�/V������]L����M
���Z��P�]xb����R>PDĽ�e����:TA��0I7A������y��<�G1g�c��8/�:EG�l� �e0wVZ#���(7�*&�/I�b��T�� ���z�!�I
�t��.T̡
e1
�dL�h��Ex
A'�� ����9�ä5L(�>�����X�e�D�9����eY����0&��̊�%DŽut
\�{{�buSM�2`pg�Ͻ�3��&����d��=�쪖���H�P�[Aͻ���j\�Ϲ�ڊ5��b��[mp.� &B*B4������P[����
AT_���Җ�.4N��
&��v^yw{�m����x]��?���i�qs�.���ۻ����[رu������l���h�!cc�>��'�{�ހ��S�C?��(�ʰ�ݐ�ֹ�t� �� PK ! � �
xl/styles.xml�Vێ�6}/� �.�Fɒa9��+ @�-�WZ��DyQ)j+��w(ɶ6 ���6~9�9ùp��z��#�-S2w��� *KU1yȝ_�7uPk��W��Α�λ��?�[s���R� B���`L��|����P ��Jb`�^�hJ���}?�a�V��D�{�
1l�83��A�\}8H�ɞ�>��D}����dd�~eG�R�V�f���kVү�f^��ȯC
b�����W"aO�Gf��lֵ��E�꤁`N�ͺ�=���6�Rq���(�%
I5ng{ͬZM��QZ��IO0�f+������!����� �f
�2T�6hZ�0/!�F�A��&� ��?�*�*��p3w��0{E��q�-���-�,���I�Ɋ��ʝ&g^X��a|� d)^b��0 ���������%$i�f8
0��#//�@i��ѭ��I��/��T2j`�t
u^��h��6�`��רƦ�2��f]1rP�p[V��`K���m���O���N�|�L�̶yZB�N�o�X�9ڈ=���f^����l��i�]C�|����O��S]��ԧ��:h�����5���=g)��B��OM�{���^|__u�����+~C,hA���K��N�YӚ�6��%���u�|�e�5��'�{�Bd����d��À1�w��S���̪�t�v+c��G��@C�hM:n����e��X'��I�3{Tf�ȝ�z�ʬ
H�-���E�f����v��n��M�m���nown�o��]�����l����0-B�x�r����D��"˝���û��9�,L��q�E�.NH�I�E��oo�"�q�_9��^��%��3y��)Bs) ��qº2D»�� �� PK ! �F�e� � xl/sharedStrings.xmll�_o�0��'�;X~ڴA���Tk'FW�B�Z��))���+R?|���4ӗ������쥮�^��4:�tH0R:7E�S|��L1�N�BVF���g����yV�o�k�E�ͷ��vh���ƴ�t��}�l�*YحR��"FHղ���.Ŝa���S����[f����\�,�z�h.;���}qg���ܔ�t~
:�����=H�S����m�ȯ����{�{i�lNZ�x����I�6mY���|x�U��^V�
kC.�o�UW��p����6�߮�a9�Z��KbFx���Y�/V�����}>��?�?��Z�:��U���~�UU��~Ŕ����2B(�:���ט
��P
�'d��4���5őe�2`�PY0`�X,���X,��] �YN���Dxg"��?�N�R����J�U��ςh�����d�Ϗ���� �� PK ! �)� docProps/core.xml �(� |R�n�0��?�;�ӭh��֡��-v�(6�jK����ߏ�\'�:�|��#W�o}W�b��ٵ��(Ђ��n���涼E$e��ŵ�c��٧�\��yd0�dc~-��|#e�g�U\0�2��B��ð�^��ڢ\VՅ쑔V��(X�YQL�fI�]� ��-EY/jy��>~X��#foh�y���cm
��o���a�yj��������4ji���hW2�a���/������9` *r!s�6��~pAGFN"��!O��\w�`v�"��6�����o�i_�x�p�4$�ro�v�ɞ�#�7�6��YVWe}���&�_��'��+9�O=�WqY�uU./7uR���H�]�M���.L�����GrO�v���>H_r� �� PK ! �]�� � docProps/app.xml �(� ��MO�0��H��(�5H��L�K\&8�ݣ��"Z;J���{q�f����ٌC/N�r ���R zjv�|�?.n���a�zB��Yn��yI!� Y0s-��ĵR�ap�bYi)
�p�:Em<ܓ ���z�`,�
4�8噸>��B���a?E6l�6�>xW�J�>Q�����C/��F��1;���d���;�ÉKs�����o�.r&ί��U������]3��� �� PK- ! $k6�i � [Content_Types].xmlPK- ! �U0#� L � _rels/.relsPK- ! t5�j� � xl/workbook.xmlPK- ! � �( � � xl/_rels/workbook.xml.relsPK- ! x9,� 3
xl/worksheets/sheet1.xmlPK- ! �ꊯ� � � xl/worksheets/sheet2.xmlPK- ! 7ϴl� � � xl/worksheets/sheet3.xmlPK- ! ����K " xl/theme/theme1.xmlPK- ! � �
� xl/styles.xmlPK- ! �F�e� � 7 xl/sharedStrings.xmlPK- ! �)� 5! docProps/core.xmlPK- ! �]�� � �# docProps/app.xmlPK &
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
Example response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 116
{
"amountOfImportedRows" : 3,
"result" : "Successfully imported 3 routing rules from the provided excel sheet"
}