X-Sign OpenAPI
X-sign 2.0 / X-Sign OpenAPI / Documentation / APIs
2021 / 04 / 21
Request Parameter
Name | Schema | Description |
Name company id | Schema Required. Type: integer | Description company id |
Name page | Schema Optional Type: integer Default: 1 | Description |
Name limit | Schema Optional Type: integer|Range: 20~200 Default: 50 | Description limit the number of records returned |
Name field | Schema Optional. Type: array|In:['thumbnail'] | Description return external fields |
curl -X GET "/archive/list"
-H "Content-Type: application/json"
-H "Authorization: Bearer sdk308123903"
-d '{
"company_id":3,
"page":2,
"field":["thumbnail"]
}'
Response Code
General HTTP Status Code
Code | Description |
Code 200 | Description Success |
Response Value -200
Name | Schema | Description |
Name *page | Schema integer | Description returned page number |
Name *limit | Schema integer | Description limit the number of records returned |
Name *total_cnt | Schema integer | Description total number of archive in user's company |
Name *data | Schema array | Description an array of archive model ref: Model - archive |
{
"page":1,
"limit":50,
"total_cnt": 3333,
"data":[
{
"id":1,
"company_id":3,
"folder_id":null,
"name":"test.png",
"type":"image/png",
"size":12322,
"thumbnail":"https://s3.test/test.png?token=testtestestaa&expired=864000",
"created_at": "2019-11-29 10:10:10",
"updated_at": "2019-11-29 10:10:10"
},
{
"id":2,
"company_id":3,
"folder_id":null,
"name":"test2.png",
"type":"image/png",
"size":34322,
"thumbnail":"https://s3.test/test2.png?token=test22testestaa&expired=864000",
"created_at": "2019-11-29 10:20:20",
"updated_at": "2019-11-29 10:20:20"
}
]
}
BenQ America Corp.
5741 Legacy Dr #210, Plano, TX 75024, USA
Tel: 888-818-5888
Fax: +1-214-473-9998