esmDevelopers
JSプラグイン
esm API
JSプラグイン
esm API
  • マイルストーン(milestone)

マイルストーン(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.パラメータ必須タイプデフォルト値説明
1tenant○string-テナントID
2id○string-対象レコードID

マイルストーン登録

必要な権限

マイルストーン登録

Request

URL

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

HTTP Method

POST

Parameter

Path Parameter
No.パラメータ必須タイプデフォルト値説明
1tenant○string-テナントID
Request Body
No.プロパティ名必須項目名タイプ備考
1tasks.milestone.milestone_nameマイルストーン名string
2tasks.milestone.expected_completion_date完了(予定)日string"yyyy/mm/dd"形式
3tasks.milestone.memoメモstring
4tasks.milestone.relational_customer顧客IDnumber
5tasks.milestone.relational_businessplan案件IDnumber
6tasks.milestone.relational_taskタスクIDarray(number)
7tasks.milestone.relational_employee担当社員array(number)
8tasks.milestone.milestone_status完了ステータスstringステータスマスタの選択肢名。マスタの選択肢取得方法
9system_reg_date登録日string"yyyy/mm/dd hh:MM"形式
10system_reg_user登録ユーザnumber登録者ユーザID
11system_reg_employee登録社員number登録社員ID
12system_upd_date更新日string"yyyy/mm/dd hh:MM"形式
13system_upd_user最終更新ユーザnumber最終更新者ユーザID
14system_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.パラメータ必須タイプデフォルト値説明
1tenant○string-テナントID
2id○string-対象レコードID
Request Body
No.プロパティ名必須項目名タイプ備考
1tasks.milestone.milestone_nameマイルストーン名string
2tasks.milestone.expected_completion_date完了(予定)日string"yyyy/mm/dd"形式
3tasks.milestone.memoメモstring
4tasks.milestone.relational_customer顧客IDnumber
5tasks.milestone.relational_businessplan案件IDnumber
6tasks.milestone.relational_taskタスクIDarray(number)
7tasks.milestone.relational_employee担当社員array(number)
8tasks.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.パラメータ必須タイプデフォルト値説明
1tenant○string-テナントID
2id○string-対象レコードID

Response

Response Body

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

No.プロパティ名項目名タイプ備考
1tasks.milestone.idマイルストーンIDnumber
2tasks.milestone.milestone_nameマイルストーン名string
3tasks.milestone.expected_completion_date完了(予定)日string"yyyy/mm/dd"形式
4tasks.milestone.memoメモstring
5tasks.milestone.relational_customer顧客IDnumber
6tasks.milestone.relational_businessplan案件IDnumber
7tasks.milestone.relational_taskタスクIDarray(number)
8tasks.milestone.relational_employee担当社員array(number)
9tasks.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": "着手"
}