In order to help you get started with example queries and mutations, we are providing a Postman collection using the JSON code featured in the snippet below.
This particular collection points to the Aurora Dev Docs instance, a demo instance that is currently featured in our GraphQL Documentation. You can update the code to point to another instance, including user credentials, to test against different data.
To create your Postman collection, copy the snippet below and use it to create a JSON file. You can then import the file into Postman.
{
"info": {
"_postman_id": "86cedc86-abc5-4cde-b734-805ffd3eec57",
"name": "Aurora Dev Docs GraphQL",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "3613967"
},
"item": [
{
"name": "Messages",
"item": [
{
"name": "messages",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "graphql",
"graphql": {
"query": "query Messages($first: Int, $constraints: MessageConstraints) {\n messages(first: $first, constraints: $constraints) {\n totalCount\n edges {\n node {\n id\n subject\n board {\n parent {\n id\n }\n }\n }\n }\n }\n}",
"variables": "{ \n \"first\": 10,\n \"constraints\": {\n \"depth\": {\n \"eq\": 0\n } \n }\n}"
}
},
"url": {
"raw": "https://devdocs.aurora.khoros.com/t5/s/api/2.1/graphql",
"protocol": "https",
"host": [
"devdocs",
"aurora",
"khoros",
"com"
],
"path": [
"t5",
"s",
"api",
"2.1",
"graphql"
]
}
},
"response": []
},
{
"name": "messagesSearch",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "graphql",
"graphql": {
"query": "query Messages($searchTerm: String!, $first: Int, $constraints: MessageSearchConstraints) {\n messageSearch(searchTerm: $searchTerm, first: $first, constraints: $constraints) { \n results {\n totalCount \n edges { \n node { \n id\n snippet {\n key\n content\n }\n message {\n subject\n body \n board {\n parent {\n id\n }\n }\n }\n }\n }\n } \n }\n}",
"variables": "{ \n \"searchTerm\": \"mars volta\",\n \"first\": 10 \n}"
}
},
"url": {
"raw": "https://devdocs.aurora.khoros.com/t5/s/api/2.1/graphql",
"protocol": "https",
"host": [
"devdocs",
"aurora",
"khoros",
"com"
],
"path": [
"t5",
"s",
"api",
"2.1",
"graphql"
]
}
},
"response": []
}
]
},
{
"name": "Nodes",
"item": [
{
"name": "community",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "graphql",
"graphql": {
"query": "query Community {\n community {\n id\n boardCount\n categoryCount\n creationDate\n description\n title\n }\n}",
"variables": ""
}
},
"url": {
"raw": "https://devdocs.aurora.khoros.com/t5/s/api/2.1/graphql",
"protocol": "https",
"host": [
"devdocs",
"aurora",
"khoros",
"com"
],
"path": [
"t5",
"s",
"api",
"2.1",
"graphql"
]
}
},
"response": []
},
{
"name": "categories",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "graphql",
"graphql": {
"query": "query Categories($first: Int, $constraints: CategoryConstraints) {\n categories(first: $first, constraints: $constraints) {\n totalCount\n edges { \n node {\n id\n title\n description\n boardCount\n }\n }\n }\n}",
"variables": "{\n \"first\": 10 \n}"
}
},
"url": {
"raw": "https://devdocs.aurora.khoros.com/t5/s/api/2.1/graphql",
"protocol": "https",
"host": [
"devdocs",
"aurora",
"khoros",
"com"
],
"path": [
"t5",
"s",
"api",
"2.1",
"graphql"
]
}
},
"response": []
},
{
"name": "coreNodes",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "graphql",
"graphql": {
"query": "query NodeViews($constraints: CoreNodeConstraints, $sorts: CoreNodeSorts, $first: Int, $after: String, $last: Int, $before: String, $useNodeAvatar: Boolean = false, $useMembershipType: Boolean = true, $useNodeIcon: Boolean = true, $useNodeUserContext: Boolean = true, $useNodeCreationDate: Boolean = false, $useNodeDescription: Boolean = false, $useNodeLatestActivityTime: Boolean = false, $useMembershipInformation: Boolean = false, $useNodeOwners: Boolean = false, $useNodeTopicsCount: Boolean = false, $useNodeViewsCount: Boolean = false, $useNodeParent: Boolean = false, $useChildNodes: Boolean = false, $childrenConstraints: ChildrenCoreNodeConstraints = {}, $childrenSorts: CoreNodeSorts = {}, $childrenFirst: Int = 0, $childrenAfter: String = null, $useFullPageInfo: Boolean = false, $useNodeFollowersCount: Boolean = false, $useNodeUnreadCount: Boolean = false, $useTextDescriptionForNode: Boolean = true) {\n coreNodes(\n constraints: $constraints\n sorts: $sorts\n first: $first\n after: $after\n last: $last\n before: $before\n ) {\n edges {\n cursor\n node {\n ...NodeView\n __typename\n }\n __typename\n }\n pageInfo {\n ...Pager\n __typename\n }\n __typename\n }\n}\n\nfragment NodeView on CoreNode {\n ...NodeBasicFields\n ...NodeTitle\n ...NodeIcon @include(if: $useNodeIcon)\n ...NodeMembershipType @include(if: $useMembershipType)\n ...NodeParent @include(if: $useNodeParent)\n ...NodeChildren @include(if: $useChildNodes)\n ...NodeAvatar @include(if: $useNodeAvatar)\n ...NodeDescription @include(if: $useNodeDescription)\n ...NodeTopicsCount @include(if: $useNodeTopicsCount)\n creationDate @include(if: $useNodeCreationDate)\n ...NodeLatestActivityTime @include(if: $useNodeLatestActivityTime)\n ...NodeOwners @include(if: $useNodeOwners)\n ...NodeViewsCount @include(if: $useNodeViewsCount)\n ...NodeFollowersCount @include(if: $useNodeFollowersCount)\n ...NodeUserContext @include(if: $useNodeUserContext)\n unreadMessagesCount @include(if: $useNodeUnreadCount)\n ...NodeMembershipView @include(if: $useMembershipInformation)\n __typename\n}\n\nfragment NodeBasicFields on CoreNode {\n id\n displayId\n nodeType\n depth\n ... on Board {\n conversationStyle\n __typename\n }\n __typename\n}\n\nfragment NodeParent on ChildNode {\n parent {\n ...NodeBasicFields\n ...NodeTitle\n __typename\n }\n __typename\n}\n\nfragment NodeTitle on CoreNode {\n title\n __typename\n}\n\nfragment NodeChildren on ParentNode {\n children(\n constraints: $childrenConstraints\n sorts: $childrenSorts\n first: $childrenFirst\n after: $childrenAfter\n ) {\n edges {\n node {\n ...NodeBasicFields\n ...NodeTitle\n ...NodeParent @include(if: $useNodeParent)\n ...NodeAvatar @include(if: $useNodeAvatar)\n ...NodeDescription @include(if: $useNodeDescription)\n ...NodeTopicsCount @include(if: $useNodeTopicsCount)\n ...NodeLatestActivityTime @include(if: $useNodeLatestActivityTime)\n unreadMessagesCount @include(if: $useNodeUnreadCount)\n ...NodeMembershipType @include(if: $useMembershipType)\n __typename\n }\n __typename\n }\n pageInfo {\n ...Pager\n __typename\n }\n __typename\n }\n __typename\n}\n\nfragment NodeDescription on CoreNode {\n description @skip(if: $useTextDescriptionForNode)\n description @include(if: $useTextDescriptionForNode) @stripHtml\n __typename\n}\n\nfragment NodeAvatar on CoreNode {\n avatar {\n url\n mimeType\n __typename\n }\n title\n __typename\n}\n\nfragment NodeTopicsCount on CoreNode {\n topicsCount\n __typename\n}\n\nfragment Pager on PageInfo {\n hasNextPage\n endCursor\n hasPreviousPage @include(if: $useFullPageInfo)\n startCursor @include(if: $useFullPageInfo)\n __typename\n}\n\nfragment NodeLatestActivityTime on CoreNode {\n topicsCount\n messageActivity {\n corePropertyChangeTime\n __typename\n }\n __typename\n}\n\nfragment NodeMembershipType on MembershipApplicable {\n membershipType\n __typename\n}\n\nfragment NodeIcon on CoreNode {\n nodeType\n __typename\n}\n\nfragment NodeViewsCount on CoreNode {\n views\n __typename\n}\n\nfragment NodeOwners on MembershipApplicable {\n members(\n constraints: {rolesName: {eq: \"Owner\"}}\n first: 5\n sorts: {joinDate: {direction: DESC}}\n ) {\n edges {\n node {\n ...UserBasicFields\n __typename\n }\n __typename\n }\n pageInfo {\n ...PagerLoadMore\n __typename\n }\n __typename\n }\n __typename\n}\n\nfragment UserBasicFields on User {\n id\n deleted\n ...UserLink\n ...UserLogin\n __typename\n}\n\nfragment UserLogin on User {\n login\n __typename\n}\n\nfragment UserLink on User {\n id\n uid\n login\n registrationData {\n status\n __typename\n }\n __typename\n}\n\nfragment PagerLoadMore on PageInfo {\n hasNextPage\n endCursor\n __typename\n}\n\nfragment NodeFollowersCount on CoreNode {\n subscriptionsCount\n __typename\n}\n\nfragment NodeUserContext on CoreNode {\n userContext {\n canAddAttachments\n canUpdateNode\n canPostMessages\n isSubscribed\n __typename\n }\n __typename\n}\n\nfragment NodeMembershipView on MembershipApplicable {\n ...NodeMembershipType @include(if: $useMembershipInformation)\n ...NodeMembersCount @include(if: $useMembershipInformation)\n ...NodeOwnersCount @include(if: $useMembershipInformation)\n ...NodeMembershipRequestsCount @include(if: $useMembershipInformation)\n
ATLAS
Comments