Coda

List featured docs for a Pack

开发环境

http://dev-cn.your-api-server.com

GET

/packs/{packId}/featuredDocs

Packs

Returns a list of featured doc ids for a Pack.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://dev-cn.your-api-server.com/packs/123/featuredDocs'

响应示例

200 - 示例 1

{
    "items": [
        {
            "doc": {
                "id": "AbCDeFGH",
                "href": "https://coda.io/apis/v1/docs/AbCDeFGH",
                "browserLink": "https://coda.io/d/_dAbCDeFGH",
                "type": "doc"
            },
            "docStatus": "docInaccessibleOrDoesNotExist",
            "isPinned": true,
            "publishedUrl": "string"
        }
    ]
}

请求参数

Path 参数

packId

integer

必需

ID of a Pack

>= 1

示例值:

123

返回响应

🟢200The featured docs for a Pack.

application/json

Body

List of a Pack's featured docs.

items

array[object (PackFeaturedDoc) {4}]

必需

A list of featured docs for the Pack.

doc

object (DocReference)

必需

Reference to a Coda doc.

docStatus

enum<string>

可选

Status of featured doc in pack listing.

枚举值:

docInaccessibleOrDoesNotExistinvalidPublishedDocUrl

isPinned

boolean

必需

Whether or not this featured doc is pinned.

publishedUrl

string <url>

可选

The URL of the published doc, if available.

🟠400400

🟠401401

🟠403403

🟠404404

🟠429429

修改于 2024-03-20 08:13:15

Get detailed listing information for a Pack.

Update featured docs for a Pack