使用VersionOne api,当由javascript / html实现时,如何实现故事名称的获取?query.v1

With VersionOne api, how to implement fetch of Story Names when implemented by javascript / html? query.v1 using Oauth2

本文关键字:实现 故事 获取 v1 query 何实现 javascript 当由 api VersionOne html      更新时间:2023-09-26

我想开始使用 VersionOne api,用作构建块来呈现故事名称的自定义 HTML 页面视图(一旦我开始工作,稍后会扩展详细信息(。 我想用HTML,javascript,JSON,OAUTH2(无回调URL(实现来表述这一点。 对于此实现,query.v1 端点是必需的,我的使用/设置说明不像 rest-1.v1 那样清晰/易于使用。

我确实"构建"/下载了我的个人客户端密码("v1_client_secrets.json(。 虽然我不知道文档中的"使用范围查询-api-1.0"是什么意思或它将如何应用。 我一直在阅读的 API 文档在这里:https://community.versionone.com/Developers/Developer-Library/Sample_Code/Tour_of_query.v1

我对下面的 json 数据 GET 模式很好。

{
    "from": "Story",
    "select": [
        "Name"
    ]
}

虽然有 JSON 模式的示例,但我似乎无法理解如何从头到尾对其进行编码。 是否有基于我的详细信息的入门模板脚本(包括所有html/javascript(,有人可以传递?我假设jquery,angular,ajax将被合并到检索/解析/读取过程中。

仅供参考,我是这种编码的新手,尤其是消费 api,所以希望这一切都有意义。

使用 Javascript SDK,您可以与 VersionOne 实例进行通信。如果您使用的是 node,则可以使用 npm install v1sdk 安装软件包。否则,可以在 https://github.com/versionone/VersionOne.SDK.JavaScript/下载源代码。这方面的一个例子。

import $ from 'jquery';
import sdk, {jqueryConnector} from 'v1sdk';
const jqueryConnectedSdk = jqueryConnector($)(sdk);
const v1 = jqueryConnectedSdk('www14.v1host.com', 'v1sdktesting', 443, true)
    .withCreds('admin', 'admin'); // usage with username/password
//  .withAccessToken('your token'); // usage with access tokens
v1.create('Story', {estimate: 5, status: 'Not Started'})
    .then((story) => v1.update(story.oidToken, {estimate: 7}))
    .then(v1.query({
        from: 'Story',
        select: ['Estimate', 'Status'],
        where: {
            Status: 'Not Started'
        }
    }))
    .then(console.log)
    .catch(console.log);

此示例演示如何创建 v1 连接、创建故事、更新该故事,然后查询同一故事并选择状态为"未启动"的"估计和状态"。本文提供了使用 SDK http://walkerrandolphsmith.com/blog/v1sdk/显示积压工作的示例。它还有一个随附的 git 存储库,您可以查看文章中提到的。