开云官网手机网页版入口Jama Rest API

可用性

REST API可用在我们承载SaaS为本地客户实例Jamacloud和运行8.0或以上。开云官网手机网页版入口

获得

休息是为云客户默认启用。

通过系统管理本地客户可以休息。

SOAP是不能用于任何版本的支持服务。

使用的UI

昂首阔步的UI是一个交互式文档工具使用REST API。这个工具提供给用户提供一个有效的登录和其他启用。可以通过访问大摇大摆{上下文路径}/ api文档/

如果你不登录,登录页面将显示,然后带你去大摇大摆:如果你启用Jama的实例没有休息你会收到这样的消息:开云官网手机网页版入口
“不能读大摇大摆从{上下文路径}/休息/最近/ JSON api文档”

资源的列表将会显示,你可以探索所有支持的端点。

每个端点将详细参数,请求对象,和响应对象,以及哪些参数是必需的。

填写所需的参数和表格,点击“试试!”A response will be returned from the server, along with the formatted URL:

迅速获得一个请求对象的模式,点击模型模式,点击格式化的JSON的窗口。体内样本模型将加载窗口左边和JSON现在可以编辑:

高级认证(OAuth)

curl——美元请求发布http://test123: EC231BA29695BF2CBAB6@basepath \ /休息/ oauth /令牌
——数据grant_type = client_credentials \{:“access_token eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NDQ5MjI4OTcsInNjb3BlIjpbInJlYWQiXSwianRpIjoiNTQ3N2……(等等), "token_type":"bearer", "expires_in":3599, "scope":"token_information", "application_data":{ "JAMA_CORE":"sample" }, "tenant":"default", "jti":"d480b154-4e5e-446b-beec-2f1b7cdc0e35" }

美元curl——请求http://basepath/rest/v1/users/current
——标题“授权:无记名eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NDQ5MjI4OTcsInNjb3BlIjpbInJlYWQiXSwianRpIjoiNTQ3N2……(等等){"元":{“地位”:“OK”,“时间戳”:“2015 - 10 - 28 t22:33:16.524 + 0000”},“链接”:{},“数据”:{" id ": 5,“用户名”:“样本”,“firstName”:“样本”,“姓”:“用户”,“电子邮件”:“admin@my.domain.com”、“电话”:“”、“标题”:“”、“位置”:“”、“licenseType”:“姓名”、“活跃”:真的,”型":"用户"}}

版本控制

变化是不可避免的。版本控制是用来确保集成可以保护和更新管理。由于这些原因,Jama建议声明所有请求开云官网手机网页版入口的其他版本。开云官网手机网页版入口《美国医学会杂志》有多个版本的端点。

• v0 - beta版的版本,在8.22,但是这可能是在使用自我托管客户Jama连接的使用不受支持的版本开云官网手机网页版入口
• v1 -当前版本支持的休息。
• 最新——指定日落——看到日落的细节
• 实验室——版本引入了新的端点反馈不打破或令人费解的支持版本。这个版本将不会被官方支持和端点可能会改变,或者在将来的版本中被删除。

访问文档的不同版本,更新大摇大摆的URL。

Jama开云官网手机网页版入口 Jama REST API版本分别从产品发布。开云足球app下载官网最新版多个API版本支持在每个Jama释放提供向后兼容性。开云官网手机网页版入口

查询可用的API版本发出请求如下:

得到https://xyz.开云官网手机网页版入口jamacloud.com/rest

开云官网手机网页版入口Jama软开云官网入口下载手机版件:API日落EOL政策

Jama新开云官网手机网页版入口版本的API完成时我们会发布新版本,开始日落活动。(如版本被视为完整的点。v2, v3, . .v10)。
每个日落/ EOL时间表将是独一无二的,基于变化的复杂性。

日落/临终(EOL)过程介绍如下。

• 开云官网手机网页版入口Jama不会释放多个完整点版/日历年度
• 开云官网手机网页版入口Jama连接本地用户:日落窗口永远不会小于一个标准版本. .
• 开云官网手机网页版入口Jama将继续创新和正确的API定义破坏范围内变化

影响:
客户实现代码连接到Jama Rest API将需要审查和修改连接利用新的Rest API版本和模式。开云官网手机网页版入口不这样做将导致破碎的连通性和错误当夕阳EOL完成。

日落和支持时间表:

• Jama云实开云官网手机网页版入口例将获得新的API版本在每月定期发布。
• Jama本地实例将获得开云官网手机网页版入口新的API版本在接下来的标准版本


• 日落/终点计时开始之日起云的可用性。
  • 鼓励本地Jama客户回开云官网手机网页版入口顾可用的文档和迁移信息提前开始规划模式的可用性。

新版本信息将通过结合宣布:

• 开云官网手机网页版入口Jama连接发布说明
• 符号在Jama招摇过市,把家响应标头开云官网手机网页版入口
• http://community.开云官网手机网页版入口jama开云官网入口下载手机版software.com
• http://dev.开云官网手机网页版入口jama开云官网入口下载手机版software.com
• 开云官网手机网页版入口Jama将邮件通知中途日落期间参与清除日期越来越近越来越频繁。
• 开云官网手机网页版入口Jama账户经理也会增加沟通频率作为时间减少。

开云官网手机网页版入口Jama软开云官网入口下载手机版件:定义的API打破变化

开云官网手机网页版入口《美国医学会杂志》将继续创新和改变意图REST API方法,:

• 提高效率
• 提高开发人员的可用性
• 删除整体的视角

断变化将被定义为:

“任何修改同步客户端/用户/集成需要修改为了消费代码继续正常工作。打破不一定是基于代码的变化,包括数据的意图。”

在某些情况下,打破改变无法避免Jama(即解决意想不到的错误行为)将适当警告当这种情况发生时通过多个分销渠道。开云官网手机网页版入口

开云官网手机网页版入口Jama鼓励集成商和用户我们的API来与我们分享深使用的细节,这样我们可以包括边缘的场景在我们打破变更审查过程。打破变化可能会延迟发布包含在一个包罗万象的版本增加。这将发生日落和迁移对用户的影响降到最低。

• 开云官网手机网页版入口Jama将利用“/实验室”REST端点测试床的解决方案,可能永远不会被包括在生产其他端点开云足球官网开云足球app下载官网最新版
• 修改任何数据在“/实验室”端点将永远不会被认为是打破变化

断变化的例子:

• 改变或删除/删除方法或资源名称
• 为任何端点添加必需的参数。
• 添加可选参数修改默认的响应行为
• 修改数据嵌套结构的JSON响应
• 实施或修改缓存策略影响交付
• 增加默认响应数据类型大小限制(例如:改变文本/团/ Clob)

非破坏的变化通常会表现为:

• 新的可选参数,默认行为没有影响
• 新资源或API端点(新增)
• 新的可选JSON的关键职位
• 新键返回的JSON响应

打破有限的角度来看:
开云官网手机网页版入口Jama将避免在生产中改变一个HTTP响应代码的意图。开云足球app下载官网最新版开发人员可能已经建立了解析行为在特定的响应文本,即使它可能导致不可持续的结果。
改变纠正不相容的语言或行为不被认为是打破变化

• 错误500是400年通过纠正解决更好的错误处理
• 响应代码语言变化是不被认为是打破变化

常见的响应代码

200年好
请求已成功处理。这个GET请求后返回代码或PUT请求(如果将导致数据产生和返回)。

201年创建
成功处理POST请求。

204 -没有内容
成功删除请求处理。

400 -错误请求
请求不能被解析或参数是无效的。请求应该被修改后重新提交。

401 -未经授权
用户名/密码无效或用户没有访问所请求的对象。

404 -未找到
语法是正确的请求,但在指定的位置不存在。

405 -方法不允许的
有一个问题请求的方式。

429 -太多的请求
只返回API节流或系统维护。

当前日落活动

2019-11-22 - /最新的API端点日落公告
EOL = 2020-05-22
看到社区发布更多细节

API更改日志

Jama 2023/05/05 -版本:8.开云官网手机网页版入口86连接

POST /基线实验室端点现在允许您创建一个基线,而无需首先创建一个源。

Jama 2023/01/06 -版本:8.开云官网手机网页版入口82连接

新引入的端点得到物品/ {id} / versioncategories参数选择从versionID versionNumber匹配现有模式

Jama 2022/11/11 -版本:8.开云官网手机网页版入口80连接

项目基线将包括类别应用的时间基准
得到基线/ {baselineId} / versioneditems现在包含应用类别快照时的基线

Jama 2022/10/14 -版本:8.开云官网手机网页版入口79连接

类别的更新——在实验室
GET /类别检索所有类别路径名称(和/或)项目id
创建一个新的CategoryPath POST /类别
把/类别/ {categoryPathId} /能见度更新类别的可见性

新报告端点——在实验室
POST /报告/ {reportId}作为异步请求创建一个新报告(一个成功的响应意味着工作开始和一个标识符。这个标识符将用于未来的特性)
GET /报告/元数据得到所有报告元数据对于一个给定的项目

Jama 2022/06/24 -版本:8.开云官网手机网页版入口75连接

包括标准与lookup_matrix Picklist细节
POST / picklist包括标准的选项和LOOKUP_MATRIX
GET /选择端点现在返回标准和LOOKUP_MATRIX列表

Jama 2022/05/27 -版本:8.开云官网手机网页版入口74连接

补丁/项目
更新一个易行的物品与指定的ID作为异步请求。

把/项目/ {treeLocation}
设置项的位置指示父母和同伴的位置。

基线的更新
GET /基线端点现在返回基线列表选项
现在得到基线/ {baselineId}端点返回基线列表选项
现在把基线/ {baselineId}端点可以更新基线列表选项

Jama 2022/04/01 -版本:8.开云官网手机网页版入口72连接

/ / {baselineId} / reviewlink基线
评论ID的基线

新的基线选项添加到实验室
POST /基线
得到基线/文件夹
POST /基线/文件夹

Jama 2022/02/04 -版本:8.开云官网手机网页版入口70连接

移动基准源文件夹
把/ baselinetree / {projectId} /移动

Jama 2021/12/10 -版本:8.开云官网手机网页版入口68连接

GET /过滤器/ {filterId} /计数
新的端点提供过滤器计数结果不返回项目在一个过滤器。

附加选项的用户
新的mulit-auth选项允许SAML和基本认证一起使用。启用时,创建用户需要指定身份验证类型。那些指定包括passowrd的基本需要。
名称:“基本”,id: 1
名称:“国内流离失所者”,id: 2

删除资源revisionitem从文档。内部资源是包含在文档错误。

实验室支持应用和删除新类别通过GET和POST /项目/ {itemId} /类别

Jama 2021/06/04 -版本:8.开云官网手机网页版入口62连接

为testruns /补丁更新
定制字段现在可更新。与最近的UI更新定制字段现在可以通过API更新。更新继续镜子UI行为更新测试运行。只有执行的字段可编辑UI可以更新。以前的自定义字段包含一个更新被视为只读字段和忽略。

实验室包括基线的帖子。

Jama 2021/04/23 -版本:8.开云官网手机网页版入口61连接

额外的权限得到/用户/用户组
访问得到/用户和用户组需要组织或用户admin角色。项目管理员可以继续使用这些端点,但需要提供一个项目ID是一个项目管理。

访问获得/用户/ {userId} & /用户组/ {id}现在将执行权限检查确保请求用户能够访问相同的项目要求用户或用户组。

Jama 2021/02/12 -版本:8.开云官网手机网页版入口59连接

新的API头:x-jama-date开云官网手机网页版入口-fields-with-time
新的标题选项内提供完整的iso - 8601格式的日期字段部分。

遗留Soap服务(不支持)

Jama开云官网手机网页版入口 Soap服务已经取代了我们的REST api。少数自托管组织正在使用不支持的基于Soap的修改Jama的连接,如2015年春天释放。开云官网手机网页版入口

由于社区的请求,我们已经恢复了最小支持Soap服务文档。鼓励开发和管理团队开放与Jama的对话开始重新部署项目的新版本Jama连接。开云官网手机网页版入口内部信息将继续成为稀疏我们得到进一步的支持Soap服务的时间表。

时间轴:

• 6月1日^圣2016 - SOAP日落宣布
• 12月31日^圣2016 - SOAP全力支持结束
• 6月30日^th2017 -释放连接v8.20删除SOAP API
• 6月30日^th2017最大的努力支持结束
• 2019年1月——文档删除
• 2019年5月,最小的文件恢复到以下位置(Soap服务——2015年春季版本)
• 2020年5月,恢复Soap服务文档将被删除永久的《美国医学会杂志》的网站。开云官网手机网页版入口