SAP Concur List Item API为想要检索和添加列表项的客户端提供了一个自动化的解决方案。API的使用受到列表数据量的一些限制。由于容量限制，您可能需要通过文件导入来管理大量数据的初始加载。如果正在进行的列表值维护涉及大量数据，这也是正确的。

限制：此API仅适用于已授予SAP Confor访问权限的合作伙伴。访问此文档不提供对API的访问权限。

内容

先前版本

过程流程

列表项API的流程图

产品和版本

  • Concur Expense专业版
  • Concur费用标准版
  • Concur发票专业版
  • 同意发票标准版
  • 同意请求专业版
  • 同意请求标准版

范围使用

名称 描述 终点
spend.listitem.read 只获取花费列表项的访问权限。 得到
花钱.Listitem.write. 读和写访问支出清单项目。 得到，发帖，放
花.Listitem.Delete. 删除花费列表项的功能。 删除

依赖性

用户必须是一项费用，发票，共享或请求配置管理员，以便执行帖子并执行操作。

访问令牌用法

此API支持公司级和用户级访问令牌。

按ID检索列表项

按ID检索列表项。

作用域

spend.listitem.read- 请参阅范围使用有关详细信息。

要求

Uri.

模板
get / list / v4 /项目/{itemid.}
参数
名称 类型 描述
接受语言 细绳 语言代码。默认值：公司定义了默认语言
itemid. 细绳 要求列表项的唯一标识符。

标题

响应

状态代码

标题

有效载荷

例子

要求

获取https://us.api.concursolutions.com/list/v4/Items/{itemid.}接受：Application / JSON接受语言：EN授权：承载{令牌}

响应

HTTP / 1.1 200同意 - 相关性：663D7795-FC21-4D98-BA31-87BE20AEACD2内容长度：360内容类型：应用/ JSON;Charset.=UTF-8日期：WED，08 JUL 2020 14:07:25 GMT ETAG：“0950BE10CA5A9F5069898E2468DB6E137”cache - control: no - cache,私人
{“ID”：“63B7FBD9-AE08-0840-ABDB-62B0B9160081”那“代码”：“项目 - 第二级项目”那“短代码”：“第二级项目”那“价值”：“第二级项目”那“父母”：“7C6D0435-C4D1-8B48-8492-7E7B625E148D”那“水平”：2那“isDeleted”：错误的那“列表”：[{“ID”：“80EDB3FA-C15E-A34A-B97F-F2EC291AB44F”那“有孩子”：错误的}]}

创建列表项

使用提供的请求正文创建列表项。

作用域

花钱.Listitem.write.- 请参阅范围使用有关详细信息。

要求

Uri.

模板
发布/列表/ v4 /项目
参数
名称 类型 描述
接受语言 细绳 语言代码。默认值：公司定义了默认语言
项目清单 - 要求列出为公司创建的项目对象。

标题

有效载荷

响应

状态代码

标题

有效载荷

例子

要求

post https://us.api.concursolutions.com/list/v4/lists接受：application / json接受语言：en content-type：application / json授权：承载{令牌}

示例1（创建第一级列表项）：

{“Listid”：“80EDB3FA-C15E-A34A-B97F-F2EC291AB44F”那“短代码”：“物品”那“价值”：“物品”}

示例2（按父列表项ID创建第二级列表项）：

{“Listid”：“80EDB3FA-C15E-A34A-B97F-F2EC291AB44F”那“父母”：“7C6D0435-C4D1-8B48-8492-7E7B625E148D”那“短代码”：“第二级项目”那“价值”：“第二级项目”}

示例3（按父列表项代码创建第二级列表项）：

{“Listid”：“80EDB3FA-C15E-A34A-B97F-F2EC291AB44F”那“parentCode”：“物品”那“短代码”：“第二级项目”那“价值”：“第二级项目”}

响应

HTTP / 1.1 201 Concur-CorrelationID：85B8DEB7-DB84-4DFB-BDCA-D4BCCB2EF06E内容长度：282内容类型：应用/ JSON;Charset.=UTF-8日期：WED，08 JUL 2020 13:47:25 GMT位置：http：// localhost：5000 / list / v4 / items / 7c6d0435-c4d1-8b48-8492-7e7b625e148d缓存控制：no-cache，私人

示例1:

{“ID”：“7C6D0435-C4D1-8B48-8492-7E7B625E148D”那“代码”：“物品”那“短代码”：“物品”那“价值”：“物品”那“父母”：无效的那“水平”：1那“isDeleted”：错误的那“列表”：[{“ID”：“80EDB3FA-C15E-A34A-B97F-F2EC291AB44F”那“有孩子”：错误的}]}

实施例2和实施例3：

{“ID”：“63B7FBD9-AE08-0840-ABDB-62B0B9160081”那“代码”：“项目 - 第二级项目”那“短代码”：“第二级项目”那“价值”：“第二级项目”那“父母”：“7C6D0435-C4D1-8B48-8492-7E7B625E148D”那“水平”：2那“isDeleted”：错误的那“列表”：[{“ID”：“80EDB3FA-C15E-A34A-B97F-F2EC291AB44F”那“有孩子”：错误的}]}

更新列表项

用提供的请求体更新列表项。

作用域

花钱.Listitem.write.- 请参阅范围使用有关详细信息。

要求

Uri.

模板
PUT / LIST / V4 /项目/{itemid.}
参数
名称 类型 描述
接受语言 细绳 语言代码。默认值：公司定义了默认语言
itemid. 细绳 要求列表项的唯一标识符。
项目清单 - 要求列出更新的项目对象。

标题

有效载荷

响应

状态代码

标题

有效载荷

例子

要求

put https://us.api.concursolutions.com/list/v4/Items/7c6d0435-c4d1-8b48-8492-7b625e148d接受：application / json接受语言：en content-type：application / json授权：承载{令牌}
{“短代码”：“物品”那“价值”：“项目更新”}

响应

HTTP / 1.1 200同意相关性：27abed5d-20cc-4edf-81b6-3e2dbf70ba39内容长度：289内容 - 类型：应用/ JSON;Charset.=UTF-8 date: Wed, 08 july 2020 14:16:21 GMT缓存控制:no-cache, private
{“ID”：“7C6D0435-C4D1-8B48-8492-7E7B625E148D”那“代码”：“物品”那“短代码”：“物品”那“价值”：“项目更新”那“父母”：无效的那“水平”：1那“isDeleted”：错误的那“列表”：[{“ID”：“80EDB3FA-C15E-A34A-B97F-F2EC291AB44F”那“有孩子”：真的}]}

删除列表项

按列表项ID删除列表项。将从所有列表中删除多个列表之间共享的列表项。

作用域

花.Listitem.Delete.- 请参阅范围使用有关详细信息。

要求

Uri.

模板
删除/列表/ v4 /项目/{itemid.}
参数
名称 类型 描述
itemid. 细绳 要求列表项的唯一标识符。

标题

响应

状态代码

标题

有效载荷

例子

要求

删除https://us.api.concursolutions.com/list/v4/Items/7c6d0435-c4d1-8b48-8492-7o7b625 -c4d1-8b625e148d接受：应用程序/ json授权：持票人{令牌}

响应

HTTP / 1.1 204 Concur-CorrelationID：D92ab0c7-510b-4730-99a8-14a79ad99b7c日期：WED，08 7月2020年7月14:16:21 GMT缓存控制：无缓存，私人

从列表中删除列表项

按列表从特定列表中列出项目ID列表项。这使得可以从一个列表中删除共享列表项，而不是所有列表。

作用域

花.Listitem.Delete.- 请参阅范围使用有关详细信息。

要求

Uri.

模板
删除/列表/ v4 /列表/{listid.}/项目/{itemid.}
参数
名称 类型 描述
listid. 细绳 要求列表的唯一标识符。
itemid. 细绳 要求列表项的唯一标识符。

标题

响应

状态代码

标题

有效载荷

例子

要求

DELETE https://us.api.concursolutions.com/list/v4/lists/80edb3fa-c15e-a34a-b97f-f2ec291ab44f/items/7c6d0435-c4d1-8b48-8492-7e7b625e148d接受:application/json授权:承载{令牌}

响应

HTTP / 1.1 204 Concur-CorrelationID：D92ab0c7-510b-4730-99a8-14a79ad99b7c日期：WED，08 7月2020年7月14:16:21 GMT缓存控制：无缓存，私人

检索列表项的孩子

检索给定列表项的直接子项。

作用域

spend.listitem.read- 请参阅范围使用有关详细信息。

要求

Uri.

模板
get / list / v4 /项目/{itemid.}/孩子？页面= {页}＆排序方式= {排序方式}
参数
名称 类型 描述
接受语言 细绳 语言代码。默认值：公司定义了默认语言
有孩子 布尔 如果真的，显示有孩子的物品。
isdeleted 布尔 如果真的，显示已删除的项目。
itemid. 细绳 要求列表项的唯一标识符。
页 整数 从1.默认开始的页码：1
短码 细绳 过滤功能短码。
短路铁道 细绳 过滤功能价值要么短码。
排序方式 细绳 字段排序。支持的值：价值那短码。默认：价值
sortDirection 细绳 排序方向。支持的值：ASC.那去世
价值 细绳 过滤功能价值。

标题

响应

状态代码

标题

有效载荷

例子

要求

获取https://us.api.concursolutions.com/list/v4/Items/7c6d0435-c4d1-8b48-8492-7e7b625e148d/children=1＆sortby.=价值接受：Application / JSON接受语言：EN授权：承载{令牌}

响应

HTTP/1.1 200 concurrent -correlationid: 50dcec14-c984-479c-84e2-186a7e62f87e content-length: 449 content-type: application/json;Charset.=UTF-8日期:Wed, 08 july 2020 14:27:13 GMT“05CB0F0ED5A73BedF1E8CD4171E360E41”cache - control: no - cache,私人
{“链接”：[]，“内容”：[{“ID”：“63B7FBD9-AE08-0840-ABDB-62B0B9160081”那“代码”：“项目 - 第二级项目”那“短代码”：“第二级项目”那“价值”：“第二级项目”那“父母”：“7C6D0435-C4D1-8B48-8492-7E7B625E148D”那“水平”：2那“isDeleted”：错误的那“列表”：[{“ID”：“80EDB3FA-C15E-A34A-B97F-F2EC291AB44F”那“有孩子”：错误的}]}]，“页”：{“尺寸”：100.那“totalElements”：1那“总计”：1那“数量”：1}}

按列表检索列表项的子项

检索特定列表中给定列表项的直接子列表。对于多个列表之间共享的列表项，此API支持从特定列表检索子列表。

作用域

spend.listitem.read- 请参阅范围使用有关详细信息。

要求

Uri.

模板
GET / / v4 /清单/列表{listid.}/项目/{itemid.}/孩子？页面= {页}＆排序方式= {排序方式}
参数
名称 类型 描述
接受语言 细绳 语言代码。默认值：公司定义了默认语言
有孩子 布尔 如果真的，显示有孩子的物品。
isdeleted 布尔 如果真的，显示已删除的项目。
itemid. 细绳 要求列表项的唯一标识符。
listid. 细绳 要求列表的唯一标识符。
页 整数 从1.默认开始的页码：1
短码 细绳 过滤功能短码。
短路铁道 细绳 过滤功能价值要么短码。
排序方式 细绳 字段排序。支持的值：价值那短码。默认：价值
sortDirection 细绳 排序方向。支持的值：ASC.那去世
价值 细绳 过滤功能价值。

标题

响应

状态代码

标题

有效载荷

例子

要求

获取https://us.api.concursolutions.com/list/v4/lists/80edb3fa-c15e-a34a -b97f-f2ec291ab44f -f2ec291ab44f/iTems/7c6d0435-c4d1-8b48-8492-7b625e148d/children=1＆sortby.=价值接受：Application / JSON接受语言：EN授权：承载{令牌}

响应

HTTP/1.1 200 concurrent -correlationid: 50dcec14-c984-479c-84e2-186a7e62f87e content-length: 449 content-type: application/json;Charset.=UTF-8日期:Wed, 08 july 2020 14:27:13 GMT“05CB0F0ED5A73BedF1E8CD4171E360E41”cache - control: no - cache,私人
{“链接”：[]，“内容”：[{“ID”：“63B7FBD9-AE08-0840-ABDB-62B0B9160081”那“代码”：“项目 - 第二级项目”那“短代码”：“第二级项目”那“价值”：“第二级项目”那“父母”：“7C6D0435-C4D1-8B48-8492-7E7B625E148D”那“水平”：2那“isDeleted”：错误的那“列表”：[{“ID”：“80EDB3FA-C15E-A34A-B97F-F2EC291AB44F”那“有孩子”：错误的}]}]，“页”：{“尺寸”：100.那“totalElements”：1那“总计”：1那“数量”：1}}

检索列表的第一级儿童项目

检索给定列表ID的第一级列表项。

作用域

spend.listitem.read- 请参阅范围使用有关详细信息。

要求

Uri.

模板
GET / / v4 /清单/列表{listid.}/孩子？页面= {页}＆排序方式= {排序方式}
参数
名称 类型 描述
接受语言 细绳 语言代码。默认值：公司定义了默认语言
有孩子 布尔 如果真的，显示有孩子的物品。
isdeleted 布尔 如果真的，显示已删除的项目。
listid. 细绳 要求列表的唯一标识符。
页 整数 从1.默认开始的页码：1
短码 细绳 过滤功能短码。
短路铁道 细绳 过滤功能价值要么短码。
排序方式 细绳 字段排序。支持的值：价值那短码。默认：价值
sortDirection 细绳 排序方向。支持的值：ASC.那去世
价值 细绳 过滤功能价值。

标题

响应

状态代码

标题

有效载荷

例子

要求

获取https://us.api.concursolutions.com/list/v4/lists/7c6d0435-c4d1-8b48-8492-7e7b625e148d/children?page.=1＆sortby.=价值接受：Application / JSON接受语言：EN授权：承载{令牌}

响应

HTTP/1.1 200 concurrent -correlationid: 50dcec14-c984-479c-84e2-186a7e62f87e content-length: 449 content-type: application/json;Charset.=UTF-8日期:Wed, 08 july 2020 14:27:13 GMT“05CB0F0ED5A73BedF1E8CD4171E360E41”cache - control: no - cache,私人
{“链接”：[]，“内容”：[{“ID”：“63B7FBD9-AE08-0840-ABDB-62B0B9160081”那“代码”：“项目第一级项目”那“短代码”：“第一级项目”那“价值”：“第一级项目”那“水平”：1那“isDeleted”：错误的那“列表”：[{“ID”：“7C6D0435-C4D1-8B48-8492-7E7B625E148D”那“有孩子”：错误的}]}]，“页”：{“尺寸”：100.那“totalElements”：1那“总计”：1那“数量”：1}}

过滤

支持的API.

列表项API支持过滤检索列表的第一级儿童项目那检索列表项的孩子， 和按列表检索列表项的子项蜜蜂。过滤器可以应用于价值那短码， 和短路铁道查询参数。

检索列表的第一级儿童项目
获取/列表/ v4 /列表/{listid.}/孩子？价值=测试获取/列表/ v4 /列表/{listid.}/孩子？短片=测试获取/列表/ v4 /列表/{listid.}/儿童？短科技=测试
检索列表项的孩子
获取/列表/ v4 /项目/{listid.}/孩子？价值=测试获取/列表/ v4 /项目/{listid.}/孩子？短片=测试获取/列表/ v4 /项目/{listid.}/儿童？短科技=测试
按列表检索列表项的子项
GET / / v4 /清单/列表{listid.}/项目/{itemid.}/孩子？价值=测试GET / / v4 /清单/列表{listid.}/项目/{itemid.}/孩子？短片=测试GET / / v4 /清单/列表{listid.}/项目/{itemid.}/儿童？短科技=测试

查询语法

查询语法参数的一般格式如下:

/清单/ v4 /资源?field_name.=：

  • field_name.-将被比较的字段的名称。

  • op.- （可选）比较运营商将指定值与字段进行比较时使用。默认为eq.。

  • 价值- 所检查的值。

确保生成的URL正确URL编码。例如，如果你有一个field_name.要么价值与A.＆，请将它转换为％26.。

例子:

/列表/ v4 /列表/{listid.}/孩子？价值=PSO
/列表/ v4 /列表/{listid.}/孩子？短片=SW：英国人
/列表/ v4 /列表/{listid.}/孩子？价值=ew：航空公司和短片=不是:英国+航空公司
/列表/ v4 /列表/{listid.}/孩子？价值=SW：问题％3Fmark

联合运营商

不支持使用括号的复杂查询。

有基本的支持或功能短路铁道查询参数。短路铁道将搜索两者短码和价值属性并返回匹配任一字段的所有资源。

比较运算符

=

eq.返回字段所在位置的结果等于提供的价值。如果没有指定操作符，这是默认值。

/列表/ v4 /列表/{listid.}/孩子？价值=测试
/列表/ v4 /项目/{itemid.}/孩子？价值=方程式：测试
/列表/ v4 /项目/{itemid.}/儿童？短科技=方程式：测试

包含模式

CP返回指定字段中存在所提供模式的结果。

/列表/ v4 /列表/{listid.}/孩子？价值=CP：测试

不是

不是返回字段所在位置的结果不等于提供的价值。

/列表/ v4 /项目/{itemid.}/孩子？短片=不是:测试

以。。开始

sw返回现场的结果startsWith提供的价值。

/列表/ v4 /列表/{listid.}/孩子？短片=SW：测试

以。。结束

EW.返回现场的结果以。。结束提供的价值。

/列表/ v4 /项目/{itemid.}/孩子？价值=ew：test.

架构

列表项

名称 类型 格式 描述
ID 细绳 uuid 列表项的唯一标识符。
代码 细绳 - 列出项目长代码。
短码 细绳 - 列出项目短代码。
价值 细绳 - 列出项目值。
括号 细绳 uuid 父列表项的唯一标识符。
listid. 细绳 uuid 包含列表项的列表的唯一标识符。
等级 整数 int32 列表中列表项的级别。
清单 ListItemMemberList - 包含列表项的列表的唯一标识符。列表项可以存在于一个或多个列表之下。
isdeleted 布尔 真的/错误的 表示特定列表中的项目的删除状态。如果错误的时，列表项不会从一个或多个列表中删除。这清单字段将只包括包含处于未删除状态的列表项的列表。isdeleted只会是真的当列表项从所有列表中删除时。这清单字段将包括包含列表项的所有列表。

列表项创建

名称 类型 格式 描述
listid. 细绳 uuid 要求包含列表项的列表的唯一标识符。
括号 细绳 - 父列表项的长代码。
括号 细绳 uuid 父列表项的唯一标识符。
短码 细绳 - 要求列出项目短代码。
价值 细绳 - 要求列出项目值。

列表项目更新

名称 类型 格式 描述
短码 细绳 - 要求列出项目短代码。
价值 细绳 - 要求列出项目值。

列出项目成员列表

名称 类型 格式 描述
ID 细绳 uuid 包含列表项的列表的唯一标识符。
有孩子 布尔 真的/错误的 如果真的，则列表项在这个特定的列表中有子列表。

分页资源列表项

名称 类型 格式 描述
内容 数组 项目清单 -
页 Pagemetadata. - 返回数据页面的元数据
链接 数组 关联 Href链接到数据的下一页、前一页、第一页和/或最后一页。

错误消息

名称 类型 格式 描述
错误 消息 - 要求详细错误消息。
httpstatus. 细绳 - 要求HTTP响应代码和响应短语。
小路 细绳 - 要求尝试请求的URI。
时间戳 细绳 日期-时间 要求捕获错误时的时间。
验证识别 数组 验证误合 验证错误消息。

验证错误

名称 类型 格式 描述
信息 细绳 - 验证错误的详细消息。
来源 细绳 - 失败的验证类型。

消息

名称 类型 格式 描述
信息 细绳 - 详细错误消息。
ID 细绳 - 错误的标识符。

页面元数据

名称 类型 格式 描述
数字 整数 int32 页码。
尺寸 整数 int32 每页的物品数量为100。
完全 整数 int32 总要素的数量。
totalPages 整数 int32 总页数。
名称 类型 格式 描述
rel. 细绳 - 链接关系。
HREF. 细绳 - href的链接。