バージョン 1 - 履歴 - Rest TimeEntries - r-labs

1

Mitsuyoshi Yoshida

redmine.org の "Rest_TimeEntries":http://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries の日本語訳です。

2

3

{{>toc}}

4

5

6

h1. REST 作業時間の記録

7

8

h2. 作業時間データの一覧

9

10

  GET /time_entries.xml

11

12

作業時間データのリストを取得します。

13

14

15

h2. 作業時間データの表示

16

17

  GET /time_entries/[id].xml

18

19

ID で指定した作業時間データを取得します。

20

21

22

h2. 作業時間データの作成(作業時間の記録)

23

24

  POST /time_entries.xml

25

26

作業時間データを作成します。

27

28

+要素+:

29

30

* @time_entry@ (必須): 以下の子要素を持ちます。

31

32

  * @issue_id@ or @project_id@ (一方だけを必ず指定): 作業時間の対象となるチケットまたはプロジェクトの ID

33

  * @spent_on@: 作業した時の日付 (デフォルトでは今日の日付)

34

  * @hours@ (必須): 作業時間(時間単位)

35

  * @activity_id@: 作業分類の ID。 このパラメーターはデフォルトの作業分類が指定されていなければ必須です。

36

  * @comments@: 作業に対するコメント。(255 文字以内)

37

38

+レスポンス+:

39

40

  * @201 Created@: 作業時間データは作成されました。

41

  * @422 Unprocessable Entity@: 妥当性の検証でエラーが発生し、作業時間データの作成に失敗しました。

42

    (レスポンスの中身はエラーメッセージです。)

43

44

h2. 作業時間の更新

45

46

  PUT /time_entries/[id].xml

47

48

指定した ID の作業時間データを更新します。

49

50

51

+ 要素 +:

52

53

* @time_entry@ (必須): 作成時と同じ子要素を持ちます。

54

55

56

+Response+:

57

58

  * @201 OK@: 作業時間データは更新されました。

59

  * @422 Unprocessable Entity@: 妥当性の検証でエラーが発生し、作業時間データの更新に失敗しました。

60

    (レスポンスの中身はエラーメッセージです。)

61

62

h2. 作業時間データの削除

63

64

  DELETE /time_entries/[id].xml

65

66

指定した ID の作業時間データを削除します。

プロジェクト

全般

プロフィール

r-labs

Rest TimeEntries » 履歴 » バージョン 1