タスク(task)

タスクに関する情報の登録・更新・取得・削除ができます。

レコードのidの取得にはSearch APIが使用できます。

タスク取得

必要な権限

タスク参照

Request

URL

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

HTTP Method

GET

Parameter

Path Parameter

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

タスク登録

必要な権限

タスク登録

Request

URL

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

HTTP Method

POST

Parameter

Path Parameter

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

Request Body

No.	プロパティ名	項目名	タイプ	備考
1	tasks.task.priority	優先度	string	優先度マスタの選択肢名マスタ選択肢の取得方法
2	tasks.task.expected_completion_date	完了(予定)日	string	"yyyy/mm/dd"形式
3	tasks.task.task_name	タスク名	string
4	tasks.task.relational_customer	顧客ID	number
5	tasks.task.relational_businessplan	案件ID	number
6	tasks.task.memo	メモ	string
7	tasks.task.is_editable	他ユーザーが変更/削除	boolean
8	tasks.task.status	ステータス	string	ステータスマスタの選択肢名マスタ選択肢の取得方法
9	tasks.task.address	住所	object
	- zipcode	郵便番号	string
	- street	番地	string
	- building	建物	string
10	tasks.task.attached_file	ファイル	object
	- fileid	ファイルID	string	事前にcmsにアップロードしたfileIdを指定
11	tasks.task.publishing_setting	公開設定	string	"公開"もしくは"非公開"
12	tasks.task.relational_employee	担当者	array(number)	担当者の社員ID
13	tasks.task.relational_milestone	マイルストーンID	number
14	tasks.task.outside_manager	社外担当者	array(object)
	- tasks.task.outside_manager @tasks.outside_manager.outside_manager_name	社外担当者名	string	社外担当者である名刺IDを指定する際は、こちらは指定できない
	- tasks.task.outside_manager @tasks.outside_manager.business_card @business_cards.business_card.id	社外担当者である名刺ID	array(number)	社外担当者名を指定する際は、こちらは指定できない
15	拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法	拡張項目	any()	拡張項目を追加する際、アイテムタイプ別定義のページを参照する

Example

{
    "tasks.task.priority": "最優先",
    "tasks.task.expected_completion_date": "2025/05/01",
    "tasks.task.task_name": "資料作成",
    "tasks.task.relational_customer": 123,
    "tasks.task.relational_businessplan": 123,
    "tasks.task.memo": "メモ",
    "tasks.task.is_editable": true,
    "tasks.task.status": "未着手",
    "tasks.task.address": {
        "street": "東京都中央区銀座6-18-2",
        "zipcode": "03-6779-98",
        "building": "野村不動産銀座ビル 11階"
    },
    "tasks.task.attached_file": [
        {
            "fileid": "962e935f1b3c4b9b90b5defce5147ef7"
        }
    ],
    "tasks.task.publishing_setting": "公開",
    "tasks.task.relational_employee": [
        123
    ],
    "tasks.task.relational_milestone": 123,
    "tasks.task.outside_manager": [
        {
            "tasks.task.outside_manager@tasks.outside_manager.business_card@business_cards.business_card.id": [
                456
            ]
        },
        {
            "tasks.task.outside_manager@tasks.outside_manager.business_card@business_cards.business_card.id": [
                789
            ]
        },
        {
            "tasks.task.outside_manager@tasks.outside_manager.outside_manager_name": "上司太郎"
        }
    ]
}

タスク更新

必要な権限

タスク変更

Request

URL

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

HTTP Method

PUT

Parameter

Path Parameter

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

Request Body

No.	プロパティ名	項目名	タイプ	備考
1	tasks.task.priority	優先度	string	優先度マスタの選択肢名マスタ選択肢の取得方法
2	tasks.task.expected_completion_date	完了(予定)日	string	"yyyy/mm/dd"形式
3	tasks.task.task_name	タスク名	string
4	tasks.task.relational_customer	顧客ID	number
5	tasks.task.relational_businessplan	案件ID	number
6	tasks.task.memo	メモ	string
7	tasks.task.is_editable	他ユーザーが変更/削除	boolean
8	tasks.task.status	ステータス	string	ステータスマスタの選択肢名マスタ選択肢の取得方法
9	tasks.task.address	住所	object
	- zipcode	郵便番号	string
	- street	番地	string
	- building	建物	string
10	tasks.task.attached_file	ファイル	object
	- fileid	ファイルID	string	事前にcmsにアップロードしたfileIdを指定
11	tasks.task.publishing_setting	公開設定	string	"公開"もしくは"非公開"
12	tasks.task.relational_employee	担当者	array(number)	担当者の社員ID
13	tasks.task.relational_milestone	マイルストーンID	number
14	tasks.task.outside_manager	社外担当者	array(object)
	- tasks.task.outside_manager @tasks.outside_manager.outside_manager_name	社外担当者名	string	社外担当者である名刺IDを指定する際は、こちらは指定できない。
	- tasks.task.outside_manager @tasks.outside_manager.business_card @business_cards.business_card.id	社外担当者である名刺ID	array(number)	社外担当者名を指定する際は、こちらは指定できない。
15	拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法	拡張項目	any()	拡張項目を追加する際、アイテムタイプ別定義のページを参照する

Example

{
    "tasks.task.priority": "最優先",
    "tasks.task.expected_completion_date": "2025/05/01",
    "tasks.task.task_name": "資料作成",
    "tasks.task.relational_customer": 123,
    "tasks.task.relational_businessplan": 123,
    "tasks.task.memo": "メモ",
    "tasks.task.is_editable": true,
    "tasks.task.status": "対応中",
    "tasks.task.address": {
        "street": "東京都中央区銀座6-18-2",
        "zipcode": "03-6779-98",
        "building": "野村不動産銀座ビル 11階"
    },
    "tasks.task.attached_file": [
        {
            "fileid": "962e935f1b3c4b9b90b5defce5147ef7"
        }
    ],
    "tasks.task.publishing_setting": "公開",
    "tasks.task.relational_employee": [
        123
    ],
    "tasks.task.relational_milestone": 123,
    "tasks.task.outside_manager": [
        {
            "tasks.task.outside_manager@tasks.outside_manager.business_card@business_cards.business_card.id": [
                456
            ]
        },
        {
            "tasks.task.outside_manager@tasks.outside_manager.business_card@business_cards.business_card.id": [
                789
            ]
        },
        {
            "tasks.task.outside_manager@tasks.outside_manager.outside_manager_name": "上司太郎"
        }
    ]
}

タスク削除

必要な権限

タスク削除・タスク一括削除

Request

URL

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

HTTP Method

DELETE

Parameter

Path Parameter

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

Response

Response Body

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

No.	プロパティ名	項目名	タイプ	備考
1	tasks.task.id	タスクID	number
2	tasks.task.priority	優先度	string	優先度マスタの値
3	tasks.task.expected_completion_date	完了(予定)日	string	"yyyy/mm/dd"形式
4	tasks.task.task_name	タスク名	string
5	tasks.task.relational_customer	顧客ID	number
6	tasks.task.relational_businessplan	案件ID	number
7	tasks.task.memo	メモ	string
8	tasks.task.is_editable	他ユーザーが変更/削除	boolean
9	tasks.task.status	ステータス	string	ステータスマスタの値
10	tasks.task.address	住所	object
	- zipcode	郵便番号	string
	- street	番地	string
	- building	建物	string
11	tasks.task.attached_file	ファイル	object
	- fileid	ファイルID	string	取得したfileIdを使って、cmsからファイルをダウンロード可能
	- filename	ファイル名	string
12	tasks.task.publishing_setting	公開設定	string	"公開"もしくは"非公開"
13	tasks.task.relational_employee	担当者	array(number)	担当者の社員ID
14	tasks.task.relational_milestone	マイルストーンID	number
15	tasks.task.outside_manager	社外担当者	array(object)
	- tasks.task.outside_manager @tasks.outside_manager.outside_manager_name	社外担当者名	string	社外担当者である名刺IDと、どちらか一方のみ
	- tasks.task.outside_manager @tasks.outside_manager.business_card @business_cards.business_card.id	社外担当者である名刺ID	array(number)	社外担当者名と、どちらか一方のみ
16	system_reg_date	登録日	string	"yyyy/MM/dd HH:mm"形式 ※取得のみ
17	system_reg_user	登録ユーザー	number	登録者ユーザーID ※取得のみ
18	system_reg_employee	登録社員	number	登録社員ID ※取得のみ
19	system_upd_date	更新日	string	"yyyy/MM/dd HH:mm"形式 ※取得のみ
20	system_upd_user	最終更新ユーザー	number	最終更新者ユーザーID ※取得のみ
21	system_upd_employee	最終更新社員	number	最終更新者社員ID ※取得のみ
22	拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法		拡張項目	any()

Example

{
  "tasks.task.id": 123,
  "tasks.task.priority": "最優先",
  "tasks.task.expected_completion_date": "2024/01/02",
  "tasks.task.task_name": "資料作成",
  "tasks.task.relational_customer": 123,
  "tasks.task.relational_businessplan": 123,
  "tasks.task.memo": "メモ",
  "tasks.task.is_editable": true,
  "tasks.task.status": "完了",
  "tasks.task.address": {
    "street": "東京都中央区銀座6-18-2",
    "zipcode": "03-6779-98",
    "building": "野村不動産銀座ビル 11階"
  },
  "tasks.task.attached_file": [
    {
      "fileid": "e9d21953b1e744668eaded9c7e368180",
      "filename": "資料.pdf"
    }
  ],
  "tasks.task.publishing_setting": "公開",
  "tasks.task.relational_employee": [
    123
  ],
  "tasks.task.relational_milestone": 123,
    "tasks.task.outside_manager": [
        {
            "tasks.task.outside_manager@tasks.outside_manager.business_card@business_cards.business_card.id": [
                456
            ]
        },
        {
            "tasks.task.outside_manager@tasks.outside_manager.business_card@business_cards.business_card.id": [
                789
            ]
        },
        {
            "tasks.task.outside_manager@tasks.outside_manager.outside_manager_name": "上司太郎"
        }
    ]
  "system_reg_date": "2024/01/01 00:00",
  "system_reg_user": 123,
  "system_reg_employee": 456,
  "system_upd_date": "2024/01/02 00:00",
  "system_upd_user": 123,
  "system_upd_employee": 456
}