列表API允许您在SAP Confor产品中查看已配置的列表并创建新列表。列表是在多个SAP Confor产品之间共享的。

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

内容

之前的版本

列出V3文档可用在这里．

过程流程

List API的流程流程图

产品和版本

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

范围使用

的名字 描述 端点
花.List.read.read. 只读访问花费列表。 得到
spend.list.write 读和写消费清单。 得到，发帖，放
spend.list.delete 删除支出列表的能力。 删除

依赖关系

用户必须是费用，发票，共享或请求配置管理员，以便执行POST，PUT和DELETE操作。

访问令牌的使用

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

得到所有列表

返回公司的所有列表。

范围

花.List.read.read.——是指范围使用有关详细信息。

请求

Uri.

模板
获得/清单/ v4 /列表
参数
的名字 类型 描述
接收语言 字符串 语言代码。默认值：公司定义了默认语言
页面 整数(int32美元) 从1.默认开始的页码：1
排序方式 字符串 字段按{name，levelcount，listcategory}订购。排序方式的名字是有序的价值．排序方式levelcount.是有序的levelcount.．排序方式listcategory.是有序的category.type．默认值:的名字
sortDirection 字符串 排序方向{asc, desc}。默认值:asc

头

回复

状态码

头

有效载荷

例子

请求

得到https://us.api.concursolutions.com/list/v4/lists?page=1 Accept: application/json Accept- language: en授权:承载{令牌}

回复

HTTP / 1.1 200同意相关性：746696DC-8782-4642-815D-3080640786C7含量长度：5632内容类型：应用/ JSON;Charset.=UTF-8日期：WED，08 JUL 2020 02:45:48 GMT Etag：“02 ebe9fc5c950a031f85c57ac91a0babb”cache - control: no - cache,私人
{“链接”：[]，“内容”：[{“id”：“a80a5070 - 3951 - 4316 - 886 - a - a60ab790f06b”那“价值”：“航空公司”那“levelcount”：1那“searchCriteria”：“文本”那“displayFormat”：“(代码)文本”那“类别”：{“id”：“A2DFC451-8F3C-410E-A5F2-20D79C8FC3DC”那“类型”：“供应商”}，“isReadOnly”：错误的那“isdeleted”：错误的}，{“id”：“8652CDF9-C12B-4051-B8D1-80E20840CE9B”那“价值”：“员工”那“levelcount”：1那“searchCriteria”：“文本”那“displayFormat”：“(代码)文本”那“类别”：{“id”：“D232B1E3-43DA-4A2D-ADAF-EB948045E8CF”那“类型”：“配置”}，“isReadOnly”：错误的那“isdeleted”：错误的}]，“页”：{“大小”：One hundred.那“totalElements”：2那“总计”：1那“数量”：1}}

创建一个新列表

创建一个新列表。

范围

spend.list.write——是指范围使用有关详细信息。

请求

Uri.

模板
发布/列表/ v4 /列表
参数
的名字 类型 描述
接收语言 字符串 语言代码。默认值：公司定义了默认语言
listrequest. - 必需的列表为公司创建的对象。

头

有效载荷

回复

状态码

头

有效载荷

例子

请求

post https://us.api.concursolutions.com/list/v4/lists接受：application / json content-type：application / json授权：承载{令牌}
示例1:
{“searchCriteria”：“文本”那“价值”：“自定义列表”那“displayFormat”：“(代码)文本”}
示例2:
{“searchCriteria”：“文本”那“价值”：“自定义供应商名单”那“被”：“A2DFC451-8F3C-410E-A5F2-20D79C8FC3DC”那“displayFormat”：“(代码)文本”}

回复

HTTP/1.1 201 concurrent -correlationid: 5512c7be- 3fabr -4d65-ae69-8a74a04a0c7f content-length: 269 content-type: application/json;Charset.=UTF-8日期：WED，08 JUL 2020 03:00:42 GMT位置：http：//us.api.concursolutions.com/list/v4/lists/80edb3fa-c15e-a34a -b97f-f2ec291ab44f缓存控制：否-cache，私人
{“id”：“80 edb3fa-c15e-a34a-b97f-f2ec291ab44f”那“价值”：“自定义列表”那“levelcount”：1那“searchCriteria”：“文本”那“displayFormat”：“(代码)文本”那“类别”：{“id”：“77 b85a76 - 8157 - 0 - c4e b5e3 - 7785 d8de1a6b”那“类型”：“普通的”}，“isReadOnly”：错误的那“isdeleted”：错误的}

更新列表

更新现有列表。

范围

spend.list.write——是指范围使用有关详细信息。

请求

Uri.

模板
PUT / LIST / V4 / LIST /{listid.}
参数
的名字 类型 描述
接收语言 字符串 语言代码。默认值：公司定义了默认语言
listid. 字符串（$ uuid） 必需的列表的唯一标识符。
listpdate. - 必需的为公司更新的列表对象。

头

有效载荷

回复

状态码

头

有效载荷

例子

请求

PUT https://us.api.concursolutions.com/list/v4/lists/80edb3fa-c15e-a34a-b97f-f2ec291ab44f Accept: application/json Accept- language: en Content-Type: application/json授权:承载{令牌}
{“价值”：“自定义列表重命名”那“searchCriteria”：“文本”那“displayFormat”：“(代码)文本”}

回复

HTTP / 1.1 200同意相关性：E3A4D4CF-E1B2-4F22-A95C-B5BB8A2CB0E1含量长度：275内容类型：应用/ JSON;Charset.=UTF-8日期：WED，08 JUL 2020 03:24:16 GMT缓存控制：无缓存，私人
{“id”：“80 edb3fa-c15e-a34a-b97f-f2ec291ab44f”那“价值”：“自定义列表重命名”那“levelcount”：1那“searchCriteria”：“文本”那“displayFormat”：“(代码)文本”那“类别”：{“id”：“77 b85a76 - 8157 - 0 - c4e b5e3 - 7785 d8de1a6b”那“类型”：“普通的”}，“isReadOnly”：错误的那“isdeleted”：错误的}

按列表ID获取列表

根据列表ID返回列表。

范围

花.List.read.read.——是指范围使用有关详细信息。

请求

Uri.

模板
GET / / v4 /清单/列表{listid.}
参数
的名字 类型 描述
接收语言 字符串 语言代码。默认值：公司定义了默认语言
listid. 字符串（$ uuid） 必需的列表的唯一标识符。

头

回复

状态码

头

有效载荷

例子

请求

获取https://us.api.concursolutions.com/list/v4/lists/80edb3fa-c15e-a34a -b97f-f2ec291ab44f接受：application / json接受语言：en授权：承载{令牌}

回复

HTTP / 1.1 200同意相关性：6A5803F6-B63B-49D8-88B3-872F456206C2含量长度：275内容类型：应用/ JSON;Charset.=UTF-8日期：WED，08 JUL 2020 02:45:48 GMT Etag：“08514B0FCE90D634C211ABA29D1CC94C2”cache - control: no - cache,私人
{“id”：“80 edb3fa-c15e-a34a-b97f-f2ec291ab44f”那“价值”：“自定义列表重命名”那“levelcount”：1那“searchCriteria”：“文本”那“displayFormat”：“(代码)文本”那“类别”：{“id”：“77 b85a76 - 8157 - 0 - c4e b5e3 - 7785 d8de1a6b”那“类型”：“普通的”}，“isReadOnly”：错误的那“isdeleted”：错误的}

通过类别ID获取列表

按类别ID返回列表。

范围

花.List.read.read.——是指范围使用有关详细信息。

请求

Uri.

模板
get / list / v4 /类别/{compouttsid.}/列表
参数
的名字 类型 描述
接收语言 字符串 语言代码。默认值：公司定义了默认语言
compouttsid. 字符串（$ uuid） 必需的类别的唯一标识符。
页面 整数(int32美元) 从1.默认开始的页码：1

头

回复

状态码

头

有效载荷

例子

请求

获取https://us.api.concursolutions.com/list/v4/categories/77b85a76-8157-0c4e-b5e3-7785d8de1a6b/lists?page.=1 Accept: application/json Accept- language: en授权:承载{令牌}

回复

HTTP / 1.1 200同意相关性：0E80DFF7-93B7-4B43-A1B6-A91EBE5C55F0内容长度：364内容类型：应用/ JSON;Charset.=UTF-8日期：WED，08 JUL 2020 02:45:48 GMT Etag：“02 e60234cf6ae61aadd7f066e839b07fb”cache - control: no - cache,私人
{“链接”：[]，“内容”：[{“id”：“80 edb3fa-c15e-a34a-b97f-f2ec291ab44f”那“价值”：“自定义列表重命名”那“levelcount”：1那“searchCriteria”：“文本”那“displayFormat”：“(代码)文本”那“类别”：{“id”：“77 b85a76 - 8157 - 0 - c4e b5e3 - 7785 d8de1a6b”那“类型”：“普通的”}，“isReadOnly”：错误的那“isdeleted”：错误的}]，“页”：{“大小”：One hundred.那“totalElements”：1那“总计”：1那“数量”：1}}

删除列表

删除一个列表。

范围

spend.list.delete——是指范围使用有关详细信息。

请求

Uri.

模板
删除/ / v4 /清单/列表{listid.}
参数
的名字 类型 描述
listid. 字符串（$ uuid） 必需的列表的唯一标识符。

头

回复

状态码

头

有效载荷

例子

请求

DELETE https://us.api.concursolutions.com/list/v4/lists/80edb3fa-c15e-a34a-b97f-f2ec291ab44f接受:application/json授权:承载{令牌}

回复

HTTP/1.1 204 concurrent -correlation: d92ab0c7-510b-4730-99a8-14a79ad99b7c date: Wed, 08 ju2020 02:45:48 GMT cache-control: no-cache, private . HTTP/1.1 204 concurrent -correlation: d92ab0c7-510b-4730-99a8-14a79ad99b7c date: Wed, 08 ju2020 02:45:48 GMT

模式

分页资源列表响应

的名字 类型 格式 描述
内容 大批 listresponse. -
页面 Pagemetadata. - 返回的数据页的元数据。
链接 大批 关联 Href链接到数据的下一页、前一页、第一页和/或最后一页。

列表响应

的名字 类型 格式 描述
ID 字符串 uuid 列表的唯一标识符。
价值 字符串 - 列表的名称。
levelcount. 整数 int32 列表中的级别数。
searchCriteria 字符串 - 用{搜索什么属性文本那代码}。
displayFormat 字符串 - 首先显示代码或值{（代码）文本那文本(代码)}。
类别 ListCategory - 列表的类别。
israadonly 布尔基 真正的/错误的 如果真正的，列表是只读的。
isDeleted 布尔基 真正的/错误的 如果真正的，列表已被删除。

列表类别

的名字 类型 格式 描述
ID 字符串 uuid 类别的唯一标识符。
类型 字符串 - 类别类型。

列表请求

的名字 类型 格式 描述
searchCriteria 字符串 - 根据什么属性进行搜索。支持的价值观:文本那代码
价值 字符串 - 必需的列表的名称。
compouttsid. 字符串 uuid 列表所属类别的唯一标识符。
displayFormat 字符串 - 是先显示代码还是先显示值。支持的价值观:（代码）文本那文本(代码)

列表更新

的名字 类型 格式 描述
价值 字符串 - 必需的列表的名称。
searchCriteria 字符串 - 根据什么属性进行搜索。支持的价值观:文本那代码
displayFormat 字符串 - 是先显示代码还是先显示值。支持的价值观:（代码）文本那文本(代码)

消息

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

页面元数据

的名字 类型 格式 描述
数字 整数 int32 页码。
尺寸 整数 int32 每页列表数，其固定在100。
完全 整数 int32 总要素的数量。
总计 整数 int32 总页数。
的名字 类型 格式 描述
rel. 字符串 - 的链接关系。
href 字符串 - href的链接。

错误消息

的名字 类型 格式 描述
错误 消息 - 必需的详细错误消息。
httpstatus. 字符串 - 必需的响应的http响应代码和短语。
小路 字符串 - 必需的尝试请求的URI。
时间戳 字符串 约会时间 必需的捕获错误时的时间。
验证识别 大批 ValidationError 验证错误消息。

验证错误

的名字 类型 格式 描述
信息 字符串 - 验证错误的详细消息。
源 字符串 - 失败的验证类型。