任务
任务对象
属性 | 类型 | 描述 |
---|---|---|
id |
整数 | 任务的唯一ID。 |
的名字 |
字符串 | 任务的名称。 |
billable_by_default |
布尔 | 用于确定在创建新项目时是否应将默认任务标记为可计费。 |
default_hourly_rate |
小数 | 将此任务添加到项目时用于此任务的时薪。 |
is_default |
布尔 | 是否将此任务自动添加到未来的项目。 |
is_active |
布尔 | 此任务是活动的还是存档的。 |
created_at |
datetime | 创建任务的日期和时间。 |
updated_at |
datetime | 任务最后更新的日期和时间。 |
需要的权限
您必须是具有创建和编辑任务权限的管理员或管理员,才能与/ v2 /任务
端点。权限不足将导致403年被禁止的
状态码。
列出所有任务
返回任务列表。任务按创建日期排序返回,最近创建的任务出现在前面。
响应包含一个对象任务
属性,该属性包含最多到的数组per_page
任务。数组中的每个条目都是一个单独的任务对象。如果没有更多可用的任务,则生成的数组将为空。响应中包含了几个额外的分页属性,以简化任务的分页。
获得/ v2 /任务
参数 | 类型 | 描述 |
---|---|---|
is_active |
布尔 | 通过真正的 仅返回活动任务和假 返回非活动的任务。 |
updated_since |
datetime | 只返回自给定日期和时间以来更新过的任务。 |
页面 |
整数 | 在分页中使用的页码。例如,如果您提出一个列表请求并收到2000条记录,您的后续呼叫可以包括页面= 2 检索列表的下一页。(默认值:1) |
per_page |
整数 | 每页要返回的记录数。取值范围为1 ~ 2000。(默认:2000) |
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/tasks" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"
示例响应:
{“任务”:【{“id”:8083800,“名称”:“业务发展”,“billable_by_default”:假,“default_hourly_rate”:0.0,“is_default”:假,“is_active”:真正的,“created_at”:“2017 - 06 - 26 t22:08:25z”,“updated_at”:“2017 - 06 - 26 t22:08:25z”},{“id”:8083369,“名称”:“研究”,“billable_by_default”:假,“default_hourly_rate”:0.0,“is_default”:真正的,“is_active”:真正的,“created_at”:“2017 - 06 - 26 t20:41:00z”,“updated_at”:“2017 - 06 - 26 t21:53:34z”},{“id”:8083368,“名称”:“项目管理”,“billable_by_default”:真正的,“default_hourly_rate”:100.0,“is_default”:真正的,“is_active”:真正的,“created_at”:“2017 - 06 - 26 t20:41:00z”,“updated_at”:“2017 - 06 - 26 t21:14:10z”},{“id”:8083366,“名称”:“编程”,“billable_by_default”:真正的,“default_hourly_rate”:100.0,“is_default”:真正的,“is_active”:真正的,“created_at”:“2017 - 06 - 26 t20:41:00z”,“updated_at”:“2017 - 06 - 26 t21:14:07z”},{“id”:8083365,“名称”:“平面设计”,“billable_by_default”:真正的,“default_hourly_rate”:100.0,“is_default”:真正的,“is_active”:真正的,“created_at”:“2017 - 06 - 26 t20:41:00z”,“updated_at”:“2017 - 06 - 26 t21:14:02z”}),“per_page”:2000,“total_pages”:1,“total_entries”:5,“next_page”:零,“previous_page”:零,“页面”:1,“链接”: {“第一”:“https://api.bob客服端下载harvestapp.com/v2/tasks?page=1&per_page=2000”,“下一个”:零,“以前”:零,“最后一次”:“https://api.bob客服端下载harvestapp.com/v2/tasks?page=1&per_page=2000”}}
检索任务
检索具有给定ID的任务。返回一个任务对象和200好了
提供有效标识符时的响应代码。
GET / v2 /任务/ {TASK_ID}
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/tasks/8083800" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"
示例响应:
{“id”:8083800,“名称”:“业务发展”,“billable_by_default”:假,“default_hourly_rate”:0.0,“is_default”:假,“is_active”:真正的,“created_at”:“2017 - 06 - 26 t22:08:25z”,“updated_at”:“2017 - 06 - 26 t22:08:25z”}
创建任务
创建一个新的任务对象。返回一个任务对象和201年创建
调用成功时的响应代码。
POST / v2 /任务
参数 | 类型 | 要求 | 描述 |
---|---|---|---|
的名字 |
字符串 | 要求 | 任务的名称。 |
billable_by_default |
布尔 | 可选 | 用于确定在创建新项目时是否应将默认任务标记为可计费。默认为真正的 . |
default_hourly_rate |
小数 | 可选 | 将此任务添加到项目时用于此任务的默认时薪。默认为0 . |
is_default |
布尔 | 可选 | 是否将此任务自动添加到未来的项目。默认为假 . |
is_active |
布尔 | 可选 | 此任务是活动的还是存档的。默认为真正的 . |
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/tasks" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -X POST \ -H "Content-Type: application/json" \ -d '{"name":"新任务名称","hourly_rate":120.0}'
示例响应:
{“id”:8083782,“名称”:“新任务名称”,“billable_by_default”:真正的,“default_hourly_rate”:0,“is_default”:假,“is_active”:真正的,“created_at”:“2017 - 06 - 26 t22:04:31z”,“updated_at”:“2017 - 06 - 26 t22:04:31z”}
更新任务
通过设置传递的参数值更新特定任务。任何未提供的参数将保持不变。返回一个任务对象和200好了
调用成功时的响应代码。
补丁/ v2 /任务/ {TASK_ID}
参数 | 类型 | 描述 |
---|---|---|
的名字 |
字符串 | 任务的名称。 |
billable_by_default |
布尔 | 用于确定在创建新项目时是否应将默认任务标记为可计费。 |
default_hourly_rate |
小数 | 将此任务添加到项目时用于此任务的默认时薪。 |
is_default |
布尔 | 是否将此任务自动添加到未来的项目。 |
is_active |
布尔 | 此任务是活动的还是存档的。 |
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/tasks/8083782" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -X PATCH \ -H "Content-Type: application/json" \ -d '{"is_default":true}'
示例响应:
{“id”:8083782,“名称”:“新任务名称”,“billable_by_default”:真正的,“default_hourly_rate”:0,“is_default”:真正的,“is_active”:真正的,“created_at”:“2017 - 06 - 26 t22:04:31z”,“updated_at”:“2017 - 06 - 26 t22:04:54z”}
删除任务
删除任务。只有当任务没有与之关联的时间项时,才可以删除任务。返回一个200好了
调用成功时的响应代码。
删除/ v2 /任务/ {TASK_ID}
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/tasks/8083782" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -x删除