Query
query HelpCenterIndex($id: ID!) {
helpCenterIndex(id: $id) {
helpCenterId
hash
navIndex {
type
id
title
slug
parentId
status
}
createdAt {
unixTimestamp
iso8601
}
createdBy {
__typename
... on UserActor {
userId
user {
__typename
}
}
}
updatedAt {
unixTimestamp
iso8601
}
}
}Variables
{
"id": "id"
}Response
{
"data": {
"helpCenterIndex": {
"helpCenterId": "id",
"hash": "string",
"navIndex": [
{
"type": "ARTICLE",
"id": "id",
"title": "string",
"slug": "string",
"parentId": "id",
"status": "PUBLISHED"
}
],
"createdAt": {
"unixTimestamp": "string",
"iso8601": "string"
},
"createdBy": {
"__typename": "UserActor",
"userId": "id",
"user": {
"__typename": "User"
}
},
"updatedAt": {
"unixTimestamp": "string",
"iso8601": "string"
}
}
}
}Queries
helpCenterIndex
Fetch the navigation index for a help center by its ID. Returns null if not found. Use the returned hash when calling updateHelpCenterIndex to avoid clobbering concurrent edits.
QUERY
helpCenterIndex(id: ID!): HelpCenterIndexArguments
id
ID!
required
Returns
helpCenterId
ID!
The ID of the help center this index belongs to.
hash
String!
Opaque version token. Must be passed back to updateHelpCenterIndex to prevent overwriting concurrent changes.
navIndex
Ordered, flat list of items that represents the navigation tree. Items reference their parent via parentId to reconstruct the hierarchy.
createdAt
createdBy
updatedAt
updatedBy
Query
query HelpCenterIndex($id: ID!) {
helpCenterIndex(id: $id) {
helpCenterId
hash
navIndex {
type
id
title
slug
parentId
status
}
createdAt {
unixTimestamp
iso8601
}
createdBy {
__typename
... on UserActor {
userId
user {
__typename
}
}
}
updatedAt {
unixTimestamp
iso8601
}
}
}Variables
{
"id": "id"
}Response
{
"data": {
"helpCenterIndex": {
"helpCenterId": "id",
"hash": "string",
"navIndex": [
{
"type": "ARTICLE",
"id": "id",
"title": "string",
"slug": "string",
"parentId": "id",
"status": "PUBLISHED"
}
],
"createdAt": {
"unixTimestamp": "string",
"iso8601": "string"
},
"createdBy": {
"__typename": "UserActor",
"userId": "id",
"user": {
"__typename": "User"
}
},
"updatedAt": {
"unixTimestamp": "string",
"iso8601": "string"
}
}
}
}Was this page helpful?

