kickflow 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +102 -100
  3. data/Rakefile +1 -1
  4. data/docs/DefaultApi.md +118 -114
  5. data/docs/FormField.md +3 -1
  6. data/docs/FormFieldDetail.md +2 -0
  7. data/docs/PatchTicketsTicketIdRequestInputsInner.md +4 -4
  8. data/docs/PatchTicketsTicketIdRequestSlipItemsInnerInputsInner.md +8 -2
  9. data/docs/PostFiles200Response.md +1 -1
  10. data/docs/PostTicketsIdCommentsRequest.md +1 -1
  11. data/docs/PostTicketsRequestInputsInner.md +4 -4
  12. data/docs/PostTicketsRequestSlipItemsInnerInputsInner.md +7 -1
  13. data/docs/PostTicketsRequestSlipItemsInnerInputsInnerTeamId.md +49 -0
  14. data/docs/PostTicketsRequestSlipItemsInnerInputsInnerTicketId.md +49 -0
  15. data/docs/PostTicketsRequestSlipItemsInnerInputsInnerUserId.md +49 -0
  16. data/docs/RouteStep.md +3 -1
  17. data/docs/Section.md +2 -0
  18. data/docs/SectionListItem.md +32 -0
  19. data/docs/SlipField.md +3 -1
  20. data/docs/SlipFieldDetail.md +2 -0
  21. data/docs/SlipItemInput.md +6 -0
  22. data/docs/SubStatus.md +1 -1
  23. data/docs/TicketWithStep.md +52 -0
  24. data/docs/TicketWorkflow.md +10 -6
  25. data/docs/UserImage.md +5 -1
  26. data/docs/Workflow.md +6 -4
  27. data/docs/WorkflowDetail.md +9 -5
  28. data/docs/WorkflowInTicket.md +10 -6
  29. data/lib/kickflow/api/_api.rb +115 -109
  30. data/lib/kickflow/configuration.rb +2 -2
  31. data/lib/kickflow/models/form_field.rb +16 -5
  32. data/lib/kickflow/models/form_field_detail.rb +12 -1
  33. data/lib/kickflow/models/patch_tickets_ticket_id_request_inputs_inner.rb +4 -4
  34. data/lib/kickflow/models/patch_tickets_ticket_id_request_slip_items_inner_inputs_inner.rb +30 -5
  35. data/lib/kickflow/models/post_files200_response.rb +1 -1
  36. data/lib/kickflow/models/post_tickets_id_comments_request.rb +1 -1
  37. data/lib/kickflow/models/post_tickets_request_inputs_inner.rb +4 -4
  38. data/lib/kickflow/models/post_tickets_request_slip_items_inner_inputs_inner.rb +29 -2
  39. data/lib/kickflow/models/post_tickets_request_slip_items_inner_inputs_inner_team_id.rb +106 -0
  40. data/lib/kickflow/models/post_tickets_request_slip_items_inner_inputs_inner_ticket_id.rb +106 -0
  41. data/lib/kickflow/models/post_tickets_request_slip_items_inner_inputs_inner_user_id.rb +106 -0
  42. data/lib/kickflow/models/role_create_body_permission_list_inner.rb +2 -2
  43. data/lib/kickflow/models/role_detail_all_of_permission_list.rb +2 -2
  44. data/lib/kickflow/models/role_update_body_permission_list_inner.rb +2 -2
  45. data/lib/kickflow/models/route_step.rb +22 -5
  46. data/lib/kickflow/models/route_step_condition_field.rb +34 -0
  47. data/lib/kickflow/models/section.rb +51 -1
  48. data/lib/kickflow/models/section_list_item.rb +336 -0
  49. data/lib/kickflow/models/slip_field.rb +18 -7
  50. data/lib/kickflow/models/slip_field_detail.rb +14 -3
  51. data/lib/kickflow/models/slip_item_input.rb +37 -1
  52. data/lib/kickflow/models/sub_status.rb +2 -0
  53. data/lib/kickflow/models/ticket_with_step.rb +568 -0
  54. data/lib/kickflow/models/user_image.rb +29 -9
  55. data/lib/kickflow/models/workflow.rb +17 -5
  56. data/lib/kickflow/models/workflow_detail.rb +30 -6
  57. data/lib/kickflow/models/workflow_in_ticket.rb +31 -7
  58. data/lib/kickflow/version.rb +1 -1
  59. data/lib/kickflow.rb +5 -3
  60. data/manifest.scm +7 -1
  61. data/pkg/kickflow-0.1.0.gem +0 -0
  62. data/spec/models/post_tickets_request_slip_items_inner_inputs_inner_team_id_spec.rb +32 -0
  63. data/spec/models/post_tickets_request_slip_items_inner_inputs_inner_ticket_id_spec.rb +32 -0
  64. data/spec/models/post_tickets_request_slip_items_inner_inputs_inner_user_id_spec.rb +32 -0
  65. data/spec/models/section_list_item_spec.rb +82 -0
  66. data/spec/models/ticket_with_step_spec.rb +146 -0
  67. data/vendor/schema.yaml +377 -167
  68. metadata +22 -2
data/vendor/schema.yaml CHANGED
@@ -4,11 +4,30 @@ info:
4
4
  version: 1.0.0
5
5
  description: kickflowの開発者用REST API (v1)
6
6
  contact:
7
- name: 'kickflow, Inc.'
8
- url: 'https://kickflow.com'
9
- termsOfService: 'https://kickflow.com/terms'
7
+ name: kickflow, Inc.
8
+ url: https://kickflow.com
9
+ termsOfService: https://kickflow.com/terms
10
+ servers:
11
+ - url: https://api.kickflow.com
12
+ description: kickflow REST API v1
13
+ tags:
14
+ - name: ユーザー
15
+ - name: 役職
16
+ - name: 代理申請
17
+ - name: 代理承認
18
+ - name: 組織図
19
+ - name: チーム
20
+ - name: カテゴリ
21
+ - name: フォルダ
22
+ - name: 経路
23
+ - name: ワークフロー
24
+ - name: チケット
25
+ - name: ファイル
26
+ - name: 汎用マスタ
27
+ - name: 管理者ロール
28
+ - name: コメント
10
29
  paths:
11
- /categories:
30
+ /v1/categories:
12
31
  get:
13
32
  summary: カテゴリの一覧を取得
14
33
  tags:
@@ -70,9 +89,9 @@ paths:
70
89
  - name
71
90
  description: |-
72
91
  カテゴリを作成します。
73
-
92
+
74
93
  このAPIの実行には、ワークフローの管理権限が必要です。
75
- '/categories/{categoryId}':
94
+ /v1/categories/{categoryId}:
76
95
  parameters:
77
96
  - schema:
78
97
  type: string
@@ -90,7 +109,7 @@ paths:
90
109
  operationId: delete-categories-categoryId
91
110
  description: |-
92
111
  カテゴリを削除します。
93
-
112
+
94
113
  このAPIの実行には、ワークフローの管理権限が必要です。
95
114
  patch:
96
115
  summary: カテゴリを更新
@@ -117,9 +136,9 @@ paths:
117
136
  - name
118
137
  description: |-
119
138
  カテゴリを更新します。
120
-
139
+
121
140
  このAPIの実行には、ワークフローの管理権限が必要です。
122
- /folders:
141
+ /v1/folders:
123
142
  get:
124
143
  summary: フォルダの一覧を取得
125
144
  tags:
@@ -192,9 +211,9 @@ paths:
192
211
  - name
193
212
  description: |-
194
213
  フォルダを作成します。
195
-
214
+
196
215
  このAPIの実行には、ワークフローの管理権限が必要です。
197
- '/folders/{folderId}':
216
+ /v1/folders/{folderId}:
198
217
  parameters:
199
218
  - schema:
200
219
  type: string
@@ -212,7 +231,7 @@ paths:
212
231
  operationId: delete-folders-folderId
213
232
  description: |-
214
233
  フォルダを削除します。
215
-
234
+
216
235
  このAPIの実行には、ワークフローの管理権限が必要です。
217
236
 
218
237
  注意:このフォルダ以下のすべてのフォルダ・ワークフロー・経路・パイプラインも削除されます。
@@ -250,7 +269,7 @@ paths:
250
269
  nullable: true
251
270
  description: |-
252
271
  フォルダを更新します。
253
-
272
+
254
273
  このAPIの実行には、ワークフローの管理権限が必要です。
255
274
  get:
256
275
  summary: フォルダを取得
@@ -265,7 +284,7 @@ paths:
265
284
  tags:
266
285
  - フォルダ
267
286
  description: フォルダを一件取得します。
268
- /generalMasters:
287
+ /v1/generalMasters:
269
288
  get:
270
289
  summary: 汎用マスタの一覧を取得
271
290
  tags:
@@ -303,7 +322,7 @@ paths:
303
322
  description: 'ソート。 指定可能なフィールド: createdAt, code, name'
304
323
  description: |-
305
324
  汎用マスタの一覧を取得します。
306
-
325
+
307
326
  このAPIの実行には、汎用マスタの管理権限が必要です。
308
327
  post:
309
328
  summary: 汎用マスタを作成
@@ -380,9 +399,9 @@ paths:
380
399
  - name
381
400
  description: |-
382
401
  汎用マスタを作成します。
383
-
402
+
384
403
  このAPIの実行には、汎用マスタの管理権限が必要です。
385
- '/generalMasters/{generalMasterId}':
404
+ /v1/generalMasters/{generalMasterId}:
386
405
  parameters:
387
406
  - schema:
388
407
  type: string
@@ -404,7 +423,7 @@ paths:
404
423
  operationId: get-generalMasters-generalMasterId
405
424
  description: |-
406
425
  汎用マスタを一件取得します。
407
-
426
+
408
427
  このAPIの実行には、汎用マスタの管理権限が必要です。
409
428
  patch:
410
429
  summary: 汎用マスタを更新
@@ -468,7 +487,7 @@ paths:
468
487
  - code
469
488
  description: |-
470
489
  汎用マスタを更新します。
471
-
490
+
472
491
  このAPIの実行には、汎用マスタの管理権限が必要です。
473
492
  delete:
474
493
  summary: 汎用マスタを削除
@@ -480,9 +499,9 @@ paths:
480
499
  operationId: delete-generalMasters-generalMasterId
481
500
  description: |-
482
501
  汎用マスタを削除します。この汎用マスタのすべてのアイテムも同時に削除されます。
483
-
502
+
484
503
  このAPIの実行には、汎用マスタの管理権限が必要です。
485
- '/generalMasters/{generalMasterId}/items':
504
+ /v1/generalMasters/{generalMasterId}/items:
486
505
  parameters:
487
506
  - schema:
488
507
  type: string
@@ -589,9 +608,9 @@ paths:
589
608
  description: ''
590
609
  description: |-
591
610
  汎用マスタアイテムを作成します。
592
-
611
+
593
612
  このAPIの実行には、汎用マスタの管理権限が必要です。
594
- '/generalMasters/{generalMasterId}/items/{itemId}':
613
+ /v1/generalMasters/{generalMasterId}/items/{itemId}:
595
614
  parameters:
596
615
  - schema:
597
616
  type: string
@@ -677,7 +696,7 @@ paths:
677
696
  - value
678
697
  description: |-
679
698
  汎用マスタアイテムを更新します。
680
-
699
+
681
700
  このAPIの実行には、汎用マスタの管理権限が必要です。
682
701
  delete:
683
702
  summary: 汎用マスタアイテムを削除
@@ -689,9 +708,9 @@ paths:
689
708
  operationId: delete-generalMasters-generalMasterId-items-itemId
690
709
  description: |-
691
710
  汎用マスタアイテムを削除します。
692
-
711
+
693
712
  このAPIの実行には、汎用マスタの管理権限が必要です。
694
- /grades:
713
+ /v1/grades:
695
714
  get:
696
715
  summary: 役職の一覧を取得
697
716
  tags:
@@ -729,7 +748,7 @@ paths:
729
748
  description: 'ソート。指定可能なフィールド: level, code'
730
749
  description: |-
731
750
  役職の一覧を取得します。
732
-
751
+
733
752
  このAPIの実行には、ユーザーの管理権限が必要です。
734
753
  post:
735
754
  summary: 役職を作成
@@ -750,9 +769,9 @@ paths:
750
769
  $ref: '#/components/schemas/gradeCreateBody'
751
770
  description: |-
752
771
  役職を作成します。
753
-
772
+
754
773
  このAPIの実行には、ユーザーの管理権限が必要です。
755
- '/grades/{gradeId}':
774
+ /v1/grades/{gradeId}:
756
775
  parameters:
757
776
  - schema:
758
777
  type: string
@@ -774,7 +793,7 @@ paths:
774
793
  operationId: get-grades-gradeId
775
794
  description: |-
776
795
  役職を一件取得します。
777
-
796
+
778
797
  このAPIの実行には、ユーザーの管理権限が必要です。
779
798
  delete:
780
799
  summary: 役職を削除
@@ -786,7 +805,7 @@ paths:
786
805
  operationId: delete-grades-gradeId
787
806
  description: |-
788
807
  役職を削除します。
789
-
808
+
790
809
  このAPIの実行には、ユーザーの管理権限が必要です。
791
810
 
792
811
  注意:この役職を使用しているユーザーがいる場合、エラーとなります。先にユーザーから対象の役職を外してください。
@@ -809,9 +828,9 @@ paths:
809
828
  $ref: '#/components/schemas/gradeUpdateBody'
810
829
  description: |-
811
830
  役職を更新します。
812
-
831
+
813
832
  このAPIの実行には、ユーザーの管理権限が必要です。
814
- '/grades/{gradeId}/default':
833
+ /v1/grades/{gradeId}/default:
815
834
  parameters:
816
835
  - schema:
817
836
  type: string
@@ -828,11 +847,11 @@ paths:
828
847
  description: |-
829
848
  指定した役職をデフォルトにします。
830
849
  同時に、これまでデフォルトだった役職は自動的にデフォルトではなくなります。
831
-
850
+
832
851
  このAPIの実行には、ユーザーの管理権限が必要です。
833
852
  tags:
834
853
  - 役職
835
- /organizationCharts:
854
+ /v1/organizationCharts:
836
855
  get:
837
856
  summary: 組織図の一覧を取得
838
857
  tags:
@@ -870,7 +889,7 @@ paths:
870
889
  description: 'ソート。指定可能なフィールド: createdAt, name'
871
890
  description: |-
872
891
  組織図の一覧を取得します。
873
-
892
+
874
893
  このAPIの実行には、チームの管理権限が必要です。
875
894
 
876
895
  注意:パフォーマンス上の理由から、組織図の一覧取得時は組織図内のチームのリストがレスポンスに含まれません。
@@ -894,9 +913,9 @@ paths:
894
913
  $ref: '#/components/schemas/organizationChartBody'
895
914
  description: |-
896
915
  組織図を作成します。
897
-
916
+
898
917
  このAPIの実行には、チームの管理権限が必要です。
899
- '/organizationCharts/{organizationChartId}':
918
+ /v1/organizationCharts/{organizationChartId}:
900
919
  parameters:
901
920
  - schema:
902
921
  type: string
@@ -914,7 +933,7 @@ paths:
914
933
  operationId: delete-organizationCharts-organizationChartId
915
934
  description: |-
916
935
  組織図を削除します。同時に、組織図内のチームや所属もすべて削除されます。
917
-
936
+
918
937
  このAPIの実行には、チームの管理権限が必要です。
919
938
 
920
939
  注意:現在有効な組織図は削除できません。
@@ -933,7 +952,7 @@ paths:
933
952
  - 組織図
934
953
  description: |-
935
954
  組織図を一件取得します。
936
-
955
+
937
956
  このAPIの実行には、チームの管理権限が必要です。
938
957
  patch:
939
958
  summary: 組織図を更新
@@ -954,9 +973,9 @@ paths:
954
973
  $ref: '#/components/schemas/organizationChartBody'
955
974
  description: |-
956
975
  組織図を更新します。
957
-
976
+
958
977
  このAPIの実行には、チームの管理権限が必要です。
959
- /organizationChart:
978
+ /v1/organizationChart:
960
979
  get:
961
980
  summary: 現在の組織図を取得
962
981
  tags:
@@ -971,9 +990,9 @@ paths:
971
990
  operationId: get-organizationChart
972
991
  description: |-
973
992
  現在有効になっている組織図を取得します。
974
-
993
+
975
994
  このAPIの実行には、チームの管理権限が必要です。
976
- '/organizationCharts/{organizationChartId}/activate':
995
+ /v1/organizationCharts/{organizationChartId}/activate:
977
996
  parameters:
978
997
  - schema:
979
998
  type: string
@@ -996,7 +1015,7 @@ paths:
996
1015
  description: |-
997
1016
  指定した組織図を有効化し、ワークフローで使用する組織図を切り替えます。
998
1017
  他の組織図に有効化の予定がある場合、それらの予定は削除されます。
999
-
1018
+
1000
1019
  このAPIの実行には、チームの管理権限が必要です。
1001
1020
 
1002
1021
  注意:組織図の有効化は時間がかかることがあるため、有効化は非同期で実行されます。有効化の完了前にレスポンスを返すので注意してください。
@@ -1010,7 +1029,7 @@ paths:
1010
1029
  type: string
1011
1030
  format: date
1012
1031
  description: 有効化する日付。nullの場合、即時で有効化します。
1013
- '/organizationCharts/{organizationChartId}/teams':
1032
+ /v1/organizationCharts/{organizationChartId}/teams:
1014
1033
  parameters:
1015
1034
  - schema:
1016
1035
  type: string
@@ -1032,9 +1051,9 @@ paths:
1032
1051
  $ref: '#/components/schemas/team'
1033
1052
  description: |-
1034
1053
  指定した組織図内のチーム一覧を取得します。
1035
-
1054
+
1036
1055
  parentIdを指定した場合は指定した親チームの配下チームの一覧を、parentIdを指定しない場合は組織図内のルートのチーム一覧を返します。
1037
-
1056
+
1038
1057
  このAPIの実行には、チームの管理権限が必要です。
1039
1058
  parameters:
1040
1059
  - schema:
@@ -1073,14 +1092,14 @@ paths:
1073
1092
  operationId: post-organizationCharts-organizationChartId-teams
1074
1093
  description: |-
1075
1094
  指定した組織図内にチームを作成します。
1076
-
1095
+
1077
1096
  このAPIの実行には、チームの管理権限が必要です。
1078
1097
  requestBody:
1079
1098
  content:
1080
1099
  application/json:
1081
1100
  schema:
1082
1101
  $ref: '#/components/schemas/teamCreateBody'
1083
- '/organizationCharts/{organizationChartId}/teams/{teamId}':
1102
+ /v1/organizationCharts/{organizationChartId}/teams/{teamId}:
1084
1103
  parameters:
1085
1104
  - schema:
1086
1105
  type: string
@@ -1108,7 +1127,7 @@ paths:
1108
1127
  operationId: get-teams-teamId
1109
1128
  description: |-
1110
1129
  チームを一件取得します。
1111
-
1130
+
1112
1131
  このAPIの実行には、チームの管理権限が必要です。
1113
1132
  patch:
1114
1133
  summary: チームを編集
@@ -1129,7 +1148,7 @@ paths:
1129
1148
  $ref: '#/components/schemas/teamUpdateBody'
1130
1149
  description: |-
1131
1150
  チームを更新します。
1132
-
1151
+
1133
1152
  このAPIの実行には、チームの管理権限が必要です。
1134
1153
  delete:
1135
1154
  summary: チームを削除
@@ -1141,9 +1160,9 @@ paths:
1141
1160
  operationId: delete-teams-teamId
1142
1161
  description: |-
1143
1162
  チームを削除します。同時に、このチームの所属もすべて削除されます。
1144
-
1163
+
1145
1164
  このAPIの実行には、チームの管理権限が必要です。
1146
- '/organizationCharts/{organizationChartId}/teams/{teamId}/memberships':
1165
+ /v1/organizationCharts/{organizationChartId}/teams/{teamId}/memberships:
1147
1166
  parameters:
1148
1167
  - schema:
1149
1168
  type: string
@@ -1171,7 +1190,7 @@ paths:
1171
1190
  $ref: '#/components/schemas/memberUser'
1172
1191
  description: |-
1173
1192
  チームのメンバー一覧を取得します。
1174
-
1193
+
1175
1194
  このAPIの実行には、チームの管理権限が必要です。
1176
1195
  parameters:
1177
1196
  - schema:
@@ -1201,7 +1220,7 @@ paths:
1201
1220
  operationId: post-teams-teamId-members
1202
1221
  description: |-
1203
1222
  指定したチームにメンバーを追加します。最大10人まで同時に追加可能です。
1204
-
1223
+
1205
1224
  このAPIの実行には、チームの管理権限が必要です。
1206
1225
 
1207
1226
  注意: チームにリーダーは最低一人必要です。リーダーが不在の場合、APIは422 Unprocessable Entityを返します。
@@ -1249,7 +1268,7 @@ paths:
1249
1268
  - チーム
1250
1269
  description: |-
1251
1270
  指定したチームからメンバーを削除します。最大10人まで同時に削除可能です。
1252
-
1271
+
1253
1272
  このAPIの実行には、チームの管理権限が必要です。
1254
1273
 
1255
1274
  注意: 削除後もメンバーが残る場合、チームにリーダーは最低一人必要です。メンバー削除によってリーダーが不在になる場合、APIは422 Unprocessable Entityを返します。
@@ -1270,7 +1289,7 @@ paths:
1270
1289
  format: uuid
1271
1290
  required:
1272
1291
  - userIds
1273
- '/organizationCharts/{organizationChartId}/teams/{teamId}/memberships/{userId}':
1292
+ /v1/organizationCharts/{organizationChartId}/teams/{teamId}/memberships/{userId}:
1274
1293
  parameters:
1275
1294
  - schema:
1276
1295
  type: string
@@ -1300,7 +1319,7 @@ paths:
1300
1319
  - チーム
1301
1320
  description: |-
1302
1321
  指定したメンバーを更新します。
1303
-
1322
+
1304
1323
  このAPIの実行には、チームの管理権限が必要です。
1305
1324
 
1306
1325
  注意: チームにリーダーは最低一人は必要です。リーダーが不在の場合、APIは422 Unprocessable Entityを返します。
@@ -1323,7 +1342,7 @@ paths:
1323
1342
  required:
1324
1343
  - leader
1325
1344
  - gradeIds
1326
- /roles:
1345
+ /v1/roles:
1327
1346
  get:
1328
1347
  summary: 管理者ロールの一覧を取得
1329
1348
  tags:
@@ -1361,7 +1380,7 @@ paths:
1361
1380
  description: 'ソート。 指定可能なフィールド: createdAt, name'
1362
1381
  description: |-
1363
1382
  管理者ロールの一覧を取得します。
1364
-
1383
+
1365
1384
  このAPIの実行には、ロールの管理権限が必要です。
1366
1385
  post:
1367
1386
  summary: 管理者ロールを作成
@@ -1382,9 +1401,9 @@ paths:
1382
1401
  $ref: '#/components/schemas/roleCreateBody'
1383
1402
  description: |-
1384
1403
  管理者ロールを作成します。
1385
-
1404
+
1386
1405
  このAPIの実行には、ロールの管理権限が必要です。
1387
- '/roles/{roleId}':
1406
+ /v1/roles/{roleId}:
1388
1407
  parameters:
1389
1408
  - schema:
1390
1409
  type: string
@@ -1406,7 +1425,7 @@ paths:
1406
1425
  operationId: get-roles-roleId
1407
1426
  description: |-
1408
1427
  管理者ロールを一件取得します。
1409
-
1428
+
1410
1429
  このAPIの実行には、ロールの管理権限が必要です。
1411
1430
  patch:
1412
1431
  summary: 管理者ロールを更新
@@ -1427,7 +1446,7 @@ paths:
1427
1446
  $ref: '#/components/schemas/roleUpdateBody'
1428
1447
  description: |-
1429
1448
  管理者ロールを更新します。
1430
-
1449
+
1431
1450
  このAPIの実行には、ロールの管理権限が必要です。
1432
1451
  delete:
1433
1452
  summary: 管理者ロールを削除
@@ -1439,9 +1458,9 @@ paths:
1439
1458
  operationId: delete-roles-roleId
1440
1459
  description: |-
1441
1460
  管理者ロールを削除します。
1442
-
1461
+
1443
1462
  このAPIの実行には、ロールの管理権限が必要です。
1444
- '/roles/{roleId}/memberships':
1463
+ /v1/roles/{roleId}/memberships:
1445
1464
  parameters:
1446
1465
  - schema:
1447
1466
  type: string
@@ -1476,7 +1495,7 @@ paths:
1476
1495
  - userIds
1477
1496
  description: |-
1478
1497
  管理者ロールにメンバーを追加します。最大10人まで複数のメンバーを同時に追加可能です。
1479
-
1498
+
1480
1499
  このAPIの実行には、ロールの管理権限が必要です。
1481
1500
  get:
1482
1501
  summary: 管理者ロールのメンバー一覧を取得
@@ -1510,9 +1529,9 @@ paths:
1510
1529
  - 管理者ロール
1511
1530
  description: |-
1512
1531
  管理者ロールのメンバー一覧を取得します。
1513
-
1532
+
1514
1533
  このAPIの実行には、ロールの管理権限が必要です。
1515
- '/roles/{roleId}/memberships/{userId}':
1534
+ /v1/roles/{roleId}/memberships/{userId}:
1516
1535
  parameters:
1517
1536
  - schema:
1518
1537
  type: string
@@ -1536,9 +1555,9 @@ paths:
1536
1555
  operationId: delete-roles-roleId-memberships-userId
1537
1556
  description: |-
1538
1557
  管理者ロールからメンバーを削除します。
1539
-
1558
+
1540
1559
  このAPIの実行には、ロールの管理権限が必要です。
1541
- /tickets:
1560
+ /v1/tickets:
1542
1561
  get:
1543
1562
  summary: チケット一覧を取得
1544
1563
  tags:
@@ -1551,7 +1570,7 @@ paths:
1551
1570
  schema:
1552
1571
  type: array
1553
1572
  items:
1554
- $ref: '#/components/schemas/ticket'
1573
+ $ref: '#/components/schemas/ticketWithStep'
1555
1574
  operationId: get-tickets
1556
1575
  description: |-
1557
1576
  チケットの一覧を取得します。複数の条件を組み合わせて、フィルタ可能です。
@@ -1730,6 +1749,11 @@ paths:
1730
1749
  in: query
1731
1750
  name: assigneeStatus
1732
1751
  description: 承認者の状態。assigneeUserIdとセットで指定してください。
1752
+ - schema:
1753
+ type: string
1754
+ in: query
1755
+ name: stepTitle
1756
+ description: 現在の承認ステップ名
1733
1757
  post:
1734
1758
  summary: チケットを作成
1735
1759
  operationId: post-tickets
@@ -1813,10 +1837,40 @@ paths:
1813
1837
  items:
1814
1838
  type: string
1815
1839
  format: uuid
1840
+ userId:
1841
+ description: ユーザーUUID。フィールドがユーザータイプのときのみ指定してください。
1842
+ oneOf:
1843
+ - type: string
1844
+ format: uuid
1845
+ nullable: true
1846
+ - type: array
1847
+ items:
1848
+ type: string
1849
+ format: uuid
1850
+ teamId:
1851
+ description: チームUUID。フィールドがチームタイプのときのみ指定してください。
1852
+ oneOf:
1853
+ - type: string
1854
+ format: uuid
1855
+ nullable: true
1856
+ - type: array
1857
+ items:
1858
+ type: string
1859
+ format: uuid
1860
+ ticketId:
1861
+ description: チケットUUID。フィールドがチケットタイプのときのみ指定してください。
1862
+ oneOf:
1863
+ - type: string
1864
+ format: uuid
1865
+ nullable: true
1866
+ - type: array
1867
+ items:
1868
+ type: string
1869
+ format: uuid
1816
1870
  files:
1817
1871
  type: array
1818
1872
  description: |-
1819
- 添付ファイルの署名入りID。
1873
+ 添付ファイルの署名済みID。
1820
1874
  フィールドがファイルタイプのときのみ指定してください。
1821
1875
  nullable: true
1822
1876
  items:
@@ -1890,7 +1944,7 @@ paths:
1890
1944
  files:
1891
1945
  type: array
1892
1946
  description: |-
1893
- 添付ファイルの署名入りID。
1947
+ 添付ファイルの署名済みID。
1894
1948
  フィールドがファイルタイプのときのみ指定してください。
1895
1949
  nullable: true
1896
1950
  items:
@@ -1917,7 +1971,7 @@ paths:
1917
1971
  - workflowId
1918
1972
  - authorTeamId
1919
1973
  - inputs
1920
- /tickets/tasks:
1974
+ /v1/tickets/tasks:
1921
1975
  get:
1922
1976
  summary: 承認リクエスト一覧を取得
1923
1977
  tags:
@@ -1930,7 +1984,7 @@ paths:
1930
1984
  schema:
1931
1985
  type: array
1932
1986
  items:
1933
- $ref: '#/components/schemas/ticket'
1987
+ $ref: '#/components/schemas/ticketWithStep'
1934
1988
  operationId: get-tickets-tasks
1935
1989
  description: |-
1936
1990
  現在のユーザーにアサインされている承認リクエストの一覧を取得します。複数の条件を組み合わせて、フィルタ可能です。
@@ -2059,7 +2113,12 @@ paths:
2059
2113
  in: query
2060
2114
  name: deletedAtEnd
2061
2115
  description: 削除日時の終点
2062
- '/tickets/{ticketId}':
2116
+ - schema:
2117
+ type: string
2118
+ in: query
2119
+ name: stepTitle
2120
+ description: 現在の承認ステップ名
2121
+ /v1/tickets/{ticketId}:
2063
2122
  parameters:
2064
2123
  - schema:
2065
2124
  type: string
@@ -2113,7 +2172,7 @@ paths:
2113
2172
  - draft
2114
2173
  - in_progress
2115
2174
  - rejected
2116
- description: 'ステータス。更新ではdraft, in_progress, rejectedのみ選択可能です。'
2175
+ description: ステータス。更新ではdraft, in_progress, rejectedのみ選択可能です。
2117
2176
  authorTeamId:
2118
2177
  type: string
2119
2178
  description: 申請者チームのUUID
@@ -2156,13 +2215,49 @@ paths:
2156
2215
  items:
2157
2216
  type: string
2158
2217
  generalMasterItemId:
2159
- type: string
2160
2218
  description: 汎用マスタアイテムのUUID。フィールドが汎用マスタタイプのときのみ指定してください。
2161
- nullable: true
2219
+ oneOf:
2220
+ - type: string
2221
+ format: uuid
2222
+ nullable: true
2223
+ - type: array
2224
+ items:
2225
+ type: string
2226
+ format: uuid
2227
+ userId:
2228
+ description: ユーザーUUID。フィールドがユーザータイプのときのみ指定してください。
2229
+ oneOf:
2230
+ - type: string
2231
+ format: uuid
2232
+ nullable: true
2233
+ - type: array
2234
+ items:
2235
+ type: string
2236
+ format: uuid
2237
+ teamId:
2238
+ description: チームUUID。フィールドがチームタイプのときのみ指定してください。
2239
+ oneOf:
2240
+ - type: string
2241
+ format: uuid
2242
+ nullable: true
2243
+ - type: array
2244
+ items:
2245
+ type: string
2246
+ format: uuid
2247
+ ticketId:
2248
+ description: チケットUUID。フィールドがチケットタイプのときのみ指定してください。
2249
+ oneOf:
2250
+ - type: string
2251
+ format: uuid
2252
+ nullable: true
2253
+ - type: array
2254
+ items:
2255
+ type: string
2256
+ format: uuid
2162
2257
  files:
2163
2258
  type: array
2164
2259
  description: |-
2165
- 添付ファイルの署名入りID。
2260
+ 添付ファイルの署名済みID。
2166
2261
  フィールドがファイルタイプのときのみ指定してください。
2167
2262
  nullable: true
2168
2263
  items:
@@ -2240,7 +2335,7 @@ paths:
2240
2335
  files:
2241
2336
  type: array
2242
2337
  description: |-
2243
- 添付ファイルの署名入りID。
2338
+ 添付ファイルの署名済みID。
2244
2339
  フィールドがファイルタイプのときのみ指定してください。
2245
2340
  nullable: true
2246
2341
  items:
@@ -2262,7 +2357,7 @@ paths:
2262
2357
  - id
2263
2358
  - title
2264
2359
  - sandbox
2265
- '/tickets/{ticketId}/approve':
2360
+ /v1/tickets/{ticketId}/approve:
2266
2361
  parameters:
2267
2362
  - schema:
2268
2363
  type: string
@@ -2272,7 +2367,7 @@ paths:
2272
2367
  required: true
2273
2368
  description: チケットのUUID
2274
2369
  post:
2275
- summary: チケットを承認する
2370
+ summary: チケットを承認または確認する
2276
2371
  tags:
2277
2372
  - チケット
2278
2373
  responses:
@@ -2284,9 +2379,9 @@ paths:
2284
2379
  $ref: '#/components/schemas/ticketDetail'
2285
2380
  operationId: post-tickets-ticketId-approve
2286
2381
  description: |-
2287
- 指定したチケットを承認します。
2382
+ 指定したチケットを承認もしくは確認します。
2288
2383
  APIの実行ユーザーがチケットにアサインされていない場合、403 Forbiddenを返します。
2289
- '/tickets/{ticketId}/reject':
2384
+ /v1/tickets/{ticketId}/reject:
2290
2385
  parameters:
2291
2386
  - schema:
2292
2387
  type: string
@@ -2321,7 +2416,7 @@ paths:
2321
2416
  description: |-
2322
2417
  指定したチケットを差し戻します。
2323
2418
  APIの実行ユーザーがチケットにアサインされていない場合、403 Forbiddenを返します。
2324
- '/tickets/{ticketId}/deny':
2419
+ /v1/tickets/{ticketId}/deny:
2325
2420
  parameters:
2326
2421
  - schema:
2327
2422
  type: string
@@ -2350,7 +2445,7 @@ paths:
2350
2445
  description: |-
2351
2446
  指定したチケットを却下します。
2352
2447
  APIの実行ユーザーがチケットにアサインされていない場合、403 Forbiddenを返します。
2353
- '/tickets/{ticketId}/withdraw':
2448
+ /v1/tickets/{ticketId}/withdraw:
2354
2449
  parameters:
2355
2450
  - schema:
2356
2451
  type: string
@@ -2372,7 +2467,7 @@ paths:
2372
2467
  $ref: '#/components/schemas/ticketDetail'
2373
2468
  operationId: post-tickets-ticketId-withdraw
2374
2469
  description: 自分が作成したチケットを取り下げます。
2375
- '/tickets/{ticketId}/archive':
2470
+ /v1/tickets/{ticketId}/archive:
2376
2471
  parameters:
2377
2472
  - schema:
2378
2473
  type: string
@@ -2397,7 +2492,7 @@ paths:
2397
2492
  チケットをアーカイブします。チケットのステータスがアーカイブステータスに変わりますが、引き続きUIやAPIでチケットにはアクセス可能です。
2398
2493
 
2399
2494
  注意:チケットをアーカイブ可能なユーザーはチケットのステータスによって異なります。詳しくは[ヘルプ](https://support.kickflow.com/hc/ja/articles/360058324973)をご覧ください。
2400
- '/tickets/{ticketId}/links':
2495
+ /v1/tickets/{ticketId}/links:
2401
2496
  parameters:
2402
2497
  - schema:
2403
2498
  type: string
@@ -2437,7 +2532,7 @@ paths:
2437
2532
  in: query
2438
2533
  name: perPage
2439
2534
  description: 1ページあたりの件数
2440
- '/tickets/{ticketId}/viewers':
2535
+ /v1/tickets/{ticketId}/viewers:
2441
2536
  parameters:
2442
2537
  - schema:
2443
2538
  type: string
@@ -2522,7 +2617,7 @@ paths:
2522
2617
  format: uuid
2523
2618
  description: 役職のUUID。teamId指定時のみ、任意で指定できます。
2524
2619
  nullable: true
2525
- '/tickets/{ticketId}/viewers/{viewerId}':
2620
+ /v1/tickets/{ticketId}/viewers/{viewerId}:
2526
2621
  parameters:
2527
2622
  - schema:
2528
2623
  type: string
@@ -2547,7 +2642,7 @@ paths:
2547
2642
  description: OK
2548
2643
  operationId: delete-tickets-id-viewers-viewerId
2549
2644
  description: チケットの閲覧者を削除します。
2550
- '/tickets/{ticketId}/comments':
2645
+ /v1/tickets/{ticketId}/comments:
2551
2646
  parameters:
2552
2647
  - schema:
2553
2648
  type: string
@@ -2616,13 +2711,13 @@ paths:
2616
2711
  description: 本文
2617
2712
  files:
2618
2713
  type: array
2619
- description: 添付ファイルの署名入りID
2714
+ description: 添付ファイルの署名済みID
2620
2715
  nullable: true
2621
2716
  items:
2622
2717
  type: string
2623
2718
  required:
2624
2719
  - body
2625
- '/tickets/{ticketId}/comments/{commentId}':
2720
+ /v1/tickets/{ticketId}/comments/{commentId}:
2626
2721
  parameters:
2627
2722
  - schema:
2628
2723
  type: string
@@ -2684,7 +2779,7 @@ paths:
2684
2779
  description: OK
2685
2780
  operationId: delete-tickets-id-comments-commentId
2686
2781
  description: チケットのコメントを削除します。
2687
- /user:
2782
+ /v1/user:
2688
2783
  get:
2689
2784
  summary: 現在のユーザーを取得
2690
2785
  tags:
@@ -2698,7 +2793,7 @@ paths:
2698
2793
  $ref: '#/components/schemas/userDetail'
2699
2794
  operationId: get-user
2700
2795
  description: 現在のユーザーを取得します。
2701
- /users:
2796
+ /v1/users:
2702
2797
  get:
2703
2798
  summary: ユーザー一覧を取得
2704
2799
  tags:
@@ -2767,7 +2862,7 @@ paths:
2767
2862
  description: |-
2768
2863
  ユーザーを作成します。
2769
2864
  作成されたユーザーは招待済みステータスとなり、招待メールが送信されます。
2770
-
2865
+
2771
2866
  このAPIの実行には、ユーザーの管理権限が必要です。
2772
2867
  requestBody:
2773
2868
  content:
@@ -2806,7 +2901,7 @@ paths:
2806
2901
  - lastName
2807
2902
  tags:
2808
2903
  - ユーザー
2809
- '/users/{userId}':
2904
+ /v1/users/{userId}:
2810
2905
  parameters:
2811
2906
  - schema:
2812
2907
  type: string
@@ -2837,12 +2932,12 @@ paths:
2837
2932
  content:
2838
2933
  application/json:
2839
2934
  schema:
2840
- $ref: '#/components/schemas/user'
2935
+ $ref: '#/components/schemas/userDetail'
2841
2936
  operationId: delete-users-userId
2842
2937
  description: |-
2843
2938
  ユーザーを削除します(論理削除)。
2844
2939
  削除されたユーザーは削除済ステータスとなりますが、引き続きユーザー情報にアクセス可能です。
2845
-
2940
+
2846
2941
  このAPIの実行には、ユーザーの管理権限が必要です。
2847
2942
  patch:
2848
2943
  summary: ユーザーを更新
@@ -2886,9 +2981,9 @@ paths:
2886
2981
  - ユーザー
2887
2982
  description: |-
2888
2983
  ユーザーを更新します。
2889
-
2984
+
2890
2985
  このAPIの実行には、ユーザーの管理権限が必要です。
2891
- /users/lookupByEmail:
2986
+ /v1/users/lookupByEmail:
2892
2987
  get:
2893
2988
  summary: メールアドレスからユーザーを取得
2894
2989
  tags:
@@ -2911,7 +3006,7 @@ paths:
2911
3006
  description: |-
2912
3007
  メールアドレスからユーザーを取得します(完全一致)
2913
3008
  ※メールアドレスはURLエンコードしたものを送ってください。
2914
- '/users/{userId}/reinvite':
3009
+ /v1/users/{userId}/reinvite:
2915
3010
  parameters:
2916
3011
  - schema:
2917
3012
  type: string
@@ -2931,11 +3026,11 @@ paths:
2931
3026
  operationId: post-users-userId-reinvite
2932
3027
  description: |-
2933
3028
  削除されたユーザーを再び招待します。
2934
-
3029
+
2935
3030
  このAPIの実行には、ユーザーの管理権限が必要です。
2936
3031
  tags:
2937
3032
  - ユーザー
2938
- '/users/{userId}/suspend':
3033
+ /v1/users/{userId}/suspend:
2939
3034
  parameters:
2940
3035
  - schema:
2941
3036
  type: string
@@ -2955,11 +3050,11 @@ paths:
2955
3050
  operationId: post-users-userId-suspend
2956
3051
  description: |-
2957
3052
  有効なユーザーを一時停止します。
2958
-
3053
+
2959
3054
  このAPIの実行には、ユーザーの管理権限が必要です。
2960
3055
  tags:
2961
3056
  - ユーザー
2962
- '/users/{userId}/reactivate':
3057
+ /v1/users/{userId}/reactivate:
2963
3058
  parameters:
2964
3059
  - schema:
2965
3060
  type: string
@@ -2979,11 +3074,11 @@ paths:
2979
3074
  operationId: post-users-userId-reactivate
2980
3075
  description: |-
2981
3076
  一時停止中のユーザーを有効化します。
2982
-
3077
+
2983
3078
  このAPIの実行には、ユーザーの管理権限が必要です。
2984
3079
  tags:
2985
3080
  - ユーザー
2986
- '/users/{userId}/teams':
3081
+ /v1/users/{userId}/teams:
2987
3082
  parameters:
2988
3083
  - schema:
2989
3084
  type: string
@@ -3007,7 +3102,7 @@ paths:
3007
3102
  - ユーザー
3008
3103
  description: |-
3009
3104
  ユーザーの所属チーム一覧を取得します。
3010
-
3105
+
3011
3106
  このAPIの実行には、チームの管理権限が必要です。
3012
3107
  parameters:
3013
3108
  - schema:
@@ -3030,7 +3125,7 @@ paths:
3030
3125
  in: query
3031
3126
  name: submittable
3032
3127
  description: trueの場合、申請可能なチームのみ返す。デフォルトはfalse(すべてのチームを返す)
3033
- '/users/{userId}/roles':
3128
+ /v1/users/{userId}/roles:
3034
3129
  parameters:
3035
3130
  - schema:
3036
3131
  type: string
@@ -3054,7 +3149,7 @@ paths:
3054
3149
  - ユーザー
3055
3150
  description: |-
3056
3151
  ユーザーの管理者ロール一覧を取得します。
3057
-
3152
+
3058
3153
  このAPIの実行には、ロールの管理権限が必要です。
3059
3154
  parameters:
3060
3155
  - schema:
@@ -3072,7 +3167,7 @@ paths:
3072
3167
  in: query
3073
3168
  name: perPage
3074
3169
  description: 1ページあたりの件数
3075
- /routes:
3170
+ /v1/routes:
3076
3171
  get:
3077
3172
  summary: 経路一覧を取得
3078
3173
  tags:
@@ -3089,7 +3184,7 @@ paths:
3089
3184
  operationId: get-routes
3090
3185
  description: |-
3091
3186
  経路の一覧を取得します。ステータスやフォルダによる絞り込みが可能です。
3092
-
3187
+
3093
3188
  このAPIの実行には、ワークフローの管理権限が必要です。
3094
3189
  parameters:
3095
3190
  - schema:
@@ -3128,7 +3223,7 @@ paths:
3128
3223
  in: query
3129
3224
  name: folderId
3130
3225
  description: フォルダのUUID
3131
- '/routes/{routeId}':
3226
+ /v1/routes/{routeId}:
3132
3227
  parameters:
3133
3228
  - schema:
3134
3229
  type: string
@@ -3150,9 +3245,9 @@ paths:
3150
3245
  operationId: get-routes-routeId
3151
3246
  description: |-
3152
3247
  指定した経路を取得します。
3153
-
3248
+
3154
3249
  このAPIの実行には、ワークフローの管理権限が必要です。
3155
- /workflows:
3250
+ /v1/workflows:
3156
3251
  get:
3157
3252
  summary: ワークフロー一覧を取得
3158
3253
  tags:
@@ -3199,7 +3294,7 @@ paths:
3199
3294
  name: status
3200
3295
  description: ステータス
3201
3296
  description: ワークフローの一覧を取得します。ステータスによる絞り込みが可能です。
3202
- '/workflows/{workflowId}':
3297
+ /v1/workflows/{workflowId}:
3203
3298
  parameters:
3204
3299
  - schema:
3205
3300
  type: string
@@ -3220,7 +3315,7 @@ paths:
3220
3315
  $ref: '#/components/schemas/workflowDetail'
3221
3316
  operationId: get-workflows-workflowId
3222
3317
  description: 指定したIDのワークフローを取得します。
3223
- /proxyApplicants:
3318
+ /v1/proxyApplicants:
3224
3319
  get:
3225
3320
  summary: 代理申請一覧を取得
3226
3321
  tags:
@@ -3253,7 +3348,7 @@ paths:
3253
3348
  operationId: get-proxyApplicants
3254
3349
  description: |-
3255
3350
  テナント内の代理申請の一覧を取得します。
3256
-
3351
+
3257
3352
  このAPIの実行には、ユーザーの管理権限が必要です。
3258
3353
  post:
3259
3354
  summary: 代理申請を作成
@@ -3302,9 +3397,9 @@ paths:
3302
3397
  - proxyUserId
3303
3398
  description: |-
3304
3399
  代理申請を新規作成します。
3305
-
3400
+
3306
3401
  このAPIの実行には、ユーザーの管理権限が必要です。ただし、自分の代理申請の設定をすべてのユーザーに許可している場合、管理権限は不要です。
3307
- '/proxyApplicants/{proxyApplicantId}':
3402
+ /v1/proxyApplicants/{proxyApplicantId}:
3308
3403
  parameters:
3309
3404
  - schema:
3310
3405
  type: string
@@ -3323,9 +3418,9 @@ paths:
3323
3418
  operationId: delete-proxyApplicants-proxyApplicantId
3324
3419
  description: |-
3325
3420
  指定した代理申請を削除します。
3326
-
3421
+
3327
3422
  このAPIの実行には、ユーザーの管理権限が必要です。ただし、自分の代理申請の設定をすべてのユーザーに許可している場合、管理権限は不要です。
3328
- /proxyApprovers:
3423
+ /v1/proxyApprovers:
3329
3424
  get:
3330
3425
  summary: 代理承認一覧を取得
3331
3426
  tags:
@@ -3358,7 +3453,7 @@ paths:
3358
3453
  operationId: get-proxyApprovers
3359
3454
  description: |-
3360
3455
  テナント内の代理承認の一覧を取得します。
3361
-
3456
+
3362
3457
  このAPIの実行には、ユーザーの管理権限が必要です。
3363
3458
  post:
3364
3459
  summary: 代理承認を作成
@@ -3374,7 +3469,7 @@ paths:
3374
3469
  operationId: post-proxyApprovers
3375
3470
  description: |-
3376
3471
  代理承認を新規作成します。
3377
-
3472
+
3378
3473
  このAPIの実行には、ユーザーの管理権限が必要です。ただし、自分の代理承認の設定をすべてのユーザーに許可している場合、管理権限は不要です。
3379
3474
  requestBody:
3380
3475
  content:
@@ -3409,7 +3504,7 @@ paths:
3409
3504
  required:
3410
3505
  - userId
3411
3506
  - proxyUserId
3412
- '/proxyApprovers/{proxyApproverId}':
3507
+ /v1/proxyApprovers/{proxyApproverId}:
3413
3508
  parameters:
3414
3509
  - schema:
3415
3510
  type: string
@@ -3428,9 +3523,9 @@ paths:
3428
3523
  operationId: delete-proxyApprovers-proxyApproverId
3429
3524
  description: |-
3430
3525
  指定した代理承認を削除します。
3431
-
3526
+
3432
3527
  このAPIの実行には、ユーザーの管理権限が必要です。ただし、自分の代理承認の設定をすべてのユーザーに許可している場合、管理権限は不要です。
3433
- /files:
3528
+ /v1/files:
3434
3529
  post:
3435
3530
  summary: 添付ファイルをアップロード
3436
3531
  tags:
@@ -3445,12 +3540,12 @@ paths:
3445
3540
  properties:
3446
3541
  signedId:
3447
3542
  type: string
3448
- description: 添付ファイルの署名入りID
3543
+ description: 添付ファイルの署名済みID
3449
3544
  required:
3450
3545
  - signedId
3451
3546
  operationId: post-files
3452
3547
  description: |-
3453
- 添付ファイルをアップロードします。
3548
+ 添付ファイルをアップロードします。最大2MBまでのファイルをアップロード可能です。
3454
3549
 
3455
3550
  注意:このAPIはエンタープライズプランのお客様のみ利用可能です。
3456
3551
 
@@ -3464,14 +3559,14 @@ paths:
3464
3559
  file:
3465
3560
  description: 添付ファイル
3466
3561
  description: ''
3467
- '/files/{signedId}':
3562
+ /v1/files/{signedId}:
3468
3563
  parameters:
3469
3564
  - schema:
3470
3565
  type: string
3471
3566
  name: signedId
3472
3567
  in: path
3473
3568
  required: true
3474
- description: 添付ファイルの署名入りID
3569
+ description: 添付ファイルの署名済みID
3475
3570
  get:
3476
3571
  summary: 添付ファイルの情報を取得
3477
3572
  responses:
@@ -3649,9 +3744,18 @@ components:
3649
3744
  description: ユーザー画像のURL。サイズごとに複数のURLを返します。
3650
3745
  required:
3651
3746
  - 100x100
3747
+ - 64x64
3748
+ - 32x32
3652
3749
  properties:
3653
3750
  100x100:
3654
3751
  type: string
3752
+ nullable: true
3753
+ 64x64:
3754
+ type: string
3755
+ nullable: true
3756
+ 32x32:
3757
+ type: string
3758
+ nullable: true
3655
3759
  status:
3656
3760
  type: string
3657
3761
  enum:
@@ -4082,6 +4186,8 @@ components:
4082
4186
  - master
4083
4187
  - ticket_read
4084
4188
  - ticket_write
4189
+ - label
4190
+ - automation
4085
4191
  description: 権限タイプ
4086
4192
  restricted:
4087
4193
  type: boolean
@@ -4137,11 +4243,14 @@ components:
4137
4243
  - audit
4138
4244
  - stats
4139
4245
  - workflow
4140
- - ticket
4141
4246
  - user
4142
4247
  - team
4143
4248
  - role
4144
4249
  - master
4250
+ - ticket_read
4251
+ - ticket_write
4252
+ - label
4253
+ - automation
4145
4254
  restricted:
4146
4255
  type: boolean
4147
4256
  description: 管理対象を制限する場合true
@@ -4196,11 +4305,14 @@ components:
4196
4305
  - audit
4197
4306
  - stats
4198
4307
  - workflow
4199
- - ticket
4200
4308
  - user
4201
4309
  - team
4202
4310
  - role
4203
4311
  - master
4312
+ - ticket_read
4313
+ - ticket_write
4314
+ - label
4315
+ - automation
4204
4316
  restricted:
4205
4317
  type: boolean
4206
4318
  description: 管理対象を制限する場合true
@@ -4534,7 +4646,7 @@ components:
4534
4646
  code:
4535
4647
  type: string
4536
4648
  description: コード
4537
- pattern: '^[a-zA-Z0-9_-]+$'
4649
+ pattern: ^[a-zA-Z0-9_-]+$
4538
4650
  versionId:
4539
4651
  type: string
4540
4652
  description: バージョンのUUID
@@ -4575,22 +4687,26 @@ components:
4575
4687
  nullable: true
4576
4688
  slip:
4577
4689
  type: boolean
4578
- description: 明細を持つ場合true
4690
+ description: 明細を持つ場合true。このフィールドは廃止予定です。代わりにsectionListのsectionTypeを参照してください。
4579
4691
  default: false
4692
+ deprecated: true
4580
4693
  slipTitle:
4581
4694
  type: string
4582
- description: 明細タイトル
4695
+ description: 明細タイトル。このフィールドは廃止予定です。代わりにsectionListのtitleを参照してください。
4583
4696
  nullable: true
4697
+ deprecated: true
4584
4698
  slipDescription:
4585
4699
  type: string
4586
- description: 明細の説明
4700
+ description: 明細の説明。このフィールドは廃止予定です。代わりにsectionListのdescriptionを参照してください。
4587
4701
  nullable: true
4702
+ deprecated: true
4588
4703
  slipPosition:
4589
4704
  type: string
4590
- description: 明細の位置
4705
+ description: 明細の位置。このフィールドは廃止予定です。代わりにsectionListを参照してください。
4591
4706
  enum:
4592
4707
  - top
4593
4708
  - bottom
4709
+ deprecated: true
4594
4710
  ticketNumberFormat:
4595
4711
  type: string
4596
4712
  description: チケット番号のフォーマット
@@ -4615,6 +4731,10 @@ components:
4615
4731
  type: string
4616
4732
  description: タイトルの計算式
4617
4733
  nullable: true
4734
+ allowEditingOfViewers:
4735
+ type: boolean
4736
+ description: 閲覧者の編集が可能な場合true
4737
+ default: true
4618
4738
  author:
4619
4739
  anyOf:
4620
4740
  - $ref: '#/components/schemas/user'
@@ -4671,16 +4791,23 @@ components:
4671
4791
  - $ref: '#/components/schemas/workflow'
4672
4792
  - type: object
4673
4793
  properties:
4794
+ sectionList:
4795
+ type: array
4796
+ description: セクション・明細を表すオブジェクトを画面に表示される順に格納した配列。
4797
+ items:
4798
+ $ref: '#/components/schemas/sectionListItem'
4674
4799
  sections:
4675
4800
  type: array
4676
- description: セクションの配列
4801
+ description: セクションの配列。このフィールドは廃止予定です。代わりにsectionListを参照してください。
4677
4802
  items:
4678
4803
  $ref: '#/components/schemas/section'
4804
+ deprecated: true
4679
4805
  slipFields:
4680
4806
  type: array
4681
- description: 明細フィールドの配列
4807
+ description: 明細フィールドの配列。このフィールドは廃止予定です。代わりにsectionListを参照してください。
4682
4808
  items:
4683
4809
  $ref: '#/components/schemas/slipFieldDetail'
4810
+ deprecated: true
4684
4811
  ticketViewers:
4685
4812
  type: array
4686
4813
  description: ワークフロー単位のチケット閲覧者
@@ -4735,6 +4862,10 @@ components:
4735
4862
  type: string
4736
4863
  format: uuid
4737
4864
  description: UUID
4865
+ sectionType:
4866
+ type: string
4867
+ enum:
4868
+ - form
4738
4869
  title:
4739
4870
  type: string
4740
4871
  description: タイトル
@@ -4764,6 +4895,7 @@ components:
4764
4895
  description: 条件をすべて満たす必要があるかどうか
4765
4896
  required:
4766
4897
  - id
4898
+ - sectionType
4767
4899
  - title
4768
4900
  - description
4769
4901
  - formFields
@@ -4771,6 +4903,50 @@ components:
4771
4903
  - updatedAt
4772
4904
  - conditional
4773
4905
  - conditionAllOf
4906
+ sectionListItem:
4907
+ title: SectionListItem
4908
+ type: object
4909
+ x-tags:
4910
+ - workflows
4911
+ description: 明細セクションまたはフォームセクション
4912
+ properties:
4913
+ sectionType:
4914
+ type: string
4915
+ enum:
4916
+ - form
4917
+ - slip
4918
+ title:
4919
+ type: string
4920
+ description: タイトル
4921
+ nullable: true
4922
+ description:
4923
+ type: string
4924
+ description: 説明
4925
+ nullable: true
4926
+ id:
4927
+ type: string
4928
+ format: uuid
4929
+ description: フォームセクションのID(UUID)。明細セクションには含まれません。
4930
+ formFields:
4931
+ type: array
4932
+ description: フォームフィールド。明細セクションには含まれません。
4933
+ items:
4934
+ $ref: '#/components/schemas/formFieldDetail'
4935
+ conditional:
4936
+ type: boolean
4937
+ description: 表示条件があるかどうか。明細セクションには含まれません。
4938
+ conditionAllOf:
4939
+ type: boolean
4940
+ description: 条件をすべて満たす必要があるかどうか。明細セクションには含まれません。
4941
+ slipFields:
4942
+ type: array
4943
+ description: 明細フィールド。フォームセクションには含まれません。
4944
+ items:
4945
+ $ref: '#/components/schemas/slipFieldDetail'
4946
+ required:
4947
+ - sectionType
4948
+ - title
4949
+ - description
4774
4950
  formField:
4775
4951
  title: FormField
4776
4952
  type: object
@@ -4888,6 +5064,12 @@ components:
4888
5064
  type: boolean
4889
5065
  description: 隠しフィールドである場合true
4890
5066
  nullable: true
5067
+ readonlyOnUi:
5068
+ type: boolean
5069
+ description: |-
5070
+ trueの時、申請者・承認者が画面上から値を入力することを禁止します。
5071
+ ボタン(外部API連携)による代入や、REST API経由での入力はこのオプションの対象外です。
5072
+ nullable: true
4891
5073
  required:
4892
5074
  - id
4893
5075
  - title
@@ -5081,6 +5263,9 @@ components:
5081
5263
  - date
5082
5264
  - file
5083
5265
  - master
5266
+ - user
5267
+ - team
5268
+ - ticket
5084
5269
  code:
5085
5270
  type: string
5086
5271
  description: フィールドのコード
@@ -5151,6 +5336,12 @@ components:
5151
5336
  type: boolean
5152
5337
  description: 隠しフィールドである場合true
5153
5338
  nullable: true
5339
+ readonlyOnUi:
5340
+ type: boolean
5341
+ description: |-
5342
+ trueの時、申請者・承認者が画面上から値を入力することを禁止します。
5343
+ ボタン(外部API連携)による代入や、REST API経由での入力はこのオプションの対象外です。
5344
+ nullable: true
5154
5345
  required:
5155
5346
  - id
5156
5347
  - fieldType
@@ -5468,6 +5659,9 @@ components:
5468
5659
  anyOf:
5469
5660
  - $ref: '#/components/schemas/routeStepCondition'
5470
5661
  - nullable: true
5662
+ code:
5663
+ type: string
5664
+ description: コード
5471
5665
  required:
5472
5666
  - id
5473
5667
  - stepOrder
@@ -5481,13 +5675,13 @@ components:
5481
5675
  - allowSelfApproval
5482
5676
  - minCustomAssignees
5483
5677
  - users
5678
+ - code
5484
5679
  routeStepTarget:
5485
5680
  title: RouteStepTarget
5486
5681
  type: object
5487
5682
  properties:
5488
5683
  team:
5489
5684
  $ref: '#/components/schemas/team'
5490
- description: 承認者の指定に使うチーム
5491
5685
  descendants:
5492
5686
  type: boolean
5493
5687
  description: 'stepType=author_customizableまたはstepType=assignee_customizableの場合に、指定したチームの下位チームのメンバーも承認者候補に含めるかどうか(true: 含める、false: 含めない)'
@@ -5524,7 +5718,7 @@ components:
5524
5718
  routeStepConditionFields:
5525
5719
  anyOf:
5526
5720
  - $ref: '#/components/schemas/routeStepConditionField'
5527
- - properties: { }
5721
+ - properties: {}
5528
5722
  routeStepConditionField:
5529
5723
  title: RouteStepConditionField
5530
5724
  type: object
@@ -5543,6 +5737,14 @@ components:
5543
5737
  fieldKey:
5544
5738
  type: string
5545
5739
  description: 変数のフィールド
5740
+ enum:
5741
+ - author_grade
5742
+ - author_team
5743
+ - text_variable
5744
+ - number_variable
5745
+ - checkbox_variable
5746
+ - general_master_variable
5747
+ - other_variable
5546
5748
  symbol:
5547
5749
  type: string
5548
5750
  description: 演算子
@@ -5669,6 +5871,18 @@ components:
5669
5871
  - forcedPublicType
5670
5872
  - workflow
5671
5873
  - labels
5874
+ ticketWithStep:
5875
+ allOf:
5876
+ - $ref: '#/components/schemas/ticket'
5877
+ - type: object
5878
+ properties:
5879
+ steps:
5880
+ type: array
5881
+ description: ステップの配列
5882
+ items:
5883
+ $ref: '#/components/schemas/ticketStep'
5884
+ required:
5885
+ - steps
5672
5886
  ticketDetail:
5673
5887
  title: TicketDetail
5674
5888
  x-tags:
@@ -6062,6 +6276,21 @@ components:
6062
6276
  description: '入力値: 汎用マスタアイテム'
6063
6277
  items:
6064
6278
  $ref: '#/components/schemas/generalMasterItem'
6279
+ users:
6280
+ type: array
6281
+ description: '入力値: ユーザー'
6282
+ items:
6283
+ $ref: '#/components/schemas/user'
6284
+ teams:
6285
+ type: array
6286
+ description: '入力値: チーム'
6287
+ items:
6288
+ $ref: '#/components/schemas/team'
6289
+ inputTickets:
6290
+ type: array
6291
+ description: '入力値: チケット'
6292
+ items:
6293
+ $ref: '#/components/schemas/ticket'
6065
6294
  attachments:
6066
6295
  type: array
6067
6296
  description: 添付ファイル
@@ -6096,7 +6325,7 @@ components:
6096
6325
  color:
6097
6326
  type: string
6098
6327
  description: 'ラベルの色。#なしHEXコード(例: ff0000)'
6099
- pattern: '^[a-f0-9]{6}$'
6328
+ pattern: ^[a-f0-9]{6}$
6100
6329
  minLength: 6
6101
6330
  maxLength: 6
6102
6331
  createdAt:
@@ -6147,7 +6376,7 @@ components:
6147
6376
  - id
6148
6377
  - code
6149
6378
  - name
6150
- - description
6379
+ - notes
6151
6380
  - createdAt
6152
6381
  - updatedAt
6153
6382
  ticketViewer:
@@ -6237,22 +6466,3 @@ components:
6237
6466
  type: http
6238
6467
  scheme: bearer
6239
6468
  description: Personal Access Token or Service Account Token
6240
- servers:
6241
- - url: 'https://api.kickflow.com/v1'
6242
- description: kickflow REST API v1
6243
- tags:
6244
- - name: ユーザー
6245
- - name: 役職
6246
- - name: 代理申請
6247
- - name: 代理承認
6248
- - name: 組織図
6249
- - name: チーム
6250
- - name: カテゴリ
6251
- - name: フォルダ
6252
- - name: 経路
6253
- - name: ワークフロー
6254
- - name: チケット
6255
- - name: ファイル
6256
- - name: 汎用マスタ
6257
- - name: 管理者ロール
6258
- - name: コメント