上传场景 - OASIS SIM

请求参数

Header 参数

Authorization

string

可选

示例值:

bearer {{token}}

Content-Type

string

可选

示例值:

application/json

User-Agent

string

可选

示例值:

Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.0.0 Safari/537.36

Body 参数multipart/form-data

parent_id

integer

必需

当前选择的文件夹的ID，必填

示例值:

0

files

file

必需

需要上传的场景文件，必填

示例值:

file:///home/jarvis/tmp/my_dev/maps/scenario_20240814_410.xosc

file_type

string

必需

文件类型有xosc和cartel，必填

示例值:

xosc

for_upload

boolean

必需

上传开关默认True，必填

示例值:

true

cover

boolean

必需

覆盖开关默认False，必填

示例值:

false

extend_content

string

必需

扩展内容，提供给第三方写入相关内容，，必填（create_user和source_id必填）

示例值:

{"create_user":"oasis", "source_id":1}

reassemble

boolean

必需

是否查询场景存在泛化场景，默认False，必填

示例值:

false

seed_id

integer

必需

指定的要查寻的场景的ID，如果reassemble参数为True时，必填

示例值:

9247

target_path_list

array[string]

可选

文件上传的目标路径，默认[]，非必填，第三方调用可选

示例值:

["",""]

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/scenarios/upload' \
--header 'Authorization: bearer {{token}}' \
--header 'User-Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.0.0 Safari/537.36' \
--form 'parent_id="0"' \
--form 'files=@"/home/jarvis/tmp/my_dev/maps/scenario_20240814_410.xosc"' \
--form 'file_type="xosc"' \
--form 'for_upload="true"' \
--form 'cover="false"' \
--form 'extend_content="{\"create_user\":\"oasis\", \"source_id\":1}"' \
--form 'reassemble="false"' \
--form 'seed_id="9247"'

返回响应

🟢200成功

application/json

Body

code

integer

响应码

必需

result

object

上传结果

必需

xxxx.xosc

object

场景名

必需

message

string

提示信息

必需

示例

成功示例异常示例-1

{
    "code": 200,
    "result": {
        "scenario_follow_long.xosc": {
            "content_error": [],
            "content_error_en": [],
            "name_exist_error": "",
            "upload_result": "success",
            "scenario_id": 9195
        }
    },
    "message": ""
}

🟢200成功