Get template list

GET 
/wiki/templates

History

Version	Changes
v6.12.0	Added in: v6.12.0

Get template list.

Request

Query Parameters

teamID stringrequired

The team ID

requestUserID string

User ID, this parameter can only be passed when calling as an Oauth bot. It is used to perform operations as the specified user

contextType stringrequired

Possible values: [space, team, system]

Context Type.

contextID stringrequired

Context ID.

start integerrequired

The start index of the list

limit integerrequired

The limit of the list, maximum 200

Responses

200

Request is successful.

application/json

Schema

Schema

data

object

templates

object[]

Array [

id string

The template ID

title string

The template title

contextType string

The context type

contextID string

The context ID

refType string

The reference type

refID string

The reference ID

subRefType string

The sub reference type

createdTime integer

The createdTime of template

updatedTime integer

The updatedTime of template

]

total integer

The total number of templates

start integer

The start index of the list

count integer

The number of templates in the list

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

errorData object

Error meta data for this request.

Example (from schema)

{
  "data": {
    "templates": [
      {
        "id": "string",
        "title": "string",
        "contextType": "string",
        "contextID": "string",
        "refType": "string",
        "refID": "string",
        "subRefType": "string",
        "createdTime": 0,
        "updatedTime": 0
      }
    ],
    "total": 0,
    "start": 0,
    "count": 0
  },
  "result": "string",
  "errorCode": "string",
  "errorMsg": "string",
  "errorData": {}
}

401

Returned if the authentication credentials are incorrect or missing.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Unauthorized",
  "errorMsg": "Access token is invalid"
}

403

Returns if the scope check fails.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Forbidden",
  "errorMsg": "Scope is invalid"
}

404

Returned if the resource object was not found.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "NotFound",
  "errorMsg": "Not Found"
}

500

Internal Server Error.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Internal Server Error",
  "errorMsg": "Internal Server Error"
}

Loading...