マイルストーン(milestone)

マイルストーンに関する情報の登録・更新・取得・削除ができます。

シートのidの取得にはSearch APIが使用できます。

マイルストーン取得

必要な権限

マイルストーン参照

Request

URL

https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/milestone/{id}

HTTP Method

GET

Parameter

Path Parameter

No.	パラメータ	必須	タイプ	デフォルト値	説明
1	tenant	○	string	-	テナントID
2	id	○	string	-	対象レコードID

マイルストーン登録

必要な権限

マイルストーン登録

Request

URL

https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/milestone

HTTP Method

POST

Parameter

Path Parameter

No.	パラメータ	必須	タイプ	デフォルト値	説明
1	tenant	○	string	-	テナントID

Request Body

No.	プロパティ名	必須	項目名	タイプ	備考
1	tasks.milestone.milestone_name		マイルストーン名	string
2	tasks.milestone.expected_completion_date		完了(予定)日	string	"yyyy/mm/dd"形式
3	tasks.milestone.memo		メモ	string
4	tasks.milestone.relational_customer		顧客ID	number
5	tasks.milestone.relational_businessplan		案件ID	number
6	tasks.milestone.relational_task		タスクID	array(number)
7	tasks.milestone.relational_employee		担当社員	array(number)
8	tasks.milestone.milestone_status		完了ステータス	string	ステータスマスタの選択肢名。マスタの選択肢取得方法
9	system_reg_date	登録日	string	"yyyy/mm/dd hh:MM"形式
10	system_reg_user	登録ユーザ	number	登録者ユーザID
11	system_reg_employee	登録社員	number	登録社員ID
12	system_upd_date	更新日	string	"yyyy/mm/dd hh:MM"形式
13	system_upd_user	最終更新ユーザ	number	最終更新者ユーザID
14	system_upd_employee	最終更新社員	number	最終更新社員ID

Example

{
  "tasks.milestone.milestone_name": "ヒアリング",
  "tasks.milestone.expected_completion_date": "2024/04/23",
  "tasks.milestone.memo": "メモ",
  "tasks.milestone.relational_customer": 123,
  "tasks.milestone.relational_businessplan": 123,
  "tasks.milestone.relational_task": [
    123
  ],
  "tasks.milestone.relational_employee": [
    123
  ],
  "tasks.milestone.milestone_status": "着手"
}

マイルストーン更新

必要な権限

マイルストーン変更

Request

URL

https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/milestone/{id}

HTTP Method

PUT

Parameter

Path Parameter

No.	パラメータ	必須	タイプ	デフォルト値	説明
1	tenant	○	string	-	テナントID
2	id	○	string	-	対象レコードID

Request Body

No.	プロパティ名	必須	項目名	タイプ	備考
1	tasks.milestone.milestone_name		マイルストーン名	string
2	tasks.milestone.expected_completion_date		完了(予定)日	string	"yyyy/mm/dd"形式
3	tasks.milestone.memo		メモ	string
4	tasks.milestone.relational_customer		顧客ID	number
5	tasks.milestone.relational_businessplan		案件ID	number
6	tasks.milestone.relational_task		タスクID	array(number)
7	tasks.milestone.relational_employee		担当社員	array(number)
8	tasks.milestone.milestone_status		完了ステータス	string	ステータスマスタの選択肢名。マスタの選択肢取得方法

Example

{
  "tasks.milestone.milestone_name": "ヒアリング",
  "tasks.milestone.expected_completion_date": "2024/04/23",
  "tasks.milestone.memo": "メモ",
  "tasks.milestone.relational_customer": 123,
  "tasks.milestone.relational_businessplan": 123,
  "tasks.milestone.relational_task": [
    123
  ],
  "tasks.milestone.relational_employee": [
    123
  ],
  "tasks.milestone.milestone_status": "着手"
}

マイルストーン削除

必要な権限

マイルストーン削除・マイルストーン一括削除

Request

URL

https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/milestone/{id}

HTTP Method

DELETE

Parameter

Path Parameter

No.	パラメータ	必須	タイプ	デフォルト値	説明
1	tenant	○	string	-	テナントID
2	id	○	string	-	対象レコードID

Response

Response Body

Response Bodyはこちらの共通仕様に則っています。

No.	プロパティ名	項目名	タイプ	備考
1	tasks.milestone.id	マイルストーンID	number
2	tasks.milestone.milestone_name	マイルストーン名	string
3	tasks.milestone.expected_completion_date	完了(予定)日	string	"yyyy/mm/dd"形式
4	tasks.milestone.memo	メモ	string
5	tasks.milestone.relational_customer	顧客ID	number
6	tasks.milestone.relational_businessplan	案件ID	number
7	tasks.milestone.relational_task	タスクID	array(number)
8	tasks.milestone.relational_employee	担当社員	array(number)
9	tasks.milestone.milestone_status	完了ステータス	string	ステータスマスタの値

Example

{
  "tasks.milestone.id": 123,
  "tasks.milestone.milestone_name": "ヒアリング",
  "tasks.milestone.expected_completion_date": "2024/04/23",
  "tasks.milestone.memo": "メモ",
  "tasks.milestone.relational_customer": 123,
  "tasks.milestone.relational_businessplan": 123,
  "tasks.milestone.relational_task": [
    123
  ],
  "tasks.milestone.relational_employee": [
    123
  ],
  "tasks.milestone.milestone_status": "着手"
}