接口v2-睡觉

OpenAPI 3.0架构

GET /api/v2/

返回可用端点的列表

状态代码
  • 200 OK -- 具有可用端点列表的json

GET /api/v2/documents/

返回所有可用文档以及详细信息的API端点(分页)。

查询参数
  • ordering (string) -- 对结果进行排序时要使用的字段。

  • page (integer) -- 分页结果集中的页码。

  • page_size (integer) -- 每页返回的结果数。

  • search (string) -- 搜索词。

状态代码
POST /api/v2/documents/

使用Django睡觉>=2.2.5中序列化程序的My=True功能批量创建单个或多个模型实例。

数据可以由串行器名称(单数或复数形式)、字典或列表表示。

示例:

邮局/狗/{

“name”:“fido”,“age”:2

}

邮局/狗/{

“狗”:{

“姓名”:“幸运”,“年龄”:3

}

}

邮局/狗/{

“狗”:[

{“name”:“fido”,“age”:2},{“name”:“Lucky”,“age”:3}

]

}

邮局/狗/[

{“name”:“fido”,“age”:2},{“name”:“Lucky”,“age”:3}

]

状态代码
DELETE /api/v2/documents/

通过发送带有要删除的文档ID的json,批量删除单个或多个模型实例

删除/狗/{

“狗”:[

{“id”:1},{“id”:2}

]

}

删除/狗/[

{“id”:1},{“id”:2}

]

状态代码
GET /api/v2/documents/{id}/

返回特定文档详细信息的API端点。

参数
  • id (integer) -- 标识此文档的唯一整数值。

状态代码
PUT /api/v2/documents/{id}/

更新一个或多个模型实例。

如果设置了ENABLE_BULK_UPDATE,则可以在单个调用中更新多个先前获取的记录,前提是它们的ID。

如果设置了ENABLE_PATCH_ALL,即使不知道多条记录的ID,也可以在单个补丁调用中更新多条记录。

WARNING :ENABLE_PATCH_ALL应视为高级功能,请谨慎使用。此功能必须在视图集级别启用,并且还必须由客户端通过“patch-all”查询参数显式请求。

此参数可以具有下列值之一:

TRUE(或1):将在事务循环中获取记录,然后进行更新
  • 这个 Model.save 方法将被调用,模型信号将运行

  • 如果查询中有太多信号或记录,这可能会很慢

  • 这被认为是更安全和默认的行为

查询:记录将在单个查询中更新
  • 这个 QuerySet.update 方法将被调用,并且模型信号将不会运行

  • 这将是快速的,但可能会打破由信号控制的数据约束

  • 这被认为是不安全的,但在某些情况下是有用的。

服务器对所有修补程序请求的成功响应将不包括任何单独的记录。相反,响应内容将包含一个“meta”对象,该对象具有更新记录的“更新”计数。

示例:

更新一条狗:

补丁/狗/1/{

‘毛皮’:‘白色’

}

按ID更新多条狗:

补丁/狗/[

{‘id’:1,‘毛发’:‘白色’},{‘id’:2,‘毛发’:‘黑色’},{‘id’:3,‘毛发’:‘黄色’}

]

更新查询中的所有狗:

修补程序/dogs/?filter{fur.contains}=brown&patch-all=true{

‘毛皮’:‘黄金’

}

参数
  • id (integer) -- 标识此文档的唯一整数值。

状态代码
PATCH /api/v2/documents/{id}/

允许查看或编辑文档的API端点。

参数
  • id (integer) -- 标识此文档的唯一整数值。

状态代码
DELETE /api/v2/documents/{id}/

删除单个文档。

参数
  • id (integer) -- 标识此文档的唯一整数值。

状态代码
GET /api/v2/documents/{id}/linked_resources/

返回特定id的所有链接资源的API端点。

参数
  • id (integer) -- 标识此文档的唯一整数值。

状态代码
GET /api/v2/geoapps/

显示所有可用地理应用程序的API端点。

查询参数
  • ordering (string) -- 对结果进行排序时要使用的字段。

  • page (integer) -- 分页结果集中的页码。

  • page_size (integer) -- 每页返回的结果数。

  • search (string) -- 搜索词。

状态代码
POST /api/v2/geoapps/

使用Django睡觉>=2.2.5中序列化程序的My=True功能批量创建单个或多个模型实例。

数据可以由串行器名称(单数或复数形式)、字典或列表表示。

示例:

邮局/狗/{

“name”:“fido”,“age”:2

}

邮局/狗/{

“狗”:{

“姓名”:“幸运”,“年龄”:3

}

}

邮局/狗/{

“狗”:[

{“name”:“fido”,“age”:2},{“name”:“Lucky”,“age”:3}

]

}

邮局/狗/[

{“name”:“fido”,“age”:2},{“name”:“Lucky”,“age”:3}

]

状态代码
PATCH /api/v2/geoapps/

允许查看或编辑地理应用程序的API端点。

状态代码
DELETE /api/v2/geoapps/

批量删除单个或多个模型实例

删除/狗/{

“狗”:[

{“id”:1},{“id”:2}

]

}

删除/狗/[

{“id”:1},{“id”:2}

]

状态代码
GET /api/v2/geoapps/{id}/

显示特定地理应用程序详细信息的API端点。

参数
  • id (integer) -- 标识此地理位置应用程序的唯一整数值。

状态代码
PUT /api/v2/geoapps/{id}/

更新一个或多个模型实例。

如果设置了ENABLE_BULK_UPDATE,则可以在单个调用中更新多个先前获取的记录,前提是它们的ID。

如果设置了ENABLE_PATCH_ALL,即使不知道多条记录的ID,也可以在单个补丁调用中更新多条记录。

WARNING :ENABLE_PATCH_ALL应视为高级功能,请谨慎使用。此功能必须在视图集级别启用,并且还必须由客户端通过“patch-all”查询参数显式请求。

此参数可以具有下列值之一:

TRUE(或1):将在事务循环中获取记录,然后进行更新
  • 这个 Model.save 方法将被调用,模型信号将运行

  • 如果查询中有太多信号或记录,这可能会很慢

  • 这被认为是更安全和默认的行为

查询:记录将在单个查询中更新
  • 这个 QuerySet.update 方法将被调用,并且模型信号将不会运行

  • 这将是快速的,但可能会打破由信号控制的数据约束

  • 这被认为是不安全的,但在某些情况下是有用的。

服务器对所有修补程序请求的成功响应将不包括任何单独的记录。相反,响应内容将包含一个“meta”对象,该对象具有更新记录的“更新”计数。

示例:

更新一条狗:

补丁/狗/1/{

‘毛皮’:‘白色’

}

按ID更新多条狗:

补丁/狗/[

{‘id’:1,‘毛发’:‘白色’},{‘id’:2,‘毛发’:‘黑色’},{‘id’:3,‘毛发’:‘黄色’}

]

更新查询中的所有狗:

修补程序/dogs/?filter{fur.contains}=brown&patch-all=true{

‘毛皮’:‘黄金’

}

参数
  • id (integer) -- 标识此地理位置应用程序的唯一整数值。

状态代码
PATCH /api/v2/geoapps/{id}/

允许查看或编辑地理应用程序的API端点。

参数
  • id (integer) -- 标识此地理位置应用程序的唯一整数值。

状态代码
DELETE /api/v2/geoapps/{id}/

删除单个实例

删除/狗/{

“狗”:[

{“id”:1},{“id”:2}

]

}

删除/狗/[

{“id”:1},{“id”:2}

]

参数
  • id (integer) -- 标识此地理位置应用程序的唯一整数值。

状态代码
GET /api/v2/geoapps/{id}/{field_name}/

获取相关对象,就像侧面加载一样(用于支持链接对象)。

此方法映射到 /<resource>/<pk>/<field_name>/ 所有DynamicRelationField字段的DynamicRouter。通常,此方法可能不应该被覆盖。

另一种实现方式是生成反向查询。有关该方法的探索,请参阅:

参数
  • field_name (string) --

  • id (integer) -- 标识此地理位置应用程序的唯一整数值。

状态代码
GET /api/v2/geostories/

返回所有可用地理故事以及详细信息的API端点(分页)。

查询参数
  • ordering (string) -- 对结果进行排序时要使用的字段。

  • page (integer) -- 分页结果集中的页码。

  • page_size (integer) -- 每页返回的结果数。

  • search (string) -- 搜索词。

状态代码
POST /api/v2/geostories/

使用Django睡觉>=2.2.5中序列化程序的My=True功能批量创建单个或多个模型实例。

数据可以由串行器名称(单数或复数形式)、字典或列表表示。

示例:

邮局/狗/{

“name”:“fido”,“age”:2

}

邮局/狗/{

“狗”:{

“姓名”:“幸运”,“年龄”:3

}

}

邮局/狗/{

“狗”:[

{“name”:“fido”,“age”:2},{“name”:“Lucky”,“age”:3}

]

}

邮局/狗/[

{“name”:“fido”,“age”:2},{“name”:“Lucky”,“age”:3}

]

状态代码
PATCH /api/v2/geostories/

允许查看或编辑地理应用程序的API端点。

状态代码
DELETE /api/v2/geostories/

批量删除单个或多个模型实例

删除/狗/{

“狗”:[

{“id”:1},{“id”:2}

]

}

删除/狗/[

{“id”:1},{“id”:2}

]

状态代码
GET /api/v2/geostories/{id}/

返回特定地理故事详细信息的API端点。

参数
  • id (integer) -- 标识此地理故事的唯一整数值。

状态代码
PUT /api/v2/geostories/{id}/

更新一个或多个模型实例。

如果设置了ENABLE_BULK_UPDATE,则可以在单个调用中更新多个先前获取的记录,前提是它们的ID。

如果设置了ENABLE_PATCH_ALL,即使不知道多条记录的ID,也可以在单个补丁调用中更新多条记录。

WARNING :ENABLE_PATCH_ALL应视为高级功能,请谨慎使用。此功能必须在视图集级别启用,并且还必须由客户端通过“patch-all”查询参数显式请求。

此参数可以具有下列值之一:

TRUE(或1):将在事务循环中获取记录,然后进行更新
  • 这个 Model.save 方法将被调用,模型信号将运行

  • 如果查询中有太多信号或记录,这可能会很慢

  • 这被认为是更安全和默认的行为

查询:记录将在单个查询中更新
  • 这个 QuerySet.update 方法将被调用,并且模型信号将不会运行

  • 这将是快速的,但可能会打破由信号控制的数据约束

  • 这被认为是不安全的,但在某些情况下是有用的。

服务器对所有修补程序请求的成功响应将不包括任何单独的记录。相反,响应内容将包含一个“meta”对象,该对象具有更新记录的“更新”计数。

示例:

更新一条狗:

补丁/狗/1/{

‘毛皮’:‘白色’

}

按ID更新多条狗:

补丁/狗/[

{‘id’:1,‘毛发’:‘白色’},{‘id’:2,‘毛发’:‘黑色’},{‘id’:3,‘毛发’:‘黄色’}

]

更新查询中的所有狗:

修补程序/dogs/?filter{fur.contains}=brown&patch-all=true{

‘毛皮’:‘黄金’

}

参数
  • id (integer) -- 标识此地理故事的唯一整数值。

状态代码
PATCH /api/v2/geostories/{id}/

允许查看或编辑地理应用程序的API端点。

参数
  • id (integer) -- 标识此地理故事的唯一整数值。

状态代码
DELETE /api/v2/geostories/{id}/

批量删除单个或多个模型实例

删除/狗/{

“狗”:[

{“id”:1},{“id”:2}

]

}

删除/狗/[

{“id”:1},{“id”:2}

]

参数
  • id (integer) -- 标识此地理故事的唯一整数值。

状态代码
GET /api/v2/geostories/{id}/{field_name}/

获取相关对象,就像侧面加载一样(用于支持链接对象)。

此方法映射到 /<resource>/<pk>/<field_name>/ 所有DynamicRelationField字段的DynamicRouter。通常,此方法可能不应该被覆盖。

另一种实现方式是生成反向查询。有关该方法的探索,请参阅:

参数
  • field_name (string) --

  • id (integer) -- 标识此地理故事的唯一整数值。

状态代码
GET /api/v2/groups/

返回所有可用组以及详细信息的API端点(分页)。

查询参数
  • ordering (string) -- 对结果进行排序时要使用的字段。

  • page (integer) -- 分页结果集中的页码。

  • page_size (integer) -- 每页返回的结果数。

状态代码
POST /api/v2/groups/

使用Django睡觉>=2.2.5中序列化程序的My=True功能批量创建单个或多个模型实例。

数据可以由串行器名称(单数或复数形式)、字典或列表表示。

示例:

邮局/狗/{

“name”:“fido”,“age”:2

}

邮局/狗/{

“狗”:{

“姓名”:“幸运”,“年龄”:3

}

}

邮局/狗/{

“狗”:[

{“name”:“fido”,“age”:2},{“name”:“Lucky”,“age”:3}

]

}

邮局/狗/[

{“name”:“fido”,“age”:2},{“name”:“Lucky”,“age”:3}

]

状态代码
PATCH /api/v2/groups/

允许查看或编辑分组的API端点。

状态代码
DELETE /api/v2/groups/

批量删除单个或多个模型实例

删除/狗/{

“狗”:[

{“id”:1},{“id”:2}

]

}

删除/狗/[

{“id”:1},{“id”:2}

]

状态代码
GET /api/v2/groups/{id}/

返回特定组详细信息的API端点。

参数
  • id (integer) -- 标识此组配置文件的唯一整数值。

状态代码
PUT /api/v2/groups/{id}/

更新一个或多个模型实例。

如果设置了ENABLE_BULK_UPDATE,则可以在单个调用中更新多个先前获取的记录,前提是它们的ID。

如果设置了ENABLE_PATCH_ALL,即使不知道多条记录的ID,也可以在单个补丁调用中更新多条记录。

WARNING :ENABLE_PATCH_ALL应视为高级功能,请谨慎使用。此功能必须在视图集级别启用,并且还必须由客户端通过“patch-all”查询参数显式请求。

此参数可以具有下列值之一:

TRUE(或1):将在事务循环中获取记录,然后进行更新
  • 这个 Model.save 方法将被调用,模型信号将运行

  • 如果查询中有太多信号或记录,这可能会很慢

  • 这被认为是更安全和默认的行为

查询:记录将在单个查询中更新
  • 这个 QuerySet.update 方法将被调用,并且模型信号将不会运行

  • 这将是快速的,但可能会打破由信号控制的数据约束

  • 这被认为是不安全的,但在某些情况下是有用的。

服务器对所有修补程序请求的成功响应将不包括任何单独的记录。相反,响应内容将包含一个“meta”对象,该对象具有更新记录的“更新”计数。

示例:

更新一条狗:

补丁/狗/1/{

‘毛皮’:‘白色’

}

按ID更新多条狗:

补丁/狗/[

{‘id’:1,‘毛发’:‘白色’},{‘id’:2,‘毛发’:‘黑色’},{‘id’:3,‘毛发’:‘黄色’}

]

更新查询中的所有狗:

修补程序/dogs/?filter{fur.contains}=brown&patch-all=true{

‘毛皮’:‘黄金’

}

参数
  • id (integer) -- 标识此组配置文件的唯一整数值。

状态代码
PATCH /api/v2/groups/{id}/

允许查看或编辑分组的API端点。

参数
  • id (integer) -- 标识此组配置文件的唯一整数值。

状态代码
DELETE /api/v2/groups/{id}/

删除单个实例

参数
  • id (integer) -- 标识此组配置文件的唯一整数值。

状态代码
GET /api/v2/groups/{id}/managers/

显示所选组经理的API端点。

参数
  • id (integer) -- 标识此组配置文件的唯一整数值。

状态代码
GET /api/v2/groups/{id}/members/

显示选定组的成员和经理的API端点。

参数
  • id (integer) -- 标识此组配置文件的唯一整数值。

状态代码
GET /api/v2/groups/{id}/resources/

显示连接到选定组的所有资源的API端点。

参数
  • id (integer) -- 标识此组配置文件的唯一整数值。

状态代码
GET /api/v2/layers/

返回所有可用层和详细信息的API端点(分页)。

查询参数
  • ordering (string) -- 对结果进行排序时要使用的字段。

  • page (integer) -- 分页结果集中的页码。

  • page_size (integer) -- 每页返回的结果数。

  • search (string) -- 搜索词。

状态代码
POST /api/v2/layers/

使用Django睡觉>=2.2.5中序列化程序的My=True功能批量创建单个或多个模型实例。

数据可以由串行器名称(单数或复数形式)、字典或列表表示。

示例:

邮局/狗/{

“name”:“fido”,“age”:2

}

邮局/狗/{

“狗”:{

“姓名”:“幸运”,“年龄”:3

}

}

邮局/狗/{

“狗”:[

{“name”:“fido”,“age”:2},{“name”:“Lucky”,“age”:3}

]

}

邮局/狗/[

{“name”:“fido”,“age”:2},{“name”:“Lucky”,“age”:3}

]

状态代码
PATCH /api/v2/layers/

允许查看或编辑层的API端点。

状态代码
DELETE /api/v2/layers/

批量删除单个或多个模型实例

删除/狗/{

“狗”:[

{“id”:1},{“id”:2}

]

}

删除/狗/[

{“id”:1},{“id”:2}

]

状态代码
GET /api/v2/layers/{id}/

返回特定图层详细信息的API端点

参数
  • id (integer) -- 标识此层的唯一整数值。

状态代码
PUT /api/v2/layers/{id}/

更新一个或多个模型实例。

如果设置了ENABLE_BULK_UPDATE,则可以在单个调用中更新多个先前获取的记录,前提是它们的ID。

如果设置了ENABLE_PATCH_ALL,即使不知道多条记录的ID,也可以在单个补丁调用中更新多条记录。

WARNING :ENABLE_PATCH_ALL应视为高级功能,请谨慎使用。此功能必须在视图集级别启用,并且还必须由客户端通过“patch-all”查询参数显式请求。

此参数可以具有下列值之一:

TRUE(或1):将在事务循环中获取记录,然后进行更新
  • 这个 Model.save 方法将被调用,模型信号将运行

  • 如果查询中有太多信号或记录,这可能会很慢

  • 这被认为是更安全和默认的行为

查询:记录将在单个查询中更新
  • 这个 QuerySet.update 方法将被调用,并且模型信号将不会运行

  • 这将是快速的,但可能会打破由信号控制的数据约束

  • 这被认为是不安全的,但在某些情况下是有用的。

服务器对所有修补程序请求的成功响应将不包括任何单独的记录。相反,响应内容将包含一个“meta”对象,该对象具有更新记录的“更新”计数。

示例:

更新一条狗:

补丁/狗/1/{

‘毛皮’:‘白色’

}

按ID更新多条狗:

补丁/狗/[

{‘id’:1,‘毛发’:‘白色’},{‘id’:2,‘毛发’:‘黑色’},{‘id’:3,‘毛发’:‘黄色’}

]

更新查询中的所有狗:

修补程序/dogs/?filter{fur.contains}=brown&patch-all=true{

‘毛皮’:‘黄金’

}

参数
  • id (integer) -- 标识此层的唯一整数值。

状态代码
PATCH /api/v2/layers/{id}/

允许查看或编辑层的API端点。

参数
  • id (integer) -- 标识此层的唯一整数值。

状态代码
DELETE /api/v2/layers/{id}/

删除单个模型实例

删除/狗/{

“狗”:[

{“id”:1},{“id”:2}

]

}

删除/狗/[

{“id”:1},{“id”:2}

]

参数
  • id (integer) -- 标识此层的唯一整数值。

状态代码
GET /api/v2/layers/{id}/{field_name}/

获取相关对象,就像侧面加载一样(用于支持链接对象)。

此方法映射到 /<resource>/<pk>/<field_name>/ 所有DynamicRelationField字段的DynamicRouter。通常,此方法可能不应该被覆盖。

另一种实现方式是生成反向查询。有关该方法的探索,请参阅:

参数
  • field_name (string) --

  • id (integer) -- 标识此层的唯一整数值。

状态代码
GET /api/v2/maps/

返回所有可用地图以及详细信息的API端点(分页)。

查询参数
  • ordering (string) -- 对结果进行排序时要使用的字段。

  • page (integer) -- 分页结果集中的页码。

  • page_size (integer) -- 每页返回的结果数。

  • search (string) -- 搜索词。

状态代码
POST /api/v2/maps/

使用Django睡觉>=2.2.5中序列化程序的My=True功能批量创建单个或多个模型实例。

数据可以由串行器名称(单数或复数形式)、字典或列表表示。

示例:

邮局/狗/{

“name”:“fido”,“age”:2

}

邮局/狗/{

“狗”:{

“姓名”:“幸运”,“年龄”:3

}

}

邮局/狗/{

“狗”:[

{“name”:“fido”,“age”:2},{“name”:“Lucky”,“age”:3}

]

}

邮局/狗/[

{“name”:“fido”,“age”:2},{“name”:“Lucky”,“age”:3}

]

状态代码
PATCH /api/v2/maps/

允许查看或编辑地图的API端点。

状态代码
DELETE /api/v2/maps/

批量删除单个或多个模型实例

删除/狗/{

“狗”:[

{“id”:1},{“id”:2}

]

}

删除/狗/[

{“id”:1},{“id”:2}

]

状态代码
GET /api/v2/maps/{id}/

返回特定地图详细信息的API端点。

参数
  • id (integer) -- 标识此映射的唯一整数值。

状态代码
PUT /api/v2/maps/{id}/

更新一个或多个模型实例。

如果设置了ENABLE_BULK_UPDATE,则可以在单个调用中更新多个先前获取的记录,前提是它们的ID。

如果设置了ENABLE_PATCH_ALL,即使不知道多条记录的ID,也可以在单个补丁调用中更新多条记录。

WARNING :ENABLE_PATCH_ALL应视为高级功能,请谨慎使用。此功能必须在视图集级别启用,并且还必须由客户端通过“patch-all”查询参数显式请求。

此参数可以具有下列值之一:

TRUE(或1):将在事务循环中获取记录,然后进行更新
  • 这个 Model.save 方法将被调用,模型信号将运行

  • 如果查询中有太多信号或记录,这可能会很慢

  • 这被认为是更安全和默认的行为

查询:记录将在单个查询中更新
  • 这个 QuerySet.update 方法将被调用,并且模型信号将不会运行

  • 这将是快速的,但可能会打破由信号控制的数据约束

  • 这被认为是不安全的,但在某些情况下是有用的。

服务器对所有修补程序请求的成功响应将不包括任何单独的记录。相反,响应内容将包含一个“meta”对象,该对象具有更新记录的“更新”计数。

示例:

更新一条狗:

补丁/狗/1/{

‘毛皮’:‘白色’

}

按ID更新多条狗:

补丁/狗/[

{‘id’:1,‘毛发’:‘白色’},{‘id’:2,‘毛发’:‘黑色’},{‘id’:3,‘毛发’:‘黄色’}

]

更新查询中的所有狗:

修补程序/dogs/?filter{fur.contains}=brown&patch-all=true{

‘毛皮’:‘黄金’

}

参数
  • id (integer) -- 标识此映射的唯一整数值。

状态代码
PATCH /api/v2/maps/{id}/

允许查看或编辑地图的API端点。

参数
  • id (integer) -- 标识此映射的唯一整数值。

状态代码
DELETE /api/v2/maps/{id}/

删除单个实例。

参数
  • id (integer) -- 标识此映射的唯一整数值。

状态代码
GET /api/v2/maps/{id}/layers/

返回组成地图的图层列表,其中包含一些信息,如不透明度、名称、可见性。在LAYER_PARAMS字段中,是否提供有关图层的信息

参数
  • id (integer) -- 标识此映射的唯一整数值。

状态代码
GET /api/v2/maps/{id}/local_layers/

允许检索本地地图图层详细列表的API端点

参数
  • id (integer) -- 标识此映射的唯一整数值。

状态代码
GET /api/v2/resources/

显示GeoNode中所有可用资源的API端点,包括地图、图层、地理故事和文档(分页)。

查询参数
  • ordering (string) -- 对结果进行排序时要使用的字段。

  • page (integer) -- 分页结果集中的页码。

  • page_size (integer) -- 每页返回的结果数。

  • search (string) -- 搜索词。

状态代码
POST /api/v2/resources/

使用Django睡觉>=2.2.5中序列化程序的My=True功能批量创建单个或多个模型实例。

数据可以由串行器名称(单数或复数形式)、字典或列表表示。

示例:

邮局/狗/{

“name”:“fido”,“age”:2

}

邮局/狗/{

“狗”:{

“姓名”:“幸运”,“年龄”:3

}

}

邮局/狗/{

“狗”:[

{“name”:“fido”,“age”:2},{“name”:“Lucky”,“age”:3}

]

}

邮局/狗/[

{“name”:“fido”,“age”:2},{“name”:“Lucky”,“age”:3}

]

状态代码
PATCH /api/v2/resources/

允许查看或编辑基资源的API端点。

状态代码
DELETE /api/v2/resources/

批量删除单个或多个模型实例

删除/狗/{

“狗”:[

{“id”:1},{“id”:2}

]

}

删除/狗/[

{“id”:1},{“id”:2}

]

状态代码
GET /api/v2/resources/{id}/

返回特定资源详细信息的API端点,包括keywods、owner和bbox_polygon。

参数
  • id (integer) -- 标识此资源库的唯一整数值。

状态代码
PUT /api/v2/resources/{id}/

更新一个或多个模型实例。

如果设置了ENABLE_BULK_UPDATE,则可以在单个调用中更新多个先前获取的记录,前提是它们的ID。

如果设置了ENABLE_PATCH_ALL,即使不知道多条记录的ID,也可以在单个补丁调用中更新多条记录。

WARNING :ENABLE_PATCH_ALL应视为高级功能,请谨慎使用。此功能必须在视图集级别启用,并且还必须由客户端通过“patch-all”查询参数显式请求。

此参数可以具有下列值之一:

TRUE(或1):将在事务循环中获取记录,然后进行更新
  • 这个 Model.save 方法将被调用,模型信号将运行

  • 如果查询中有太多信号或记录,这可能会很慢

  • 这被认为是更安全和默认的行为

查询:记录将在单个查询中更新
  • 这个 QuerySet.update 方法将被调用,并且模型信号将不会运行

  • 这将是快速的,但可能会打破由信号控制的数据约束

  • 这被认为是不安全的,但在某些情况下是有用的。

服务器对所有修补程序请求的成功响应将不包括任何单独的记录。相反,响应内容将包含一个“meta”对象,该对象具有更新记录的“更新”计数。

示例:

更新一条狗:

补丁/狗/1/{

‘毛皮’:‘白色’

}

按ID更新多条狗:

补丁/狗/[

{‘id’:1,‘毛发’:‘白色’},{‘id’:2,‘毛发’:‘黑色’},{‘id’:3,‘毛发’:‘黄色’}

]

更新查询中的所有狗:

修补程序/dogs/?filter{fur.contains}=brown&patch-all=true{

‘毛皮’:‘黄金’

}

参数
  • id (integer) -- 标识此资源库的唯一整数值。

状态代码
PATCH /api/v2/resources/{id}/

允许查看或编辑基资源的API端点。

参数
  • id (integer) -- 标识此资源库的唯一整数值。

状态代码
DELETE /api/v2/resources/{id}/

删除单个实例

参数
  • id (integer) -- 标识此资源库的唯一整数值。

状态代码
GET /api/v2/resources/{id}/get_perms/

显示为特定资源定义的所有权限(按组和用户拆分)的API端点。

参数
  • id (integer) -- 标识此资源库的唯一整数值。

状态代码
PUT /api/v2/resources/{id}/set_perms/

允许用户设置特定资源权限的API端点。

参数
  • id (integer) -- 标识此资源库的唯一整数值。

状态代码
GET /api/v2/resources/approved/

将返回已批准的可用资源列表。

状态代码

将返回可用的特色资源列表。

状态代码
GET /api/v2/resources/published/

将返回可用的已发布资源列表。

状态代码
GET /api/v2/resources/resource_types/

将返回GeoNode管理的资源类型的列表。

状态代码
GET /api/v2/schema/

此接口的OpenApi3模式。可以通过内容协商选择格式。

  • YAML:application/vnd.oai.openapi

  • json:application/vnd.oai.openapi+json

查询参数
  • format (string) --

  • lang (string) --

状态代码
GET /api/v2/uploads/

上载实例及其状态的列表。

查询参数
  • ordering (string) -- 对结果进行排序时要使用的字段。

  • page (integer) -- 分页结果集中的页码。

  • page_size (integer) -- 每页返回的结果数。

  • search (string) -- 搜索词。

状态代码
POST /api/v2/uploads/

使用Django睡觉>=2.2.5中序列化程序的My=True功能批量创建单个或多个模型实例。

数据可以由串行器名称(单数或复数形式)、字典或列表表示。

示例:

邮局/狗/{

“name”:“fido”,“age”:2

}

邮局/狗/{

“狗”:{

“姓名”:“幸运”,“年龄”:3

}

}

邮局/狗/{

“狗”:[

{“name”:“fido”,“age”:2},{“name”:“Lucky”,“age”:3}

]

}

邮局/狗/[

{“name”:“fido”,“age”:2},{“name”:“Lucky”,“age”:3}

]

状态代码
PATCH /api/v2/uploads/

允许查看或编辑上载的API端点。

状态代码
DELETE /api/v2/uploads/

批量删除单个或多个模型实例

删除/狗/{

“狗”:[

{“id”:1},{“id”:2}

]

}

删除/狗/[

{“id”:1},{“id”:2}

]

状态代码
GET /api/v2/uploads/{id}/

将显示有关上载状态的详细信息的经过身份验证的API终结点。可用的主要信息包括:

  • id:上传id

  • 名称:图层名称

  • 日期:导入流程的开始日期

  • 状态:导入过程的实际状态。状态为已处理时,表示图层已由GeoNode和Geoserver处理

  • 进度:进度百分比

  • Uploadfile_Set:上传的文件列表

  • 删除url:要调用以删除导入的URL

  • import_url:用于监控Geoserver中的导入状态。

仍在进行的导入示例:
{
上传:{

“id”:1119,“name”:“layer_name”,“date”:“2021-04-26T09:50:41.233543Z”,“create_date”:“2021-04-26T09:50:40.515866Z”,“user”:1167,“state”:“Complete”,“Progress”:80.0,“Complete”:true,“import_id”:1089,“ploadfile_set”:[],“Resume_url“DELETE_URL”:“/UPLOAD/DELETE/1119”,“IMPORT_URL”:“http://geoserver:8080/geoserver/rest/imports/1089”,“详细信息URL”:空

}

}

参数
  • id (integer) -- 标识此上载的唯一整数值。

状态代码
PUT /api/v2/uploads/{id}/

更新一个或多个模型实例。

如果设置了ENABLE_BULK_UPDATE,则可以在单个调用中更新多个先前获取的记录,前提是它们的ID。

如果设置了ENABLE_PATCH_ALL,即使不知道多条记录的ID,也可以在单个补丁调用中更新多条记录。

WARNING :ENABLE_PATCH_ALL应视为高级功能,请谨慎使用。此功能必须在视图集级别启用,并且还必须由客户端通过“patch-all”查询参数显式请求。

此参数可以具有下列值之一:

TRUE(或1):将在事务循环中获取记录,然后进行更新
  • 这个 Model.save 方法将被调用,模型信号将运行

  • 如果查询中有太多信号或记录,这可能会很慢

  • 这被认为是更安全和默认的行为

查询:记录将在单个查询中更新
  • 这个 QuerySet.update 方法将被调用,并且模型信号将不会运行

  • 这将是快速的,但可能会打破由信号控制的数据约束

  • 这被认为是不安全的,但在某些情况下是有用的。

服务器对所有修补程序请求的成功响应将不包括任何单独的记录。相反,响应内容将包含一个“meta”对象,该对象具有更新记录的“更新”计数。

示例:

更新一条狗:

补丁/狗/1/{

‘毛皮’:‘白色’

}

按ID更新多条狗:

补丁/狗/[

{‘id’:1,‘毛发’:‘白色’},{‘id’:2,‘毛发’:‘黑色’},{‘id’:3,‘毛发’:‘黄色’}

]

更新查询中的所有狗:

修补程序/dogs/?filter{fur.contains}=brown&patch-all=true{

‘毛皮’:‘黄金’

}

参数
  • id (integer) -- 标识此上载的唯一整数值。

状态代码
PATCH /api/v2/uploads/{id}/

允许查看或编辑上载的API端点。

参数
  • id (integer) -- 标识此上载的唯一整数值。

状态代码
DELETE /api/v2/uploads/{id}/

批量删除单个或多个模型实例

删除/狗/{

“狗”:[

{“id”:1},{“id”:2}

]

}

删除/狗/[

{“id”:1},{“id”:2}

]

参数
  • id (integer) -- 标识此上载的唯一整数值。

状态代码
GET /api/v2/uploads/{id}/{field_name}/

获取相关对象,就像侧面加载一样(用于支持链接对象)。

此方法映射到 /<resource>/<pk>/<field_name>/ 所有DynamicRelationField字段的DynamicRouter。通常,此方法可能不应该被覆盖。

另一种实现方式是生成反向查询。有关该方法的探索,请参阅:

参数
  • field_name (string) --

  • id (integer) -- 标识此上载的唯一整数值。

状态代码
PUT /api/v2/uploads/upload/

允许用户将新图层上传到GeoNode的API端点。端点通过身份验证进行保护,请求应始终来自同一会话。API接受带有表单数据的请求。也可以通过json定义一些信息。在幕后,Geonode将:

  • 创建上载会话

  • 将图层保存到GeoNode

  • 调用异步地理服务器保存图层

示例:

client=requests.session()response=client.put(

http://localhost:8000/api/v2/uploads/upload/”,身份验证=HTTPBasicAuth(用户名,密码),数据=参数,文件=文件,

)其中:

参数={

"permissions": '{ "users": {"AnonymousUser": ["view_resourcebase"]} , "groups":{}}', # layer permissions "time": "false", "layer_title": "layer_title", "time": "false", "charset": "UTF-8",

}个文件={

“filename”:<_io.BufferedReader name=“filename”>

}

状态代码
PUT /upload/final?id={import_id}

允许用户将新图层的状态签入GeoNode的API端点。端点通过身份验证进行保护,请求应始终来自同一会话。示例:

Client=requests.session()Response=client.get(“http://localhost:8000/upload/final?id=1”),其中:

参数={

"permissions": '{ "users": {"AnonymousUser": ["view_resourcebase"]} , "groups":{}}', # layer permissions "time": "false", "layer_title": "layer_title", "time": "false", "charset": "UTF-8",

}

状态代码
  • 200 OK -- {“status”:“已完成”,“id”:131,“url”:“文件名_路径”,“bbox”:“-180.0000000,-90.0000000,180.0000000,90.0000000”,“crs”:{“type”:“name”,“properties”:“epsg:4326”},“Success”:TRUE}

GET /api/v2/users/

显示在GeoNode中注册的用户列表的API端点。如果登录的用户是,管理员将显示所有可用的用户,否则只提供其自己帐户的信息

查询参数
  • ordering (string) -- 对结果进行排序时要使用的字段。

  • page (integer) -- 分页结果集中的页码。

  • page_size (integer) -- 每页返回的结果数。

状态代码
POST /api/v2/users/

使用Django睡觉>=2.2.5中序列化程序的My=True功能批量创建单个或多个模型实例。

数据可以由串行器名称(单数或复数形式)、字典或列表表示。

示例:

邮局/狗/{

“name”:“fido”,“age”:2

}

邮局/狗/{

“狗”:{

“姓名”:“幸运”,“年龄”:3

}

}

邮局/狗/{

“狗”:[

{“name”:“fido”,“age”:2},{“name”:“Lucky”,“age”:3}

]

}

邮局/狗/[

{“name”:“fido”,“age”:2},{“name”:“Lucky”,“age”:3}

]

状态代码
DELETE /api/v2/users/

批量删除单个或多个模型实例

删除/狗/{

“狗”:[

{“id”:1},{“id”:2}

]

}

删除/狗/[

{“id”:1},{“id”:2}

]

状态代码
GET /api/v2/users/{id}/

返回特定用户详细信息的API端点。

参数
  • id (integer) -- 标识此用户的唯一整数值。

状态代码
PUT /api/v2/users/{id}/

更新一个或多个模型实例。

如果设置了ENABLE_BULK_UPDATE,则可以在单个调用中更新多个先前获取的记录,前提是它们的ID。

如果设置了ENABLE_PATCH_ALL,即使不知道多条记录的ID,也可以在单个补丁调用中更新多条记录。

WARNING :ENABLE_PATCH_ALL应视为高级功能,请谨慎使用。此功能必须在视图集级别启用,并且还必须由客户端通过“patch-all”查询参数显式请求。

此参数可以具有下列值之一:

TRUE(或1):将在事务循环中获取记录,然后进行更新
  • 这个 Model.save 方法将被调用,模型信号将运行

  • 如果查询中有太多信号或记录,这可能会很慢

  • 这被认为是更安全和默认的行为

查询:记录将在单个查询中更新
  • 这个 QuerySet.update 方法将被调用,并且模型信号将不会运行

  • 这将是快速的,但可能会打破由信号控制的数据约束

  • 这被认为是不安全的,但在某些情况下是有用的。

服务器对所有修补程序请求的成功响应将不包括任何单独的记录。相反,响应内容将包含一个“meta”对象,该对象具有更新记录的“更新”计数。

示例:

更新一条狗:

补丁/狗/1/{

‘毛皮’:‘白色’

}

按ID更新多条狗:

补丁/狗/[

{‘id’:1,‘毛发’:‘白色’},{‘id’:2,‘毛发’:‘黑色’},{‘id’:3,‘毛发’:‘黄色’}

]

更新查询中的所有狗:

修补程序/dogs/?filter{fur.contains}=brown&patch-all=true{

‘毛皮’:‘黄金’

}

参数
  • id (integer) -- 标识此用户的唯一整数值。

状态代码
DELETE /api/v2/users/{id}/

删除模型实例。

删除/狗/{

“狗”:[

{“id”:1},{“id”:2}

]

}

删除/狗/[

{“id”:1},{“id”:2}

]

参数
  • id (integer) -- 标识此用户的唯一整数值。

状态代码
GET /api/v2/users/{id}/groups/

显示用户所属组列表的API端点。

参数
  • id (integer) -- 标识此用户的唯一整数值。

状态代码
GET /api/v2/users/{id}/resources/

显示属于用户的资源列表的API端点。

参数
  • id (integer) -- 标识此用户的唯一整数值。

状态代码
GET /mapstore/rest/resources/

仅验证用户对各自数据执行CRUD操作

状态代码
POST /mapstore/rest/resources/

仅验证用户对各自数据执行CRUD操作

状态代码
GET /mapstore/rest/resources/{id}/

仅验证用户对各自数据执行CRUD操作

参数
  • id (integer) -- 标识此映射存储资源的唯一值。

状态代码
PUT /mapstore/rest/resources/{id}/

仅验证用户对各自数据执行CRUD操作

参数
  • id (integer) -- 标识此映射存储资源的唯一值。

状态代码
PATCH /mapstore/rest/resources/{id}/

仅验证用户对各自数据执行CRUD操作

参数
  • id (integer) -- 标识此映射存储资源的唯一值。

状态代码
DELETE /mapstore/rest/resources/{id}/

仅验证用户对各自数据执行CRUD操作

参数
  • id (integer) -- 标识此映射存储资源的唯一值。

状态代码
GET /mapstore/rest/users/

显示可用用户的API端点,并提供一些详细信息。

状态代码
POST /mapstore/rest/users/

允许查看或编辑用户的API端点。

状态代码
GET /mapstore/rest/users/{id}/

显示可用用户的API端点,并提供一些详细信息。

参数
  • id (integer) -- 标识此用户的唯一整数值。

状态代码
PUT /mapstore/rest/users/{id}/

允许查看或编辑用户的API端点。

参数
  • id (integer) -- 标识此用户的唯一整数值。

状态代码
DELETE /mapstore/rest/users/{id}/

允许查看或编辑用户的API端点。

参数
  • id (integer) -- 标识此用户的唯一整数值。

状态代码
GET /o/userinfo/

用于显示有关经过身份验证的最终用户的声明的视图

状态代码