Coda
  1. Packs
Coda
  • Permissions
    • Get sharing metadata
    • Delete permission
    • Search principals
    • Get ACL settings
    • Update ACL settings
    • List permissions
    • Add permission
  • Pages
    • Content export status
    • List pages
    • Create a page
    • Begin content export
    • Get a page
    • Delete a page
    • Update a page
  • Tables
    • List tables
    • Get a table
  • Columns
    • List columns
    • Get a column
  • Rows
    • Push a button
    • List table rows
    • Insert/upsert rows
    • Delete multiple rows
    • Get a row
    • Delete row
    • Update row
  • Formulas
    • List formulas
    • Get a formula
  • Controls
    • List controls
    • Get a control
  • CustomDocDomains
    • List custom doc domains
    • Add custom domain
    • Deletes a custom domain
    • Updates a custom domain
    • Gets custom doc domains providers
  • Miscellaneous
    • Resolve browser link
    • Get mutation status
  • Automations
    • Trigger automation
  • Analytics
    • List doc analytics
    • List page analytics
    • Get doc analytics summary
    • List Pack analytics
    • Get Pack analytics summary
    • Get analytics last updated day
    • List Pack formula analytics
  • Workspaces
    • List workspace users
    • List workspace roles
    • Updates user role
  • Packs
    • List Packs
      GET
    • Create Pack
      POST
    • Gets the JSON Schema for Pack configuration.
      GET
    • List the versions for a Pack.
      GET
    • Get the next valid version for a Pack.
      POST
    • Get the difference between two pack versions.
      GET
    • Register Pack version
      POST
    • Pack version upload complete
      POST
    • Create a new Pack release.
      POST
    • List the releases for a Pack.
      GET
    • Update an existing Pack release.
      PUT
    • Set the OAuth configurations of the Pack.
      PUT
    • Retrieve the OAuth configuration of the Pack.
      GET
    • List permissions for a Pack
      GET
    • Add a permission for Pack
      POST
    • Delete a permission for Pack
      DELETE
    • List makers for Pack
      GET
    • Add a maker for Pack
      POST
    • Delete a maker for Pack
      DELETE
    • List categories for Pack
      GET
    • Add a category for Pack
      POST
    • Delete a category for Pack
      DELETE
    • Upload a Pack asset.
      POST
    • Upload Pack source code.
      POST
    • Pack asset upload complete
      POST
    • Pack source code upload complete
      POST
    • get the source code for a Pack version.
      GET
    • List the Pack listings accessible to a user.
      GET
    • Get detailed listing information for a Pack.
      GET
    • List featured docs for a Pack
      GET
    • Update featured docs for a Pack
      PUT
    • Get a single Pack
      GET
    • Update Pack
      PATCH
    • Delete Pack
      DELETE
    • Set the system connection credentials of the Pack.
      PUT
    • Patch the system connection credentials of the Pack.
      PATCH
    • Retrieve the system connection metadata of the Pack.
      GET
    • Retrieve the logs of a Pack.
      GET
    • Retrieve the grouped logs of a Pack.
      GET
  • Publishing
    • Get doc categories
    • Unpublish doc
    • Publish doc
  • Docs
    • Get info about a doc
    • Delete doc
    • Update doc
    • Create doc
    • List available docs
  • Account
    • Get user info
  1. Packs

Get a single Pack

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
GET
/packs/{packId}
Packs
Returns a single Pack.
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://dev-cn.your-api-server.com/packs/123'
响应示例响应示例
200 - 示例 1
{
    "sourceCodeVisibility": "private",
    "overallRateLimit": {
        "intervalSeconds": 3600,
        "operationsPerInterval": 20
    },
    "perConnectionRateLimit": {
        "intervalSeconds": 3600,
        "operationsPerInterval": 20
    },
    "featuredDocStatus": "docInaccessibleOrDoesNotExist",
    "id": 1003,
    "logoUrl": "string",
    "coverUrl": "string",
    "exampleImages": [
        {
            "filename": "string",
            "imageUrl": "string",
            "assetId": "string",
            "altText": "string",
            "mimeType": "image/jpeg"
        }
    ],
    "workspaceId": "ws-asdf",
    "categories": [
        {
            "categoryId": "aBCdEFg",
            "categoryName": "Project management",
            "categorySlug": "project-management"
        }
    ],
    "certified": true,
    "name": "Cool Geometry Formulas",
    "description": "This Pack allows users to calculate the surface area and volume of a few common 3D shapes, like cubes and pyramids.",
    "shortDescription": "Calculate cool geometric formulas like surface area.",
    "supportEmail": "user@email.com",
    "termsOfServiceUrl": "string",
    "privacyPolicyUrl": "string"
}

请求参数

Path 参数
packId
integer 
必需
ID of a Pack
>= 1
示例值:
123

返回响应

🟢200The requested Pack.
application/json
Body
Details about a Pack.
sourceCodeVisibility
enum<string> 
可选
Visibility of a pack's source code.
枚举值:
privateshared
overallRateLimit
object (PackRateLimit) 
可选
Rate limit in Pack settings.
intervalSeconds
integer 
必需
The rate limit interval in seconds.
>= 1<= 86400
示例值:
3600
operationsPerInterval
integer 
必需
The maximum number of Pack operations that can be performed in a given interval.
>= 0
示例值:
20
perConnectionRateLimit
object (PackRateLimit) 
可选
Rate limit in Pack settings.
featuredDocStatus
enum<string> 
可选
Status of featured doc in pack listing.
枚举值:
docInaccessibleOrDoesNotExistinvalidPublishedDocUrl
id
number 
必需
ID of the Pack.
示例值:
1003
logoUrl
string <url>
可选
The link to the logo of the Pack.
coverUrl
string <url>
可选
The link to the cover photo of the Pack.
exampleImages
array[object (PackImageFile) {5}] 
可选
The example images for the Pack.
filename
string 
必需
The name of the image file.
imageUrl
string <url>
必需
The URL to the image file.
assetId
string 
必需
The asset id of the Pack's image.
altText
string 
可选
The alt text for the image.
mimeType
string 
可选
The media type of the image.
示例值:
image/jpeg
workspaceId
string 
必需
The parent workspace for the Pack.
示例值:
ws-asdf
categories
array[object (PublishingCategory) {3}] 
必需
Publishing categories associated with this Pack.
categoryId
string 
必需
The ID for this category.
示例值:
aBCdEFg
categoryName
string 
必需
The name of the category.
示例值:
Project management
categorySlug
string 
可选
The URL identifier of the category.
示例值:
project-management
certified
boolean 
可选
Denotes if the pack is certified by Coda.
name
string 
必需
The name of the Pack.
<= 128 字符
示例值:
Cool Geometry Formulas
description
string 
必需
The full description of the Pack.
<= 8192 字符
示例值:
This Pack allows users to calculate the surface area and volume of a few common 3D shapes, like cubes and pyramids.
shortDescription
string 
必需
A short version of the description of the Pack.
<= 256 字符
示例值:
Calculate cool geometric formulas like surface area.
supportEmail
string 
可选
A contact email for the Pack.
<= 512 字符
示例值:
user@email.com
termsOfServiceUrl
string <url>
可选
A Terms of Service URL for the Pack.
<= 512 字符
privacyPolicyUrl
string <url>
可选
A Privacy Policy URL for the Pack.
<= 512 字符
🟠400400
🟠401401
🟠403403
🟠404404
🟠429429
修改于 2024-03-20 08:13:15
上一页
Update featured docs for a Pack
下一页
Update Pack
Built with