vwin徳赢登录CLIMED API.

通过使用Cnimivwin徳赢登录fy的基于REST的API,您可以将数据推送和从频贴,并将其与其他系统集成。随意发布您的任何问题堆栈溢出与之vwin徳赢登录标签,或联系我们如果某些东西不能正常工作。

要通过API获取报告,您将必须使用基本端点进行报告(其与用于操纵其他对象的一个​​不同)。

身份验证

所有的请求都应该包含“X-Api-Key”在请求头,包含您的API密匙

如果您的工作空间在子域(例如。你将需要在你的配置文vwin徳赢登录件设置中生成一个新的API密钥,它将为那个工作空间工作。

如果您是一个自主的用户,您必须使用不同的API基本端点:“https://yourcustomdomain.com/api”和“https://yourdomain.com/reports”(您可以找到精确的转到“https://youdomain.com/web/boot”时端点。

速度限制

速率限制为每秒10个请求。如果你超过了限制,你会得到“太多的请求”错误。

API示例

看例子在各种编程语言中调用休息vwin徳赢登录API(并添加您自己的示例)。

更改日志

5月10日,2021年
  • 在用户对象中添加了丢失的costrate
  • 为GET用户增加了inclueroles查询参数(返回用户和用户是manager的项目)
2021年3月31日
  • 在详细报告响应中增加了缺少的clientId
  • 新终端:打造的补丁时间条目
12月23日,2020年12月23日
  • 通过Webhook返回的API请求的新标题参vwin徳赢登录数“Clockify-Action-Metadata”
2020年12月14日
  • 增加预算和成本率对项目响应
  • 新终点:更新项目估计(时间或预算)
11月9日,2020年11月9日
  • 增加了报告的时区参数
  • 共享报告现在使用TimeFormat,DateFormat,WeepStart保存
2020年8月28日
  • 新的端点:获取项目上的自定义字段
  • 新端点:更新项目上的自定义字段
  • 新终端:从项目中删除自定义字段
  • 新的webhook事件类型:Me/Anyone
2020年7月9日
  • 请求更新:update时间条目可以接受Customfields.
  • 新终端:获取自定义字段
  • 新终端:获得共享报告
  • 新的端点:CREATE Shared report
  • 新终端:更新共享报告
  • 新端点:DELETE Shared report
  • 新端点:生成共享报告
  • 新的端点:UPDATE Project成员关系
2020年7月2日
  • 请求更新:update Project可以接受每小时收费
  • 新的端点:UPDATE Tag
  • 新终端:删除标记
  • 新的端点:UPDATE Client
  • 新的端点:DELETE Client
  • 新终端:添加工作区用户
  • 新的端点:DELETE Workspace用户
  • 新终点:更新工作区用户的状态
  • 新的端点:CREATE Group
  • 新的端点:DELETE Group
  • 新终端:更新组名称
  • 新端点:ADD User to group
  • 新终端:从组中删除用户
2020年6月17日
  • 新终端:汇总报告
  • 新端点:POST详细报告
  • 新端点:POST周报
4月22日,2020年4月
  • 新终端:按ID获取项目
  • 新终端:更新项目
  • 新的端点:UPDATE Project模板
  • 新端点:GET Task by ID
  • 新终点:更新任务
  • 新终端:删除任务
  • 新端点:按ID获取时间条目
  • 新终端:获取组
  • 新参数:GET客户端现在可以拥有分类列排序
  • 新参数:Get标签现在可以拥有分类列,排序
  • 新参数:GET用户现在可以拥有分类列,排序
  • 新参数:GET项目现在可以拥有计费,客户,包含客户机,用户,包含 - 用户,是模板,分类列,排序
  • 请求更新:创建时间条目现在可以拥有Customfields.;它没有持久用户标识,timeInterval,Workspaceid.,被锁住了
  • 响应更新:GET Time条目现在也返回自定义VielfValues.
  • 响应更新:GET Projects现在也返回笔记,模板
  • 响应更新:GET客户机现在也返回存档
  • 响应更新:GET标签现在也返回存档
  • 响应更新:GET标签现在也返回存档
  • 响应更新:GET Workspace现在也返回isprojectpublicbydefault.,canSeeTracker,德赢vwin官网下载特点订阅
API基本端点
https://api.vwin徳赢登录www.bicisol.com/api/v1.
报告的API基本端点
https://reports.api.vwin徳赢登录www.bicisol.com/v1.
示例请求
-H "content-type: application/json" -H "X-Api-Key: yourAPIkeyvwin徳赢登录
服务条款:https://vwin徳赢登录clocify.me/terms.

Webhooks.

webhook可以在Clockify中发生某事时通知你的应用。vwin徳赢登录您可以访问Webhooks.从您的个人资料设置底部

只有工作空间管理员可以创建webhook。只有创建webhook的用户才能看到和修改它。每个用户每个工作空间最多可以有10个webhook,一个工作空间总共可以有100个

单击您创建的Webhook,您可以看到已发送的Webhook的日志。在那里,您可以发送测试Webhook。删除超过7天的日志。

您可以通过单击Webhook的眼睛图标Webhooks页面找到您的Webhook的签名秘密(或打开Webhook的编辑屏幕)。然后,要使用签名秘密验证WebHook,请将其与响应标头中的“聊天签名”值进行比较。vwin徳赢登录

您可以通过API请求标头发送vwin徳赢登录“Clockify-Action-Metadata”参数,其值将通过它触发的Webhook事件传递。示例:您可以在标题中发送“更新时间条目”请求并传递“Clockify-Action-Metadata:myRequestId123”vwin徳赢登录,并且当触发“时间条目更新”Webhook时,您将收到“Clockify-Action-Metadata:MyRequestId123“在Webhook中,以免避免无休止的更新循环。

要测试和调试Webhooks,您可以使用在线服务请求捕手

有用的Webhooks时序vwin徳赢登录

  • 计时器开始/停止(我/人)
  • 时间条目手动/更新/删除(ME / ANY)
  • 工作区上创建的客户/项目/任务/标记

客户

用于操纵客户端资源的端点

在工作空间中找到客户端

得到 /工作区/ {workspaceId} /客户
存档:布尔基
在查询

如果为true,则只需存档的客户端即可。如果为false,您将只得到活动的客户端。

名称:细绳
在查询

如果提供的话,客户端将按名称过滤

页:整数1
在查询

页面大小:整数50.
在查询

页面大小

排序列:细绳
在查询

名称

排序:细绳
在查询

升序降序

200好了

好的

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
[{“id”:“5 b1e52ff0cb8792ed75992c1”,“名称”:“客户x”,“Workspaceid”:“5 c0fe3290cl84304845dbf1f”,“存档”:“假”})

将新客户端添加到工作区

帖子 /工作区/ {workspaceId} /客户
请求内容类型:应用/ JSON.
请求示例
{“名称”:“客户端”}
201年创建

创造了

400错误请求

Workspace中具有该名称的客户端

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(201创建)
{“id”:“5 b1e52ff0cb8792ed75992c1”,“名称”:“客户端”,“Workspaceid”:“5 c0fe3290cl84304845dbf1f”}

更新客户端

/ workspaces / {workspaceid} / clients / {clientId}
archive-projects:布尔基
在查询

控制归档客户端是否会导致归档给定客户端的所有项目

请求内容类型:应用/ JSON.
请求示例
{“存档”:错误的,“名称”:“客户端”}
200好了

好的

201年创建

创造了

400错误请求

坏的请求

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
{“存档”:真的,“id”:“5 bf6d2b9b079876a34621638”,“名称”:“客户端”,“Workspaceid”:“5 bfd36c4b0798777049512e3”}

删除客户端

删除 / workspaces / {workspaceid} / clients / {clientId}
200好了

好的

204没有内容

没有内容

400错误请求

坏的请求

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
{“存档”:真的,“id”:“5 bf6d2b9b079876a34621638”,“名称”:“客户端”,“Workspaceid”:“5 bfd36c4b0798777049512e3”}

项目

用于操纵项目资源的端点

在工作空间中获得所有项目

得到 / workspaces / {workspaceid} /项目
存档:布尔基
在查询

如果为true,则只需存档项目。如果为false,您只会获得活动项目。

名称:细绳
在查询

如果提供的话,项目将按名称过滤。

页:整数1
在查询

页面大小:整数50.
在查询

页面大小

可以计费:布尔基
在查询

如果提供的话,项目将通过可计费的状态进行过滤。

客户:数组
在查询

如果提供,项目将通过客户端ID进行筛选。

包含 - 客户端:布尔基
在查询

如果提供的话,将通过客户提供项目来过滤。

客户端状态:细绳
在查询

可能的值:活动,存档

用户:数组
在查询

如果提供的话,将通过访问权限的用户ID过滤项目。

contains-users:布尔基
在查询

如果提供,项目将根据它们是否有用户进行筛选。

用户状态:细绳
在查询

可能的值:活动,无效

是模板:布尔基
在查询

如果提供的话,将通过是否用作模板来过滤项目。

排序列:细绳
在查询

可能的值:名称,client_name,持续时间。

排序:细绳
在查询

可能的值:升序,降序。

200好了

好的

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
[{“id”:“5E4E42156FE9056CFB00252”,“名称”:”项目”,“每小时收费”:空值,“clientId”:”“,“Workspaceid”:“5E4E38CAQ7668C16662B303A”,“计费”:真的,“会员资格”:[{“标识”:“5A0AB5ACB2D987125438B60F”,“每小时收费”:空值,“targetId”:“5 e4e38f156fe9056cfb00252”,“会员资格型”:”项目”,“成员地区”:“积极“}]“颜色”:“# 4 caf50”,“估计”:{“估计”:“PT0S”,“类型”:“汽车”},//遗留字段,与timeStimate相同“存档”:错误的,“期间”:“PT0S”,“客户名称”:”“,“注意”:”“,“模板”:错误的,“上市”:错误的,“costrate”:空值,“BudgateStimate”:空值,“纪念日”:{“估计”:“PT0S”,“类型”:“汽车”,“resetOption”:空值,“积极的”:真的}}]

通过ID查找项目

得到 / workspaces / {workspaceid} / projects / {projectid}
200好了

好的

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
{“id”:“5E4E42156FE9056CFB00252”,“名称”:”项目”,“每小时收费”:空值,“clientId”:”“,“Workspaceid”:“5E4E38CAQ7668C16662B303A”,“计费”:真的,“会员资格”:[{“标识”:“5A0AB5ACB2D987125438B60F”,“每小时收费”:空值,“targetId”:“5 e4e38f156fe9056cfb00252”,“会员资格型”:”项目”,“成员地区”:“积极“}]“颜色”:“# 4 caf50”,“估计”:{“估计”:“PT0S”,“类型”:“汽车”},//遗留字段,与timeStimate相同“存档”:错误的,“期间”:“PT0S”,“客户名称”:”“,“注意”:”“,“模板”:错误的,“上市”:错误的,“costrate”:空值,“BudgateStimate”:空值,“纪念日”:{“估计”:“PT0S”,“类型”:“汽车”,“resetOption”:空值,“积极的”:真的}}

为工作区添加一个新项目

帖子 / workspaces / {workspaceid} /项目
请求内容类型:应用/ JSON.
请求示例
{“名称”:“我的API项目”, // 可选的“clientId”:”“,“isPublic”:“假”,“颜色”:“# f44336”,“注意”:“这是项目的音符”,“计费”:“真的”,“上市”:错误的}
201年创建

创造了

400错误请求

工作区上已存在该名称的项目。

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(201创建)
{“存档”:“假”,“计费”:“真的”,“clientId”:”“,“客户名称”:”“,“颜色”:“字符串”,“期间”:“PT0S”,“估计”:{“估计”:“PT0S”,“类型”:“手动的”},//遗留字段,与timeStimate相同“每小时收费”:{“数量”:“0”,“货币”:“美元”},“id”:“5 b1e6b160cb8793dd93ec120”,“会员资格”:[{“每小时收费”:{“数量”:“10”,“货币”:“美元”},“成员地区”:“积极的”,“会员资格型”:“项目”,“targetId”:“5 b1e6b160cb8793dd93ec120”,“标识”:“5A9E9A39B079874A74CFA980”}],“名称”:“我的API项目”,“上市”:错误的,“costrate”:空值,“BudgateStimate”:空值,“纪念日”:{“估计”:“PT0S”,“类型”:“汽车”,“resetOption”:空值,“积极的”:真的},“Workspaceid”:“5 b152d9b0cb8797f86cbe14f”,}

在工作区上更新项目

/ workspaces / {workspaceid} / projects / {projectid}
估计类型

手动类型启用整个项目的固定估计。自动类型启用基于任务的项目估算。如果启用了自动,则估计持续时间无关紧要。

请求内容类型:应用/ JSON.
请求示例
{“名称”:“我的API项目”,“clientId”:”“,“isPublic”:“假”,“估计”:{“估计”:“PT1H0M0S”,“类型”:“手动的”},//遗留字段,与timeStimate相同“每小时收费”:{“数量”:3600},“颜色”:“# f44336”,“注意”:“这是项目的说明(可选)”,“计费”:“真的”,“存档”:“真的”}
201年创建

创造了

400错误请求

工作区上已存在该名称的项目。

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(201创建)
{“存档”:“假”,“计费”:“真的”,“clientId”:”“,“客户名称”:”“,“颜色”:“字符串”,“期间”:“PT0S”,“估计”:{“估计”:“PT1H0M0S”,“类型”:“手动的”},“每小时收费”:{“数量”:“0”,“货币”:“美元”},“id”:“5 b1e6b160cb8793dd93ec120”,“会员资格”:[{“每小时收费”:{“数量”:“10”,“货币”:“美元”},“成员地区”:“积极的”,“会员资格型”:“项目”,“targetId”:“5 b1e6b160cb8793dd93ec120”,“标识”:“5A9E9A39B079874A74CFA980”}],“名称”:“我的API项目”,“上市”:错误的,“costrate”:空值,“BudgateStimate”:空值,“纪念日”:{“估计”:“PT1H0M0S”,“类型”:“手动的”,“resetOption”:空值,“积极的”:空值},“Workspaceid”:“5 b152d9b0cb8797f86cbe14f”}

更新项目评估

修补 /工作区/ / {projectId} / {workspaceId} /项目估算
活跃的

选择估计是否有时间或预算。两个中只有一个可以活跃。如果您需要“无估计”,则发送空“{}”请求,或将两个活动字段设置为false。

重置

选择是否估计每月重置。取值范围:null和MONTHLY

类型

可能的值:MANUAL(用于评估整个项目)和AUTO(用于启用基于任务的评估)

请求内容类型:应用/ JSON.
请求示例
{“纪念日”:{“估计”:“PT1H0M0S”,“类型”:“手动的”,“积极的”:错误的,“resetOption”:每月},“BudgateStimate”:{“估计”:1100,“类型”:“手动的”,“积极的”:真的,“resetOption”:空值}}
200好了

好的

400错误请求

一次只能激活一种类型的评估。

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(201创建)
{“存档”:“假”,“计费”:“真的”,“clientId”:”“,“客户名称”:”“,“颜色”:“字符串”,“期间”:“PT0S”,“估计”:{“估计”:“PT1H0M0S”,“类型”:“汽车”},“每小时收费”:{“数量”:“0”,“货币”:“美元”},“id”:“5 b1e6b160cb8793dd93ec120”,“会员资格”:[{“每小时收费”:{“数量”:“10”,“货币”:“美元”},“成员地区”:“积极的”,“会员资格型”:“项目”,“targetId”:“5 b1e6b160cb8793dd93ec120”,“标识”:“5A9E9A39B079874A74CFA980”}],“名称”:“我的API项目”,“上市”:错误的,“costrate”:空值,“BudgateStimate”:{“估计”:1100,“类型”:“手动的”,“resetOption”:每月,“积极的”:真的},“纪念日”:{“估计”:“PT0S”,“类型”:“汽车”,“resetOption”:空值,“积极的”:错误的},“Workspaceid”:“5 b152d9b0cb8797f86cbe14f”}

更新项目成员资格

修补 /工作区/ {workspaceId} /项目/ {projectId} /会员
请求内容类型:应用/ JSON.
请求示例
{“会员资格”:[{“标识”:“5EF31421F9F6228D72D8833”,(可以是组ID或用户ID)“每小时收费”:{“数量”:2000年} (可选的) } ] }
200好了

好的

400错误请求

用户或组不是此工作区的成员。

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(201创建)
{“存档”:“假”,“计费”:“真的”,“clientId”:”“,“客户名称”:”“,“颜色”:“字符串”,“期间”:“PT0S”,“估计”:{“估计”:“PT1H0M0S”,“类型”:“汽车”},“每小时收费”:{“数量”:“0”,“货币”:“美元”},“id”:“5 b1e6b160cb8793dd93ec120”,“会员资格”:[{“标识”:“5EF31421F9F6228D72D8833”,(可以是groupID或UserID)“每小时收费”:{“数量”:2000年,“货币”:“美元”},“targetId”:“5EFEE823462F493D3BC08302”,(项目ID)“会员资格型”:“项目”,“成员地区”:“积极的”}],“名称”:“我的API项目”,“上市”:“假”,“costrate”:空值,“BudgateStimate”:空值,“纪念日”:{“估计”:“PT0S”,“类型”:“汽车”,“resetOption”:空值,“积极的”:真的},“Workspaceid”:“5 b152d9b0cb8797f86cbe14f”}

更新项目模板

修补 / workspaces / {workspaceid} / projects / {projectID} /模板
请求内容类型:应用/ JSON.
请求示例
{“istemplate”:“真的”}
201年创建

创造了

400错误请求

工作区上已存在该名称的项目。

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(201创建)
{“存档”:“假”,“计费”:“真的”,“clientId”:”“,“客户名称”:”“,“颜色”:“字符串”,“期间”:“PT0S”,“估计”:{“估计”:“PT1H0M0S”,“类型”:“汽车”},“每小时收费”:{“数量”:“0”,“货币”:“美元”},“id”:“5 b1e6b160cb8793dd93ec120”,“会员资格”:[{“每小时收费”:{“数量”:“10”,“货币”:“美元”},“成员地区”:“积极的”,“会员资格型”:“项目”,“targetId”:“5 b1e6b160cb8793dd93ec120”,“标识”:“5A9E9A39B079874A74CFA980”}],“名称”:“我的API项目”,“上市”:“假”,“上市”:错误的,“costrate”:空值,“BudgateStimate”:空值,“纪念日”:{“估计”:“PT0S”,“类型”:“汽车”,“resetOption”:空值,“积极的”:真的},“Workspaceid”:“5 b152d9b0cb8797f86cbe14f”}

从工作区删除项目

删除 / workspaces / {workspaceid} / projects / {id}
200好了

好的

204没有内容

没有内容

400错误请求

未找到指定id的项目

401未经授权

未经授权的

403禁止

禁忌

响应内容类型:* / *
反应示例(200 OK)
{“存档”:“假”,“计费”:“真的”,“clientId”:”“,“客户名称”:”“,“颜色”:“字符串”,“期间”:“PT0S”,“估计”:{“估计”:“PT1H0M0S”,“类型”:“汽车”},“每小时收费”:{“数量”:“0”,“货币”:“美元”},“id”:“5 b1e6b160cb8793dd93ec120”,“会员资格”:[{“每小时收费”:{“数量”:“10”,“货币”:“美元”},“成员地区”:“积极的”,“会员资格型”:“项目”,“targetId”:“5 b1e6b160cb8793dd93ec120”,“标识”:“5A9E9A39B079874A74CFA980”}],“名称”:“我的API项目”,“上市”:“假”,“上市”:错误的,“costrate”:空值,“BudgateStimate”:空值,“纪念日”:{“估计”:“PT0S”,“类型”:“汽车”,“resetOption”:空值,“积极的”:真的},“Workspaceid”:“5 b152d9b0cb8797f86cbe14f”}

标签

用于操作TAG资源的端点

在工作空间中查找标签

得到 /工作区/ {workspaceId} /标记
名称:细绳
在查询

如果提供,标记将按名称进行筛选。

存档:布尔基
在查询

如果为true,则只需存档标记。如果为false,则只会获得活动标签。

页:整数1
在查询

页面大小:整数50.
在查询

页面大小

200好了

好的

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
[{“id”:“5 a7c5d2db079870147fra234”,“名称”:“标签1”,“Workspaceid”:“5G3G57BT0CB2548E22E6L9CD”,“存档”:“假”})

向工作空间添加一个新标记

帖子 /工作区/ {workspaceId} /标记
请求内容类型:应用/ JSON.
请求示例
{“名称”:“标签1”}
201年创建

创造了

400错误请求

具有该名称的标记已经存在于工作空间中

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(201创建)
{“id”:“5 a7c5d2db079870147fra234”,“名称”:“标签1”,“Workspaceid”:“5G3G57BT0CB2548E22E6L9CD”}

更新标记

/工作区/ {workspaceId} /标签/ {tagId}
请求内容类型:应用/ JSON.
请求示例
{“存档”:错误的,“名称”:“标签”}
200好了

好的

201年创建

创造了

400错误请求

坏的请求

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
{“存档”:真的,“id”:“5 bf6d2b9b079876a34621638”,“名称”:“标签”,“Workspaceid”:“5 bfd36c4b0798777049512e3”}

删除标签

删除 /工作区/ {workspaceId} /标签/ {tagId}
200好了

好的

204没有内容

没有内容

400错误请求

坏的请求

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
{“存档”:真的,“id”:“5 bf6d2b9b079876a34621638”,“名称”:“标签”,“Workspaceid”:“5 bfd36c4b0798777049512e3”}

任务

用于操纵任务资源的端点

查找项目上的任务

得到 / workspaces / {workspaceid} / projects / {projectId} /任务
活跃:布尔基
在查询

如果提供和true,则将返回仅活动任务。否则只会返回完成任务。

名称:细绳
在查询

如果提供,任务将按名称过滤。

页:整数1
在查询

页面大小:整数50.
在查询

页面大小

200好了

好的

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
[{“受让人”:[“593E40AAB0798735D0392A2D”],“估计”:“PT0S”,“id”:“5 b1e6b160cb8793dd93ec120”,“名称”:“任务1”,“ProjectID”:“5B1667790CB8797321F3D664”,“计费”:“真的”,“地位”:“积极的”(状态:活动,完成)}]

通过ID找到项目上的任务

得到 / workspaces / {workspaceid} / projects / {projectid} /任务/ {taskId}
200好了

好的

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
{“受让人”:[“593E40AAB0798735D0392A2D”],“估计”:“PT0S”,“id”:“5 b1e6b160cb8793dd93ec120”,“名称”:“任务1”,“ProjectID”:“5B1667790CB8797321F3D664”,“计费”:“真的”,“地位”:“积极的”(状态:活动,完成)}

在项目上添加新任务

帖子 / workspaces / {workspaceid} / projects / {projectId} /任务
请求内容类型:应用/ JSON.
请求示例
{“名称”:“任务1”, // 可选的“受让人”:[“593E40AAB0798735D0392A2D”],“估计”:“pt2h”,“地位”:“积极的”(做活动)}
201年创建

创造了

400错误请求

项目中已存在的任务,或项目中已存在,或指定的项目不存在

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(201创建)
{“受让人”:[“593E40AAB0798735D0392A2D”],“估计”:“pt2h”,“id”:“5 b1e6b160cb8793dd93ec120”,“名称”:“任务1”,“ProjectID”:“5B1667790CB8797321F3D664”,“计费”:“真的”,“地位”:“积极的”}

项目上更新任务

/ workspaces / {workspaceid} / projects / {projectid} /任务/ {taskId}
请求内容类型:应用/ JSON.
请求示例
{“名称”:“任务1”,“受让人”:[“593E40AAB0798735D0392A2D”],“估计”:“pt2h”,“计费”:“真的”,“地位”:“积极的”(做活动)}
201年创建

创造了

400错误请求

项目中已存在的任务,或项目中已存在,或指定的项目不存在

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(201创建)
{“受让人”:[“593E40AAB0798735D0392A2D”],“估计”:“pt2h”,“id”:“5 b1e6b160cb8793dd93ec120”,“名称”:“任务1”,“ProjectID”:“5B1667790CB8797321F3D664”,“计费”:“真的”,“地位”:“积极的”}

从项目中删除任务

删除 / workspaces / {workspaceid} / projects / {projectid} /任务/ {taskId}
200好了

好的

204没有内容

没有内容

400错误请求

未找到指定id的项目

401未经授权

未经授权的

403禁止

禁忌

响应内容类型:* / *
反应示例(200 OK)
{“受让人”:[“593E40AAB0798735D0392A2D”],“估计”:“pt2h”,“id”:“5 b1e6b160cb8793dd93ec120”,“名称”:“任务1”,“ProjectID”:“5B1667790CB8797321F3D664”,“计费”:“真的”,“地位”:“完成”}

时间输入

用于操纵TimeEntry资源的端点

获取工作区上的时间条目

在Workspace上获取指定用户的时间条目。过滤器可以应用为下面列出的查询参数

得到 / workspaces / {workspaceid} / user / {userid} /时间条目

需要Workspace_own或workspace_admin权限以查看其他用户的时间条目。

描述:细绳
在查询

如果提供,将通过描述过滤时间条目。

开始:细绳
在查询

如果提供,则只返回在指定datetime之后开始的时间项。Datetime必须是ISO-8601格式。“2019 - 04 - 16 - t05:15:32.998z”)。您根据您的帐户的时区发送时间(从配置文件设置),并获得响应与UTC时间。

结尾:细绳
在查询

如果提供,则只返回在指定datetime之前开始的时间项。Datetime必须是ISO-8601格式。2019 - 04 - 16 t05:15:32.998z”)。您根据您的帐户的时区发送时间(从配置文件设置),并获得响应与UTC时间。

项目:细绳
在查询

如果提供,时间条目将按项目进行过滤。

任务:细绳
在查询

如果提供,将按任务过滤时间条目。

标签:细绳[]
在查询

如果提供,时间条目将通过标签进行过滤。这个参数是一个标签id的数组。

数组值作为多个参数传递:= tagId_1&tags = tagId_2 ?标签
项目要求:布尔基1
在查询

如果提供的话,只返回与项目的时间条目。

任务要求:布尔基1
在查询

如果提供的话,只返回具有任务的时间条目。

考虑持续时间格式:布尔基
在查询

如果提供,返回的时间条目的持续时间将从工作空间设置中根据持续时间格式(hh:mm或hh:mm:ss)舍入为分钟或秒。

水分:布尔基
在查询

如果提供,返回的时间条目的项目,任务和标签将全部返回,而不仅仅是他们的id。注意,如果您请求水合实体版本,projectId、taskId和tagIds将在请求响应中更改为项目、任务和标签。

正在进行:布尔基
在查询

如果提供,将忽略所有其他筛选器,如果提供,将返回当前运行时条目。

页:整数1
在查询

页面大小:整数50.
在查询

页面大小

200好了

好的

400错误请求

具有给定ID的用户不存在

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
[{“计费”:“真的”,“描述”:“写文档”,“id”:“5B0FDF2A0CB87904845DFER5”,“isLocked”:“假”,“ProjectID”:“5B1667790CB8797321F3D664”,“tagIds”:[“5 a7c5d2db079870147fra234”),“taskId”:“5 b1e6b160cb8793dd93ec120”,“timeInterval”:{“期间”:“pt1m4s”,“结束”:“2018-06-12T14:01:41Z”,“开始”:“2018-06-12T14:00:37Z”},“标识”:“6H1E49BF0CB8790E43D6C9AB”,“Workspaceid”:“5G3G57BT0CB2548E22E6L9CD”},“customfields”:[{“customfieldid”:“5 b1e6b160cb8793dd93ec120”,“timeEntryId”:“5C5BDA4FB079871C518B6F07”,“价值”:“旧金山”,“名称”:“地点”}]]]

获取工作空间上的特定时间条目

得到 /工作区/ {workspaceId} / time-entries / {id}
考虑持续时间格式:布尔基
在查询

如果提供,返回的时间条目的持续时间将从工作空间设置中根据持续时间格式(hh:mm或hh:mm:ss)舍入为分钟或秒。

水分:布尔基
在查询

如果提供,返回的时间条目的项目,任务和标签将全部返回,而不仅仅是他们的id。注意,如果您请求水合实体版本,projectId、taskId和tagIds将在请求响应中更改为项目、任务和标签。

200好了

好的

400错误请求

具有给定ID的时间条目不存在

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
{“计费”:“真的”,“描述”:“写文档”,“id”:“5B0FDF2A0CB87904845DFER5”,“isLocked”:“假”,“ProjectID”:“5B1667790CB8797321F3D664”,“tagIds”:[“5 a7c5d2db079870147fra234”),“taskId”:“5 b1e6b160cb8793dd93ec120”,“timeInterval”:{“期间”:“pt2m”,“结束”:“2018-06-12T13:50:14Z”,“开始”:“2018 - 06 - 12 t13:48:14z”},“标识”:“6H1E49BF0CB8790E43D6C9AB”,“Workspaceid”:“5G3G57BT0CB2548E22E6L9CD”,“customfields”:[{“customfieldid”:“5 b1e6b160cb8793dd93ec120”,“timeEntryId”:“5C5BDA4FB079871C518B6F07”,“价值”:“旧金山”,“名称”:“地点”}]}

为工作区添加新的时间条目

如果未在请求中发送结束,则表示秒表模式是活动的,否则手动添加时间条目。

“start”是这个请求中唯一的强制字段。

帖子 / workspaces / {workspaceid} / time-centries
请求内容类型:应用/ JSON.
请求示例
{“开始”:“2018-06-12T13:48:14.000Z”,“计费”:“真的”,“描述”:“写文档”,“ProjectID”:“5B1667790CB8797321F3D664”,“taskId”:“5 b1e6b160cb8793dd93ec120”,“结束”:“2018-06-12T13:50:14.000Z”,“tagIds”:[“5 a7c5d2db079870147fra234”),“customfields”:[{“customfieldid”:“5 b1e6b160cb8793dd93ec120”,“价值”:“旧金山”}]}
201年创建

创造了

400错误请求

项目//标记不存在或不属于工作区;任务不存在或不属于项目;开始日期时间是结束日期时间之后;时间条目需要其他信息(检查工作区设置);

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(201创建)
{“计费”:“真的”,“描述”:“写文档”,“id”:“5B0FDF2A0CB87904845DFER5”,“isLocked”:“假”,“ProjectID”:“5B1667790CB8797321F3D664”,“tagIds”:[“5 a7c5d2db079870147fra234”),“taskId”:“5 b1e6b160cb8793dd93ec120”,“timeInterval”:{“期间”:“pt2m”,“结束”:“2018 - 06 - 12 t13:48:14z”,“开始”:“2018-06-12T13:50:14Z”},“标识”:“6H1E49BF0CB8790E43D6C9AB”,“Workspaceid”:“5G3G57BT0CB2548E22E6L9CD”,“customfields”:[{“customfieldid”:“5 b1e6b160cb8793dd93ec120”,“timeEntryId”:“5C5BDA4FB079871C518B6F07”,“价值”:“旧金山”,“名称”:“地点”}]}

为工作区上的其他用户添加新的时间条目

为他人增加时间是一种付费功能。此API端点仅适用于具有活动付费订阅的工作区。

您可以在请求的POST路径中指定为哪个用户添加时间。

如果你忽略了结束时间,你会为那个人启动一个计时器。要停止计时器,你必须使用"PUT /workspace /{workspaceId}/time-entries/{timeEntryId}/end" PATH(请求示例:{"end":"2019-02-07T14:00:07.000Z"})

帖子 / workspaces / {workspaceid} / user / {userid} /时间条目
请求内容类型:应用/ JSON.
请求示例
{“开始”:“2018-06-12T13:48:14.000Z”,“计费”:“真的”,“描述”:“写文档”,“ProjectID”:“5B1667790CB8797321F3D664”,“taskId”:“5 b1e6b160cb8793dd93ec120”,“结束”:“2018-06-12T13:50:14.000Z”,“tagIds”:[“5 a7c5d2db079870147fra234”),“customfields”:[{“customfieldid”:“5 b1e6b160cb8793dd93ec120”,“价值”:“旧金山”}]}
201年创建

创造了

400错误请求

项目/标签/用户不存在或不属于工作区;任务不存在或不属于项目;开始日期时间是结束日期日期之后;时间条目需要其他信息(检查工作区设置)

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(201创建)
{“计费”:“真的”,“描述”:“写文档”,“id”:“5B0FDF2A0CB87904845DFER5”,“isLocked”:“假”,“ProjectID”:“5B1667790CB8797321F3D664”,“tagIds”:[“5 a7c5d2db079870147fra234”),“taskId”:“5 b1e6b160cb8793dd93ec120”,“timeInterval”:{“期间”:“pt2m”,“结束”:“2018-06-12T13:50:14Z”,“开始”:“2018 - 06 - 12 t13:48:14z”},“标识”:“6H1E49BF0CB8790E43D6C9AB”,“Workspaceid”:“5G3G57BT0CB2548E22E6L9CD”,“customfields”:[{“customfieldid”:“5 b1e6b160cb8793dd93ec120”,“timeEntryId”:“5C5BDA4FB079871C518B6F07”,“价值”:“旧金山”,“名称”:“地点”}]}

停止工作空间上当前运行的计时器

管理员可以在付费工作区上阻止别人的运行计时器(为其他特征添加时间)。

如果工作区具有启用必填字段(例如,则启用Timesheet并项目是结果),则无法停止计时器,直到填写必填字段。您将简单地获取“未创建实体”消息。

修补 / workspaces / {workspaceid} / user / {userid} /时间条目
请求内容类型:应用/ JSON.
请求示例
{“结束”:“2018-06-12T14:01:41Z”}
200好了

好的

204没有内容

没有内容

400错误请求

当前运行的时间条目上不存在所需信息。检查工作区设置。

401未经授权

未经授权的

403禁止

禁忌

404没有找到

在Workspace上找不到目前正在运行的时间条目

响应内容类型:* / *
反应示例(200 OK)
{“计费”:“真的”,“描述”:“编写文档更新”,“id”:“5B0FDF2A0CB87904845DFER5”,“isLocked”:“假”,“ProjectID”:“5B1667790CB8797321F3D664”,“tagIds”:[“5 a7c5d2db079870147fra234”),“taskId”:“5 b1e6b160cb8793dd93ec120”,“timeInterval”:{“期间”:“pt1m4s”,“结束”:“2018-06-12T14:01:41Z”,“开始”:“2018-06-12T14:00:37Z”},“标识”:“6H1E49BF0CB8790E43D6C9AB”,“Workspaceid”:“5G3G57BT0CB2548E22E6L9CD”,“customfields”:[{“customfieldid”:“5 b1e6b160cb8793dd93ec120”,“timeEntryId”:“5C5BDA4FB079871C518B6F07”,“价值”:“旧金山”,“名称”:“地点”}]}

更新工作空间上的时间条目

/工作区/ {workspaceId} / time-entries / {id}
请求内容类型:应用/ JSON.
请求示例
{“开始”:“2018-06-12T14:00:37Z”,“计费”:“真的”,“描述”:“编写文档更新”,“ProjectID”:“5B1667790CB8797321F3D664”,“taskId”:“5 b1e6b160cb8793dd93ec120”,“结束”:“2018-06-12T14:01:41Z”,“tagIds”:[“5 a7c5d2db079870147fra234”),“customfields”:[{“customfieldid”:“5 b1e6b160cb8793dd93ec120”,“timeEntryId”:“5C5BDA4FB079871C518B6F07”,“价值”:“旧金山”,“名称”:“地点”}]}
200好了

好的

201年创建

创造了

400错误请求

项目/标签不存在或不属于工作区;任务不存在或不属于项目;开始DateTime是结束日期时间之后

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
{“计费”:“真的”,“描述”:“写文档更新了”,“id”:“5B0FDF2A0CB87904845DFER5”,“isLocked”:“假”,“ProjectID”:“5B1667790CB8797321F3D664”,“tagIds”:[“5 a7c5d2db079870147fra234”),“taskId”:“5 b1e6b160cb8793dd93ec120”,“timeInterval”:{“期间”:“pt1m4s”,“结束”:“2018-06-12T14:01:41Z”,“开始”:“2018-06-12T14:00:37Z”},“标识”:“6H1E49BF0CB8790E43D6C9AB”,“Workspaceid”:“5G3G57BT0CB2548E22E6L9CD”,“customfields”:[{“customfieldid”:“5 b1e6b160cb8793dd93ec120”,“timeEntryId”:“5C5BDA4FB079871C518B6F07”,“价值”:“旧金山”,“名称”:“地点”}]}

在发票上标出工时条目

修补 / workspaces / {workspaceid} /时间条目/发票
请求内容类型:应用/ JSON.
请求示例
{“timeentryids”:[“5A7C5D2DB079870147FRA134”),“发票”:真的}
200好了

好的

400错误请求

坏的请求

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

从工作区删除时间条目

删除 /工作区/ {workspaceId} / time-entries / {id}
204没有内容

没有内容

400错误请求

具有给定ID的时间条目不存在或不属于工作区

401未经授权

未经授权的

403禁止

禁忌

响应内容类型:* / *

用户

用于操纵用户资源的端点

获取当前登录的用户信息

得到 /用户
200好了

好的

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
{“activeWorkspace”:“592E9E48B0798735D03919EE”,“defaultworkspace”:“592E9E48B0798735D03919EE”,“电子邮件”:“email@test.com”,“id”:“5 bfd36c4b0798777049512e2”,“会员资格”:[{“每小时收费”:{“数量”:“500”,“货币”:“美元”},“costrate”:{“数量”:“100”,“货币”:“美元”},“成员地区”:“积极的”,“会员资格型”:“工作区”,“targetId”:“5 bfd36c4b0798777049512e3”,“标识”:“5 bfd36c4b0798777049512e2”}],“名称”:“用户名”,“profilepicture”:“https://s3.eu -中央- 1. amazonaws.com/clvwin徳赢登录ockify/no -用户- image.png”,“设置”:{“pollapaleallprojectlists”:“假”,“dashboardPinToTop”:“假”,“dashboardselection”:“我”,“dashboardviewtype”:“货物”,“日期格式”:“mm / dd / yyyy”,“isCompactviewon”:“假”,“longrunning”:“假”,“projectListCollapse”:空值,“sendNewsletter”:“假”,“sumpualleportsettings”:{“团体”:“项目”,(组:项目,客户端,用户,标签,时间条目,任务)“群”:“时间输入”(子组:项目,客户端,用户,标签)},“时间格式”:“HOUR12”,“timeTrackingManual”:“假”,“时区”:“欧洲/贝尔格莱德”,“周末”:“周一”,“weeklyUpdates”:“假”},“地位”:“积极的”}

查找工作区上的所有用户

得到 /工作区/ {workspaceId} /用户
页:整数1
在查询

页面大小:整数50.
在查询

页面大小

会员:细绳
在查询

如果提供,您将获得所有用户以及他们可以访问的工作空间,组或项目。可能的值:Workspace,Project,UserGroup,All(默认),无(仅获取有关工作空间上用户的基本数据)。

电子邮件:细绳
在查询

如果提供,您将获得一个经过筛选的用户列表,其中在其电子邮件地址中包含所提供的字符串。

ProjectID:细绳
在查询

如果提供的话,您将获得有权访问该项目的用户列表。

名称:细绳
在查询

如果提供的话,您将获得包含其名称中提供的字符串的过滤的用户列表。

状态:细绳
在查询

如果提供的话,您将获得具有相应状态的过滤的用户列表。可能的值:待处理,主动,拒绝,无效

排序列:细绳
在查询

取值包括:EMAIL、NAME、HOURLYRATE

排序:细绳
在查询

可能的值:升序,降序

IncludeRoles:布尔基
在查询

如果您通过IncludeRoles = True,您将获得每个用户的详细经理角色(包括项目和众所周知的项目)

数组值作为多个参数传递:?电子邮件= @gmail和会员资格= none&page-size = 100&status =活动
200好了

好的

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
[{“activeWorkspace”:“592E9E48B0798735D03919EE”,“defaultworkspace”:“592E9E48B0798735D03919EE”,“电子邮件”:“email@test.com”,“id”:“5 bfd36c4b0798777049512e2”,“会员资格”:[{“每小时收费”:{“数量”:“500”,“货币”:“美元”},“costrate”:{“数量”:“100”,“货币”:“美元”},“成员地区”:“积极的”,“会员资格型”:“工作区”,“targetId”:“5 bfd36c4b0798777049512e3”,“标识”:“5 bfd36c4b0798777049512e2”}],“名称”:“用户名”,“profilepicture”:“https://s3.eu -中央- 1. amazonaws.com/clvwin徳赢登录ockify/no -用户- image.png”,“设置”:{“pollapaleallprojectlists”:“假”,“dashboardPinToTop”:“假”,“dashboardselection”:“我”,“dashboardviewtype”:“货物”,“日期格式”:“mm / dd / yyyy”,“isCompactviewon”:“假”,“longrunning”:“假”,“projectListCollapse”:空值,“sendNewsletter”:“假”,“sumpualleportsettings”:{“团体”:“项目”,(组:项目,客户端,用户,标签,时间条目,任务)“群”:“时间输入”(子组:项目,客户端,用户,标签)},“时间格式”:“HOUR12”,“timeTrackingManual”:“假”,“时区”:“欧洲/贝尔格莱德”,“周末”:“周一”,“weeklyUpdates”:“假”},“地位”:“积极的”,“角色”:[{“角色”:“PROJECT_MANAGER”,“实体”:[{“id”:“5 f8ec3833f2109522c00966a”,“名称”:“我的项目1”}]}, {“角色”:团队经理”,“实体”:[{“id”:“6G8EC3833F2109522C00966A”,“名称”:“玛丽史密斯”}]}]}

将用户添加到工作区

只有当该工作区具有付费订阅时,您只能将用户添加到工作空间。如果工作区有付费订阅,则可以根据需要添加尽可能多的用户,但您受到该工作空间上的付费用户座位数量的限制。

帖子 /工作区/ {workspaceId} /用户
请求内容类型:应用/ JSON.
请求示例
{“电子邮件”:“example@email.com”}
200好了

好的

201年创建

创造了

400错误请求

坏的请求

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
{“id”:“5G3G57BT0CB2548E22E6L9CD”,“imageUrl”:“字符串”,“会员资格”:[{“每小时收费”:{“数量”:15.},“costrate”:{“数量”:空值},“成员地区”:“积极的”,“会员资格型”:“工作区”,“targetId”:“5G3G57BT0CB2548E22E6L9CD”,“标识”:“5H1E49BF0CB8790E43D6C9AB”}],“名称”:“vwin徳赢登录Clockify工作区”,“workspaceSettings”:{“AdminallyPages”:[“字符串”),“automaticLock”:{“换土”:“周三”,“dayOfMonth”:13.,“第一天”:“星期六”,“olderThanPeriod”:“天”,“olderThanValue”:14.,“类型”:“更老”},“canseetimesheet”:真的,“canSeeTracker”:真的,“defaultbillableprojects”:真的,“forceDescription”:真的,“forceProjects”:真的,“forceTags”:真的,“forcetasks”:真的,“isprojectpublicbydefault”:“假”,“lockTimeEntries”:“2019 - 01 - 31 - t23:00:00z”,“outceadminscreateproject”:真的,“overtanminscreateTag”:“假”,“outdmminscreateTask”:真的,“唯一的蒙迪斯塞利特利”:真的,“onlyAdminsSeeBillableRates”:真的,“唯一的是minsseedashboard”:真的,“outdsadminsseepublicprojectsentries”:真的,“projectfavorites”:真的,“ProjectGroupingLabel”:“部门”,“projectPickerSpecialFilter”:真的,“圆形的”:{“分钟”:15.,“圆形的”:“舍入到”},“timeroundinginreports”:真的,“tracktimedowntosecond”:真的}}

更新用户的工作空间状态

/ workspaces / {workspaceid} / users / {userid}
请求内容类型:应用/ JSON.
请求示例
{“成员地区”:“不活跃”(活动,无效)}
200好了

好的

201年创建

创造了

400错误请求

坏的请求

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
{“id”:“5G3G57BT0CB2548E22E6L9CD”,“imageUrl”:“字符串”,“会员资格”:[{“每小时收费”:{“数量”:15.},“costrate”:{“数量”:“100”},“成员地区”:“积极的”,“会员资格型”:“工作区”,“targetId”:“5G3G57BT0CB2548E22E6L9CD”,“标识”:“5H1E49BF0CB8790E43D6C9AB”}],“名称”:“vwin徳赢登录Clockify工作区”,“workspaceSettings”:{“AdminallyPages”:[“字符串”),“automaticLock”:{“换土”:“周三”,“dayOfMonth”:13.,“第一天”:“星期六”,“olderThanPeriod”:“天”,“olderThanValue”:14.,“类型”:“更老”},“canseetimesheet”:真的,“canSeeTracker”:真的,“defaultbillableprojects”:真的,“forceDescription”:真的,“forceProjects”:真的,“forceTags”:真的,“forcetasks”:真的,“isprojectpublicbydefault”:“假”,“lockTimeEntries”:“2019 - 01 - 31 - t23:00:00z”,“outceadminscreateproject”:真的,“overtanminscreateTag”:“假”,“outdmminscreateTask”:真的,“唯一的蒙迪斯塞利特利”:真的,“onlyAdminsSeeBillableRates”:真的,“唯一的是minsseedashboard”:真的,“outdsadminsseepublicprojectsentries”:真的,“projectfavorites”:真的,“ProjectGroupingLabel”:“部门”,“projectPickerSpecialFilter”:真的,“圆形的”:{“分钟”:15.,“圆形的”:“舍入到”},“timeroundinginreports”:真的,“tracktimedowntosecond”:真的}}

从工作区中删除用户

删除 / workspaces / {workspaceid} / users / {userid}
200好了

好的

204没有内容

没有内容

400错误请求

坏的请求

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *

团体

操纵组资源的端点

在工作空间中找到所有组

得到 /工作区/ {workspaceId} /用户组
页:整数1
在查询

页面大小:整数50.
在查询

页面大小

ProjectID:细绳
在查询

projectId

名称:细绳
在查询

名称

排序:细绳
在查询

升序降序

排序列:细绳
在查询

名称

200好了

好的

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
[{“id”:“5A0B0C2C307987125438B903”,“名称”:“管理员”,“Workspaceid”:“5 a0b01dcb07987125438b902”,“userids”:[“5A0AB5ACB07987125438B60F”,“599 b90jnb0798723decee4f0”,“5 a1d311db079872b2a7b5a2f”]

将新组添加到工作区

帖子 /工作区/ {workspaceId} /用户组
请求内容类型:应用/ JSON.
请求示例
{“名称”:“我的组”}
201年创建

创造了

400错误请求

具有该名称的标记已经存在于工作空间中

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(201创建)
{“id”:“5 a7c5d2d2079870147fra234”,“名称”:“我的组”,“Workspaceid”:“5G3G57BT0CB2548E22E6L9CD”}

更新组名称

/ workspaces / {workspaceid} / user-group / {usergroupid}
请求内容类型:应用/ JSON.
请求示例
{“名称”:“团体”}
200好了

好的

201年创建

创造了

400错误请求

坏的请求

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
{“id”:“5 bf6d2b9b079876a34621638”,“名称”:“团体”,“userids”:[“字符串”),“Workspaceid”:“5 bfd36c4b0798777049512e3”}

删除组

删除 / workspaces / {workspaceid} / user-group / {usergroupid}
200好了

好的

204没有内容

没有内容

400错误请求

坏的请求

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
{“id”:“5 bf6d2b9b079876a34621638”,“名称”:“团体”,“userids”:[“5 b23d2b9b079876a34621638”),“Workspaceid”:“5 bfd36c4b0798777049512e3”}

将用户添加到组

帖子 / workspaces / {workspaceid} / user-groups / {usergroudid} /用户
请求内容类型:应用/ JSON.
请求示例
{“标识”:“5BF6D2B9B079876A34621635”}
200好了

好的

201年创建

创造了

400错误请求

坏的请求

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
{“id”:“5 bf6d2b9b079876a34621638”,“名称”:“团体”,“userids”:[“5 b23d2b9b079876a34621638”),“Workspaceid”:“5 bfd36c4b0798777049512e3”}

从组中删除用户

删除 /工作区/ {workspaceId} /用户组/ {userGroupId} /用户/ {userId}
200好了

好的

204没有内容

没有内容

400错误请求

坏的请求

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
{“id”:“5 bf6d2b9b079876a34621638”,“名称”:“团体”,“userids”:[“5 b23d2b9b079876a34621638”),“Workspaceid”:“5 bfd36c4b0798777049512e3”}

工作区

操作WORKSPACE资源的端点

获得所有工作空间

得到 /工作空间
200好了

好的

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
[{“每小时收费”:{“数量”:“0”,“货币”:“美元”},“id”:“5G3G57BT0CB2548E22E6L9CD”,“imageUrl”:“https://s3.eu-central-1.amazonaws.com/test/workspaceimg.png”,“会员资格”:[{“每小时收费”:{“数量”:“15”,“货币”:“美元”},“成员地区”:“积极的”,“会员资格型”:“工作区”,“targetId”:“5G3G57BT0CB2548E22E6L9CD”,“标识”:“6H1E49BF0CB8790E43D6C9AB”}],“名称”:“vwin徳赢登录Clockify工作区”,“workspaceSettings”:{“AdminallyPages”: [],“automaticLock”:{“换土”:“周三”,“dayOfMonth”:“13”,“第一天”:“周一”,“olderThanPeriod”:“天”,“olderThanValue”:“14”,“类型”:“更老”},“canseetimesheet”:“假”,“canSeeTracker”:“真的”,“defaultbillableprojects”:“真的”,“forceDescription”:“真的”,“forceProjects”:“真的”,“forceTags”:“假”,“forcetasks”:“假”,“lockTimeEntries”:“2019 - 01 - 31 - t23:00:00z”,“outceadminscreateproject”:“假”,“overtanminscreateTag”:“假”,“outdmminscreateTask”:“真的”,“唯一的蒙迪斯塞利特利”:“真的”,“onlyAdminsSeeBillableRates”:“假”,“唯一的是minsseedashboard”:“假”,“outdsadminsseepublicprojectsentries”:“假”,“projectfavorites”:“真的”,“ProjectGroupingLabel”:“客户端”,“projectPickerSpecialFilter”:“假”,“圆形的”:{“分钟”:“15”,“圆形的”:“舍入到”},“timeroundinginreports”:“真的”,“tracktimedowntosecond”:“假”,“isprojectpublicbydefault”:“假”,“canSeeTracker”:“假”,“德赢vwin官网下载特征资料”:“Enterprise_year”})

自定义字段

用于操纵自定义字段资源的端点。有关在时间条目上管理自定义字段,请使用端点操作TimeEntry资源。

获取工作区上的自定义字段

得到 /工作区/ {workspaceId} /定制字段
名称:细绳
在查询
状态:细绳
在查询

无效,可见,无形

200好了

好的

400错误请求

不存在

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
[{“id”:“kn0fdf2a0cb87904845dfer5”,“Workspaceid”:“5B0FDF2A0CB87904845DFER5”,“名称”:“地点”,“描述”:“工作发生地。”,“类型”:“dropdown_single”(txt,number,dropdown_single,dropdown_multiple,checkbox,链接)“占位符”:“选择位置......”,“允许值”:[“旧金山”,“北京”,“巴黎”),“workspacedefaultvalue”:“旧金山”,“onlyAdminCanEdit”:“真的”,“地位”:“不活跃”,(不活跃的,可见的,不可见的)“projectDefaultValues”:[{“projectId:“450fdf2a0cb8​​7904845dfer5”,“价值:“北京”,“地位:“可见的”(非活动,可见,隐形)}]]}]

获取项目上的自定义字段

得到 / workspaces / {workspaceid} / projects / {projectID} / custom-fields
名称:细绳
在查询

状态:细绳
在查询

无效,可见,无形

200好了

好的

400错误请求

不存在

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
[{“id”:“kn0fdf2a0cb87904845dfer5”,“Workspaceid”:“5B0FDF2A0CB87904845DFER5”,“名称”:“地点”,“描述”:“工作发生地。”,“类型”:“dropdown_single”(txt,number,dropdown_single,dropdown_multiple,checkbox,链接)“占位符”:“选择位置......”,“允许值”:[“旧金山”,“北京”,“巴黎”),“workspacedefaultvalue”:“旧金山”,“onlyAdminCanEdit”:“真的”,“地位”:“不活跃”,(不活跃的,可见的,不可见的)“projectDefaultValues”:[{“projectId:“450fdf2a0cb8​​7904845dfer5”,“价值:“北京”,“地位:“可见的”(非活动,可见,隐形)}]]}]

在项目上更新自定义字段

修补 / workspaces / {workspaceid} / projects / {projectID} / custom-field / {customfieldIdid}
请求内容类型:应用/ JSON.
请求示例
{“defaultValue”:“旧金山”,“地位”:“无形的”(inactive, visible, invisible)}
201成功

成功

400错误请求

项目中已存在的任务,或项目中已存在,或指定的项目不存在

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(201成功)
{“id”:“kn0fdf2a0cb87904845dfer5”,“Workspaceid”:“5B0FDF2A0CB87904845DFER5”,“名称”:“地点”,“描述”:“工作发生地。”,“类型”:“dropdown_single”(txt,number,dropdown_single,dropdown_multiple,checkbox,链接)“占位符”:“选择位置......”,“允许值”:[“旧金山”,“北京”,“巴黎”),“workspacedefaultvalue”:“旧金山”,“onlyAdminCanEdit”:“真的”,“地位”:“不活跃”,(不活跃的,可见的,不可见的)“projectDefaultValues”:[{“projectId:“450fdf2a0cb8​​7904845dfer5”,“价值:“旧金山”,“地位:“无形的”(非活动,可见,隐形)}]}}

从项目中删除自定义字段

删除 / workspaces / {workspaceid} / projects / {projectID} / custom-field / {customfieldIdid}
200好了

好的

400错误请求

不存在

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:* / *
反应示例(200 OK)
{“id”:“kn0fdf2a0cb87904845dfer5”,“Workspaceid”:“5B0FDF2A0CB87904845DFER5”,“名称”:“地点”,“描述”:“工作发生地。”,“类型”:“dropdown_single”(txt,number,dropdown_single,dropdown_multiple,checkbox,链接)“占位符”:“选择位置......”,“允许值”:[“旧金山”,“北京”,“巴黎”),“workspacedefaultvalue”:“旧金山”,“onlyAdminCanEdit”:“真的”,“地位”:“不活跃”,(不活跃的,可见的,不可见的)“projectDefaultValues”:[]}

举报

用于操纵报告资源的端点。

要获得不同格式的报告,您需要在每个POST请求的exportType中指定它(可能的值:JSON、CSV、XLSX、PDF)。

报告的API基本端点
https://reports.api.vwin徳赢登录www.bicisol.com/v1.

总结报告

帖子 / workspaces / {workspaceid} /报告/摘要
“统一”中的“统一梦想”

可能的值:项目,客户端,任务,标签,日期,用户,USER_GROUP,时间条目

“somequiparyfilter”中的“sortcolumn”

取值范围:GROUP、DURATION、AMOUNT

“夸张”

可能的值:Hide_Amount,获得,成本,利润

“exportType”

可能的值:JSON,CSV,XLSX,PDF

“排序”

可能的值:升序,降序

在任何过滤器中“包含”(标签除外)

包含,DOES_NOT_CONTAIN

标签过滤器中的“ContedIntimeEntry”

包含,contain_only,do_not_contain

任何过滤器中的“状态”

项目,客户,标签:全部,活动,存档
用户:所有,活动,不活动
任务:全部,活动,完成

“时区”

如果您不包含TimeZone,则配置文件设置中的时区将用于请求和响应。如果您包含TimeZone,则根据您指定的时区发送和接收时间。

请求内容类型:应用/ JSON.
请求示例
{/ /要求“datterangestart”:“2020-05-10T00:00:00.000”,“daterangeend”:“2020 - 05 - 16 - t23:59:59.000”,“摘要梦想”:{“组织”:[“用户”,“项目”,“TIMEENTRY”//设置(可选)“sortcolumn”:“集团”},“排序”:“降序”,“exportType”:“JSON”,“四舍五入”:错误的,“夸张”:“赚取”,“时区”:“美国/ Los_Angeles”,//过滤器(可选)“用户”:{“ids”:[“45FD36C4B0798777049512E2”),“包含”:“包含”,“地位”:“所有”},“用户组”: 空值,“客户”: 空值,“项目”: 空值,“任务”: 空值,“标签”:{“ids”:[“45FD36C4B0798777049512E2”),“constainedIntimeEntry”:“DOES_NOT_CONTAIN”,“地位”:“所有”},“计费”:真的,“描述”:”“,“没有DEDescription”:真的,“customfields”:[{“id”:“5 bfd36c4b0798777049512e2”,“价值”:30.,“类型”:“数量”“numpercondition”:“平等的”“空的”:“假”}]}
400错误请求

坏的请求

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:应用/ JSON.
请求示例
{“总计”:[{“totalTime”:3600,“totalbillabletime”:3600,“entriesCount”:1,“总金额”:750.00}],“groupone”:[{“_ID”:“5 bfd36c4b0798777049512e2”,“期间”:3600,“数量”:750.00,“名称”:“用户”“孩子”:[“_ID”:“2020-05-15”,“期间”:3600,“数量”:750.00,“名称”:“2020-05-15”,“孩子”:[“_ID”:“5 eb9244d5440c74ec17850db”,“期间”:3600,“数量”:750.00,“名称”:“我的条目描述”,]]}]}

详细的报告

帖子 /工作区/ {workspaceId} / /详细报告
在“sortColumn detailedFilter”

取值范围:ID、描述、用户、持续时间、日期

“夸张”

可能的值:Hide_Amount,获得,成本,利润

“exportType”

可能的值:JSON,CSV,XLSX,PDF

“sortcolumn”

取值范围:GROUP、DURATION、AMOUNT

“排序”

可能的值:升序,降序

在任何过滤器中“包含”(标签除外)

包含,DOES_NOT_CONTAIN

标签过滤器中的“ContedIntimeEntry”

包含,contain_only,do_not_contain

任何过滤器中的“状态”

项目,客户,标签:全部,活动,存档
用户:所有,活动,不活动
任务:全部,活动,完成

“pageize”在“详细漂亮”中

最大的值:200

“时区”

如果您不包含TimeZone,则配置文件设置中的时区将用于请求和响应。如果您包含TimeZone,则根据您指定的时区发送和接收时间。

请求内容类型:应用/ JSON.
请求示例
{/ /要求“datterangestart”:“2020-05-10T00:00:00.000”,“daterangeend”:“2020 - 05 - 16 - t23:59:59.000”,“详细漂亮”:{“页”:1,“页大小”:50., //设置(可选)“sortcolumn”:“日期”“auditFilter”:{“withoutProject”:真的,“没有摊位”:真的,“期间”:3600,“杜兰特霍尔斯”:真的}},“排序”:“降序”,“exportType”:“JSON”,“四舍五入”:错误的,“夸张”:“赚取”,“时区”:“美国/ Los_Angeles”,//过滤器(可选)“用户”:{“ids”:[“45FD36C4B0798777049512E2”),“包含”:“包含”,“地位”:“所有”},“用户组”: 空值,“客户”: 空值,“项目”: 空值,“任务”: 空值,“标签”:{“ids”:[“45FD36C4B0798777049512E2”),“constainedIntimeEntry”:“DOES_NOT_CONTAIN”,“地位”:“所有”},“计费”:真的,“描述”:”“,“没有DEDescription”:真的,“customfields”:[{“id”:“5 bfd36c4b0798777049512e2”,“价值”:30.,“类型”:“数量”“numpercondition”:“平等的”“空的”:“假”}]}
400错误请求

坏的请求

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:应用/ JSON.
请求示例
{“总计”:[{“totalTime”:3600,“totalbillabletime”:3600,“entriesCount”:1,“总金额”:750.00}],“timeentries”:[{“_ID”:“5E56518286d6ae2aface01fc”,“描述”:“我的条目描述”,“标识”:“5 bfd36c4b0798777049512e2”,“计费”:真的,“taskId”:空值,“ProjectID”:空值,“clientId”:空值,“timeInterval”:{“开始”:“2020 - 05 - 15 - t08:00:00”,“结束”:“2020-05-15T09:00:00”,“期间”:3600,},“approverrequestid”:“5FF589BBAEDBBE170A50B033”,“taskName”:“发展”,“标签”:[],“isLocked”:错误的,“customfields”:[{“customfieldId”:“5E58E3AD00352A1175BAEC69”,“价值”:“500”}],“InvoicingInfo”:{“易用”:“5FF2DDE14C73833321BD5D36”,“invoiceNumber”:“发票- 001”,“手动吸音”:错误的},“数量”:750.00,“速度”:750.00,“用户名”:”詹姆斯白”,“useremail”:“james@acme.com”,“项目名”:“X计划”,“projectColor”:“# 8 bc34a”,“客户名称”:“ClientX”}]}

每周报告

帖子 / workspaces / {workspaceid} /报告/每周
“集团”“weeklyFilter”

取值范围:PROJECT、USER

“每周Filter”中的“子群”

可能的值:TIME, EARNED

“夸张”

可能的值:Hide_Amount,获得,成本,利润

“exportType”

可能的值:JSON,CSV,XLSX,PDF

“sortcolumn”

取值范围:GROUP、DURATION、AMOUNT

“排序”

可能的值:升序,降序

在任何过滤器中“包含”(标签除外)

包含,DOES_NOT_CONTAIN

标签过滤器中的“ContedIntimeEntry”

包含,contain_only,do_not_contain

任何过滤器中的“状态”

项目,客户,标签:全部,活动,存档
用户:所有,活动,不活动
任务:全部,活动,完成

“时区”

如果您不包含TimeZone,则配置文件设置中的时区将用于请求和响应。如果您包含TimeZone,则根据您指定的时区发送和接收时间。

请求内容类型:应用/ JSON.
请求示例
{/ /要求“datterangestart”:“2020-05-10T00:00:00.000”,“daterangeend”:“2020 - 05 - 16 - t23:59:59.000”,“每周Filter”:{“团体”:“用户”,“群”:“时间”},//设置(可选)“排序”:“降序”,“exportType”:“JSON”,“四舍五入”:错误的,“夸张”:“赚取”,“时区”:“美国/ Los_Angeles”,//过滤器(可选)“用户”:{“ids”:[“45FD36C4B0798777049512E2”),“包含”:“包含”,“地位”:“所有”},“用户组”: 空值,“客户”: 空值,“项目”: 空值,“任务”: 空值,“标签”:{“ids”:[“45FD36C4B0798777049512E2”),“constainedIntimeEntry”:“DOES_NOT_CONTAIN”,“地位”:“所有”},“计费”:真的,“描述”:”“,“没有DEDescription”:真的,“customfields”:[{“id”:“5 bfd36c4b0798777049512e2”,“价值”:30.,“类型”:“数量”“numpercondition”:“平等的”“空的”:“假”}]}
400错误请求

坏的请求

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:应用/ JSON.
请求示例
{“总计”:[{“totalTime”:3600,“totalbillabletime”:3600,“entriesCount”:1,“总金额”:750.00}],“totalsbyday”:[{“数量”:0.00,“期间”:0.00,“日期”:“2020-05-11”}, {“数量”:0.00,“期间”:0.00,“日期”:“2020-05-12”}, {“数量”:0.00,“期间”:0.00,“日期”:“2020-05-13”}, {“数量”:0.00,“期间”:0.00,“日期”:“2020-05-14”}, {“数量”:750.00,“期间”:3600,“日期”:“2020-05-15”}, {“数量”:0.00,“期间”:0.00,“日期”:“2020-05-16”}, {“数量”:0.00,“期间”:0.00,“日期”:“2020-05-17”}],“groupone”:[{“_ID”:“5 bfd36c4b0798777049512e2”,“期间”:3600,“数量”:750.00,“名称”:“用户”“天”:[{“数量”:0.00,“期间”:0.00,“日期”:“2020-05-11”}, {“数量”:0.00,“期间”:0.00,“日期”:“2020-05-12”}, {“数量”:0.00,“期间”:0.00,“日期”:“2020-05-13”}, {“数量”:0.00,“期间”:0.00,“日期”:“2020-05-14”}, {“数量”:750.00,“期间”:3600,“日期”:“2020-05-15”}, {“数量”:0.00,“期间”:0.00,“日期”:“2020-05-16”}, {“数量”:0.00,“期间”:0.00,“日期”:“2020-05-17”}],“孩子”:[“_ID”:“5 d308a73abad777bfa652291”,“期间”:3600,“数量”:750.00,“名称”:“项目”,“颜色”:“# F44336”,“客户名称”:“客户端”,“天”:[{“数量”:0.00,“期间”:0.00,“日期”:“2020-05-11”}, {“数量”:0.00,“期间”:0.00,“日期”:“2020-05-12”}, {“数量”:0.00,“期间”:0.00,“日期”:“2020-05-13”}, {“数量”:0.00,“期间”:0.00,“日期”:“2020-05-14”}, {“数量”:750.00,“期间”:3600,“日期”:“2020-05-15”}, {“数量”:0.00,“期间”:0.00,“日期”:“2020-05-16”}, {“数量”:0.00,“期间”:0.00,“日期”:“2020-05-17”}]]]]}]}}

分享报告

用于操纵共享报告资源的端点。

需要使用API基础端点的报告。

报告的API基本端点
https://reports.api.vwin徳赢登录www.bicisol.com/v1.

获取我所有的共享报告

得到 /工作区/ {workspaceId} / shared-reports

获取给定工作区上当前用户的所有共享报告

页:整数1
在查询

当前页码

页大小:整数50.
在查询

页面显示的报告数。最大尺寸为200。

200好了

好的

400错误请求

坏的请求

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:应用/ JSON.
反应示例(200 OK)
{“报告”:[{“名称”:“共享报告”,“关联”:“字符串(http://example.crl/5efc69f3784d5a36bb239e27)”,“id”:“5EFC69F3784D5A36BB239E27”,“visibleToUsers”:[{“id”:“5BF6D2B9B079876A34621635”,“名称”:“实体名称”}],“固定丹特”:真的,“类型”:“摘要”,“isPublic”:真的,“visibletousergroups”:[{“id”:“5BF6D2B9B079876A34621635”,“名称”:“实体名称”}]],“数数”:1}

按ID生成共享报告

得到 /共享报告/ {sharedreportid}

响应取决于报告类型和导出类型。给定示例是用于摘要报告和JSON导出类型。

dateRangeStart:细绳
在查询

开始选定的日期范围。

daterangeend:细绳
在查询

所选日期范围的结束。

排序方式:细绳
在查询

设置报表数据的排序顺序

sortColumn:细绳
在查询

控制TimeEntry /组排序标准。

ExportType:细绳杰森,CSV,XLSX,PDF.
在查询

此参数决定生成的报告的数据格式

页:整数
在查询

页码

页大小:整数
在查询

页面显示的授权数

200好了

好的

400错误请求

坏的请求

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:应用/ JSON.
反应示例(200 OK)
{“总计”:[{“_ID”:,“totalTime”:2760.,“totalbillabletime”:0,“总金额”:0.0,“entriesCount”:1}],“groupone”:[“_ID”:“5EF1CF219F130F232CC34DD5”,“期间”:2760.,“数量”:0.0,“孩子”:[{“_ID”:“5EF1CF219F130F232CC3XGE8”,“期间”:2760.,“数量”:0.0,“名称”:“timeentry描述”,“名称”:空值}]],“过滤器”:{“id”:“5 efdd01407aeb34a9f1161a1”,“Workspaceid”:“5EF1CF229F130F232CC34DDF”,“标识”:“5EF1CF219F130F232CC34DDC”,“名称”:“v1保存报告”,“visibletousergroups”:空值,“visibleToUsers”:空值,“固定丹特”:错误的,“类型”:“摘要”,“筛选”:{“datterangestart”:“2020-05-10T00:00:00.000Z”,“daterangeend”:“2020-05-16T23:59:59.000Z”,“datterangetype”:“本星期”,“日期格式”:“mm / dd / yyyy”,“时间格式”:HOUR12,“周末”:“周一”,“用户”:{“包含”:“包含”,“ids”:[“字符串”),“地位”:“积极的”},“用户组”:{“包含”:“包含”,“ids”:[“字符串”),“地位”:“积极的”},“客户”:{“包含”:“包含”,“ids”:[“字符串”),“地位”:“积极的”},“项目”:{“包含”:“包含”,“ids”:[“字符串”),“地位”:“积极的”},“任务”:{“包含”:“包含”,“ids”:[“字符串”),“地位”:“积极的”},“标签”:{“constainedIntimeEntry”:“CONTAINS_ONLY”,“包含”:“包含”,“ids”:[“字符串”),“地位”:“积极的”},“计费”:真的,“描述”:“过滤器”描述,“没有DEDescription”:真的,“详细漂亮”:{“sortcolumn”:“日期”,“页”:1,“页大小”:50.,“auditFilter”:{“withoutProject”:真的,“没有摊位”:真的,“期间”:3600,“杜兰特霍尔斯”:真的}},“摘要梦想”:{“组织”:[“字符串”),“sortcolumn”:“集团”},“每周Filter”:{“团体”:“用户”,“群”:“时间”},“排序”:“降序”,“exportType”:“JSON”,“四舍五入”:错误的,“夸张”:“hide_amount”,“customfields”:[{“id”:“5 bfd36c4b0798777049512e2”,“价值”:“30”,“类型”:“数量”,“numpercondition”:“平等的”,“空的”:“布尔”}],“用户”:{“id”:“5EF1CF219F130F232CC34DDC”,“名称”:“用户名”,“电子邮件”:“user.name@example.com”,“日期格式”:“mm / dd / yyyy”,“时间格式”:“HOUR12”,“时区”:“欧洲/法兰克福”,“周末”:“周一”,},“工作区”:{“id”:“5EF1CF229F130F232CC34DDF”,“名称”:“用户的工作区”,“workspaceSettings”:{“唯一的蒙迪斯塞利特利”:错误的,“onlyAdminsSeePublicProjectEntries”:真的,“onlyAdminsSeeBillableRates”:错误的,“ProjectGroupingLabel”:“客户端”,“lockDate”:空值,“costrateage”:真的,},“货币”:“美元”,“imageUrl”:,“onlyAdminsSeeBillableRates”:真的,“tracktimedowntoseconds”:真的},“subscriptionPlan”:“特殊”,“isAdminorowner”:真的}},}

创建共享报告

帖子 /工作区/ {workspaceId} / shared-reports

使用名称,选项和报表过滤保存共享报告

请求内容类型:应用/ JSON.
请求示例
{“名称”:“v1保存报告”,“isPublic”:真的,“固定丹特”:错误的,“类型”:“摘要”,“筛选”:{“datterangestart”:“2020-05-10T00:00:00.000Z”,“daterangeend”:“2020-05-16T23:59:59.000Z”,“datterangetype”:“本星期”,“日期格式”:“mm / dd / yyyy”,“时间格式”:HOUR12,“周末”:“周一”,“用户”:{“包含”:“包含”,“ids”:[“字符串”),“地位”:“积极的”},“用户组”:{“包含”:“包含”,“ids”:[“字符串”),“地位”:“积极的”},“客户”:{“包含”:“包含”,“ids”:[“字符串”),“地位”:“积极的”},“项目”:{“包含”:“包含”,“ids”:[“字符串”),“地位”:“积极的”},“任务”:{“包含”:“包含”,“ids”:[“字符串”),“地位”:“积极的”},“标签”:{“constainedIntimeEntry”:“CONTAINS_ONLY”,“包含”:“包含”,“ids”:[“字符串”),“地位”:“积极的”},“计费”:真的,“描述”:“过滤器”描述,“没有DEDescription”:真的,“详细漂亮”:{“sortcolumn”:“日期”,“页”:1,“页大小”:50.,“auditFilter”:{“withoutProject”:真的,“没有摊位”:真的,“期间”:3600,“杜兰特霍尔斯”:真的}},“摘要梦想”:{“组织”:[“字符串”),“sortcolumn”:“集团”},“每周Filter”:{“团体”:“用户”,“群”:“时间”},“排序”:“降序”,“exportType”:“JSON”,“四舍五入”:错误的,“夸张”:“hide_amount”,“customfields”:[{“id”:“5 bfd36c4b0798777049512e2”,“价值”:“30”,“类型”:“数量”,“numpercondition”:“平等的”,“空的”:“布尔”}]}}}
200好了

好的

400错误请求

坏的请求

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:应用/ JSON.
反应示例(200 OK)
{“id”:“5 efdd01407aeb34a9f1161a1”,“Workspaceid”:“5EF1CF229F130F232CC34DDF”,“标识”:“5EF1CF219F130F232CC34DDC”,“名称”:“v1保存报告”,“visibletousergroups”:空值,“visibleToUsers”:空值,“固定丹特”:错误的,“类型”:“摘要”,“筛选”:{“datterangestart”:“2020-05-10T00:00:00.000Z”,“daterangeend”:“2020-05-16T23:59:59.000Z”,“datterangetype”:“本星期”,“日期格式”:“mm / dd / yyyy”,“时间格式”:HOUR12,“周末”:“周一”,“用户”:{“包含”:“包含”,“ids”:[“字符串”),“地位”:“积极的”},“用户组”:{“包含”:“包含”,“ids”:[“字符串”),“地位”:“积极的”},“客户”:{“包含”:“包含”,“ids”:[“字符串”),“地位”:“积极的”},“项目”:{“包含”:“包含”,“ids”:[“字符串”),“地位”:“积极的”},“任务”:{“包含”:“包含”,“ids”:[“字符串”),“地位”:“积极的”},“标签”:{“constainedIntimeEntry”:“CONTAINS_ONLY”,“包含”:“包含”,“ids”:[“字符串”),“地位”:“积极的”},“计费”:真的,“描述”:“过滤器”描述,“没有DEDescription”:真的,“详细漂亮”:{“sortcolumn”:“日期”,“页”:1,“页大小”:50.,“auditFilter”:{“withoutProject”:真的,“没有摊位”:真的,“期间”:3600,“杜兰特霍尔斯”:真的}},“摘要梦想”:{“组织”:[“字符串”),“sortcolumn”:“集团”},“每周Filter”:{“团体”:“用户”,“群”:“时间”},“排序”:“降序”,“exportType”:“JSON”,“四舍五入”:错误的,“夸张”:“hide_amount”,“customfields”:[{“id”:“5 bfd36c4b0798777049512e2”,“价值”:“30”,“类型”:“数量”,“numpercondition”:“平等的”,“空的”:“布尔”}]}}}

更新共享报告

/ workspaces / {workspaceid} / shared-reports / {sharedreportid}

更新共享报告名称和/或选项

请求内容类型:应用/ JSON.
请求示例
{“名称”:“v1保存报告”,“isPublic”:真的,“固定丹特”:错误的,“visibleToUsers”: [],“visibletousergroups”:[]}
200好了

好的

400错误请求

坏的请求

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:应用/ JSON.
反应示例(200 OK)
{“id”:“5 efdd01407aeb34a9f1161a1”,“Workspaceid”:“5EF1CF229F130F232CC34DDF”,“标识”:“5EF1CF219F130F232CC34DDC”,“名称”:“v1保存报告”,“visibletousergroups”:空值,“visibleToUsers”:空值,“固定丹特”:错误的,“类型”:“摘要”,“筛选”:{“datterangestart”:“2020-05-10T00:00:00.000Z”,“daterangeend”:“2020-05-16T23:59:59.000Z”,“datterangetype”:“本星期”,“日期格式”:“mm / dd / yyyy”,“timeFORMAT”:HOUR12,“周末”:“周一”,“用户”:{“包含”:“包含”,“ids”:[“字符串”),“地位”:“积极的”},“用户组”:{“包含”:“包含”,“ids”:[“字符串”),“地位”:“积极的”},“客户”:{“包含”:“包含”,“ids”:[“字符串”),“地位”:“积极的”},“项目”:{“包含”:“包含”,“ids”:[“字符串”),“地位”:“积极的”},“任务”:{“包含”:“包含”,“ids”:[“字符串”),“地位”:“积极的”},“标签”:{“constainedIntimeEntry”:“CONTAINS_ONLY”,“包含”:“包含”,“ids”:[“字符串”),“地位”:“积极的”},“计费”:真的,“描述”:“过滤器”描述,“没有DEDescription”:真的,“详细漂亮”:{“sortcolumn”:“日期”,“页”:1,“页大小”:50.,“auditFilter”:{“withoutProject”:真的,“没有摊位”:真的,“期间”:3600,“杜兰特霍尔斯”:真的}},“摘要梦想”:{“组织”:[“字符串”),“sortcolumn”:“集团”},“每周Filter”:{“团体”:“用户”,“群”:“时间”},“排序”:“降序”,“exportType”:“JSON”,“四舍五入”:错误的,“夸张”:“hide_amount”,“customfields”:[{“id”:“5 bfd36c4b0798777049512e2”,“价值”:“30”,“类型”:“数量”,“numpercondition”:“平等的”,“空的”:“布尔”}]}}}

删除共享报告

删除 / workspaces / {workspaceid} / shared-reports / {sharedreportid}
204没有内容

没有内容

400错误请求

坏的请求

401未经授权

未经授权的

403禁止

禁忌

404没有找到

未找到

响应内容类型:应用/ JSON.