Read Answer

post/getanswer

Read the details of a particular Answer given its ID.

SecurityBearerAuth
Request
header Parameters
X-Glean-ActAs
string <email>

Email address of a user on whose behalf the request is intended to be made (should be non-empty only for global tokens).

X-Glean-Auth-Type
string

Auth type being used to access the endpoint (should be non-empty only for global tokens).

Request Body schema: application/json
required

GetAnswer request

docId
string

Glean Document ID of the Answer. The Glean Document ID is supported for cases where the Answer ID isn't available. If both are available, using the Answer ID is preferred.

id
integer

The opaque ID of the Answer.

Responses
200

OK

Response Schema: application/json
object (AnswerResult)
object (GetAnswerError)
400

Invalid request

401

Not Authorized

429

Too Many Requests

Request samples
application/json
{
  • "id": 3,
  • "docId": "ANSWERS_answer_3"
}
Response samples
application/json
{
  • "answerResult": {
    • "answer": {
      • "id": 3,
      • "docId": "ANSWERS_answer_3",
      • "question": "Why is the sky blue?",
      • "questionVariations": [
        • "string"
        ],
      • "bodyText": "From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light.",
      • "boardId": 0,
      • "audienceFilters": [
        • {
          • "fieldName": "type",
          • "values": [
            • {
              • "value": "Spreadsheet",
              • "relationType": "EQUALS"
              },
            • {
              • "value": "Presentation",
              • "relationType": "EQUALS"
              }
            ]
          }
        ],
      • "addedRoles": [
        • {
          • "sourceDocumentSpec": {
            • "url": "string"
            },
          • "person": {
            • "name": "George Clooney",
            • "obfuscatedId": "abc123"
            },
          • "group": {
            • "type": "DEPARTMENT",
            • "id": "string",
            • "name": "string"
            },
          • "role": "OWNER"
          }
        ],
      • "removedRoles": [
        • {
          • "sourceDocumentSpec": {
            • "url": "string"
            },
          • "person": {
            • "name": "George Clooney",
            • "obfuscatedId": "abc123"
            },
          • "group": {
            • "type": "DEPARTMENT",
            • "id": "string",
            • "name": "string"
            },
          • "role": "OWNER"
          }
        ],
      • "roles": [
        • {
          • "sourceDocumentSpec": {
            • "url": "string"
            },
          • "person": {
            • "name": "George Clooney",
            • "obfuscatedId": "abc123"
            },
          • "group": {
            • "type": "DEPARTMENT",
            • "id": "string",
            • "name": "string"
            },
          • "role": "OWNER"
          }
        ],
      • "sourceDocumentSpec": {
        • "url": "string"
        },
      • "sourceType": "DOCUMENT",
      • "permissions": {
        • "write": {
          • "scopeType": "GLOBAL",
          • "create": true,
          • "update": true,
          • "delete": true
          }
        },
      • "combinedAnswerText": {
        • "text": "From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light.",
        • "structuredList": [
          • {
            • "link": "https://en.wikipedia.org/wiki/Diffuse_sky_radiation",
            • "document": {
              • "id": "string",
              • "datasource": "string",
              • "connectorType": "API_CRAWL",
              • "docType": "string",
              • "content": {
                • "fullTextList": [ ]
                },
              • "containerDocument": { },
              • "parentDocument": { },
              • "title": "string",
              • "url": "string",
              • "metadata": {
                • "container": "container",
                • "parentId": "JIRA_EN-1337",
                • "createTime": "2000-01-23T04:56:07.000Z",
                • "datasource": "datasource",
                • "author": {
                  • "name": "name"
                  },
                • "documentId": "documentId",
                • "updateTime": "2000-01-23T04:56:07.000Z",
                • "mimeType": "mimeType",
                • "objectType": "Feature Request",
                • "components": [
                  • "Backend",
                  • "Networking"
                  ],
                • "status": [
                  • "Done"
                  ],
                • "customData": {
                  • "someCustomField": "someCustomValue"
                  }
                },
              • "sections": [
                • null
                ]
              },
            • "text": "Because its wavelengths are shorter, blue light is more strongly scattered than the longer-wavelength lights, red or green. Hence the result that when looking at the sky away from the direct incident sunlight, the human eye perceives the sky to be blue.",
            • "structuredResult": {
              • "document": {
                • "id": null,
                • "datasource": null,
                • "connectorType": null,
                • "docType": null,
                • "content": null,
                • "containerDocument": null,
                • "parentDocument": null,
                • "title": null,
                • "url": null,
                • "metadata": null,
                • "sections": [ ]
                },
              • "person": {
                • "name": "George Clooney",
                • "obfuscatedId": "abc123"
                },
              • "customer": {
                • "id": null,
                • "domains": [ ],
                • "company": null,
                • "documentCounts": null,
                • "poc": [ ],
                • "metadata": null,
                • "mergedCustomers": [ ],
                • "startDate": null,
                • "contractAnnualRevenue": null,
                • "notes": null
                },
              • "team": {
                • "relatedObjects": { },
                • "permissions": null,
                • "id": null,
                • "name": null,
                • "description": null,
                • "businessUnit": null,
                • "department": null,
                • "photoUrl": null,
                • "bannerUrl": null,
                • "externalLink": null,
                • "members": [ ],
                • "memberCount": null,
                • "emails": [ ],
                • "customFields": [ ],
                • "datasourceProfiles": [ ],
                • "datasource": null,
                • "createdFrom": null,
                • "lastUpdatedAt": null,
                • "status": null,
                • "canBeDeleted": null,
                • "loggingId": null
                },
              • "customEntity": {
                • "permissions": null,
                • "id": null,
                • "title": null,
                • "datasource": null,
                • "objectType": null,
                • "metadata": null,
                • "roles": [ ]
                },
              • "answer": null,
              • "generatedQna": {
                • "question": null,
                • "answer": null,
                • "followUpPrompts": [ ],
                • "followupActions": [ ],
                • "ranges": [ ],
                • "status": null,
                • "cursor": null,
                • "trackingToken": null
                },
              • "extractedQnA": {
                • "heading": null,
                • "question": null,
                • "questionResult": null
                },
              • "meeting": {
                • "id": null,
                • "title": null,
                • "description": null,
                • "url": null,
                • "startTime": null,
                • "endTime": null,
                • "attendees": null
                },
              • "app": {
                • "datasource": null,
                • "docType": null,
                • "mimeType": null,
                • "iconUrl": null
                },
              • "collection": {
                • "name": null,
                • "description": null,
                • "addedRoles": [ ],
                • "removedRoles": [ ],
                • "audienceFilters": [ ],
                • "icon": null,
                • "adminLocked": null,
                • "parentId": null,
                • "thumbnail": null,
                • "allowedDatasource": null,
                • "permissions": null,
                • "id": null,
                • "createTime": null,
                • "updateTime": null,
                • "creator": null,
                • "updatedBy": null,
                • "itemCount": null,
                • "childCount": null,
                • "items": [ ],
                • "pinMetadata": null,
                • "shortcuts": [ ],
                • "children": [ ],
                • "roles": [ ]
                },
              • "answerBoard": {
                • "name": null,
                • "description": null,
                • "addedRoles": [ ],
                • "removedRoles": [ ],
                • "audienceFilters": [ ],
                • "permissions": null,
                • "id": null,
                • "createTime": null,
                • "updateTime": null,
                • "creator": null,
                • "updatedBy": null,
                • "itemCount": null,
                • "roles": [ ]
                },
              • "code": {
                • "repoName": "scio",
                • "fileName": "README.md",
                • "matches": [
                  • {
                    • "lineNumber": 1,
                    • "content": "Welcome to the beginning",
                    • "ranges": [ ]
                    },
                  • {
                    • "lineNumber": 2,
                    • "content": "Second line of the file",
                    • "ranges": [ ]
                    },
                  • {
                    • "lineNumber": 3,
                    • "content": "hello world hello world",
                    • "ranges": [
                      • {
                        • "startindex": 0,
                        • "endIndex": 5
                        },
                      • {
                        • "startIndex": 12,
                        • "endIndex": 17
                        }
                      ]
                    }
                  ]
                },
              • "shortcut": {
                • "id": null,
                • "inputAlias": null,
                • "destinationUrl": null,
                • "destinationDocumentId": null,
                • "description": null,
                • "unlisted": null,
                • "urlTemplate": null,
                • "addedRoles": [ ],
                • "removedRoles": [ ],
                • "permissions": null,
                • "createdBy": null,
                • "createTime": null,
                • "updatedBy": null,
                • "updateTime": null,
                • "destinationDocument": null,
                • "intermediateUrl": null,
                • "viewPrefix": null,
                • "isExternal": null,
                • "editUrl": null,
                • "alias": null,
                • "title": null,
                • "roles": [ ]
                },
              • "querySuggestions": {
                • "suggestions": [ ],
                • "person": null
                },
              • "relatedDocuments": [
                • null
                ],
              • "relatedQuestion": {
                • "question": null,
                • "answer": null,
                • "ranges": [ ]
                },
              • "disambiguation": {
                • "name": null,
                • "id": null,
                • "type": null
                },
              • "snippets": [
                • null
                ],
              • "trackingToken": "string",
              • "prominence": "HERO",
              • "source": "EXPERT_DETECTION"
              }
            }
          ]
        },
      • "likes": {
        • "likedBy": [
          • {
            • "user": {
              • "name": "George Clooney",
              • "obfuscatedId": "abc123"
              },
            • "createTime": "2019-08-24T14:15:22Z"
            }
          ],
        • "likedByUser": true,
        • "numLikes": 0
        },
      • "author": {
        • "name": "George Clooney",
        • "obfuscatedId": "abc123"
        },
      • "createTime": "2019-08-24T14:15:22Z",
      • "updateTime": "2019-08-24T14:15:22Z",
      • "updatedBy": {
        • "name": "George Clooney",
        • "obfuscatedId": "abc123"
        },
      • "verification": {
        • "state": "UNVERIFIED",
        • "metadata": {
          • "lastVerifier": {
            • "name": "George Clooney",
            • "obfuscatedId": "abc123"
            },
          • "lastVerificationTs": 0,
          • "expirationTs": 0,
          • "document": {
            • "id": "string",
            • "datasource": "string",
            • "connectorType": "API_CRAWL",
            • "docType": "string",
            • "content": {
              • "fullTextList": [
                • null
                ]
              },
            • "containerDocument": { },
            • "parentDocument": { },
            • "title": "string",
            • "url": "string",
            • "metadata": {
              • "container": "container",
              • "parentId": "JIRA_EN-1337",
              • "createTime": "2000-01-23T04:56:07.000Z",
              • "datasource": "datasource",
              • "author": {
                • "name": "name"
                },
              • "documentId": "documentId",
              • "updateTime": "2000-01-23T04:56:07.000Z",
              • "mimeType": "mimeType",
              • "objectType": "Feature Request",
              • "components": [
                • "Backend",
                • "Networking"
                ],
              • "status": [
                • "Done"
                ],
              • "customData": {
                • "someCustomField": "someCustomValue"
                }
              },
            • "sections": [
              • {
                • "title": null,
                • "url": null
                }
              ]
            },
          • "reminders": [
            • {
              • "assignee": {
                • "name": "George Clooney",
                • "obfuscatedId": "abc123"
                },
              • "requestor": {
                • "name": "George Clooney",
                • "obfuscatedId": "abc123"
                },
              • "remindAt": 0,
              • "createdAt": 0,
              • "reason": "string"
              }
            ],
          • "lastReminder": {
            • "assignee": {
              • "name": "George Clooney",
              • "obfuscatedId": "abc123"
              },
            • "requestor": {
              • "name": "George Clooney",
              • "obfuscatedId": "abc123"
              },
            • "remindAt": 0,
            • "createdAt": 0,
            • "reason": "string"
            },
          • "visitorCount": [
            • {
              • "count": 0,
              • "period": {
                • "minDaysFromNow": null,
                • "maxDaysFromNow": null,
                • "start": null,
                • "end": null
                },
              • "org": "string"
              }
            ],
          • "candidateVerifiers": [
            • {
              • "name": "George Clooney",
              • "obfuscatedId": "abc123"
              }
            ]
          }
        },
      • "board": {
        • "name": "string",
        • "description": "string",
        • "addedRoles": [
          • {
            • "sourceDocumentSpec": {
              • "url": "string"
              },
            • "person": {
              • "name": "George Clooney",
              • "obfuscatedId": "abc123"
              },
            • "group": {
              • "type": "DEPARTMENT",
              • "id": "string",
              • "name": "string"
              },
            • "role": "OWNER"
            }
          ],
        • "removedRoles": [
          • {
            • "sourceDocumentSpec": {
              • "url": "string"
              },
            • "person": {
              • "name": "George Clooney",
              • "obfuscatedId": "abc123"
              },
            • "group": {
              • "type": "DEPARTMENT",
              • "id": "string",
              • "name": "string"
              },
            • "role": "OWNER"
            }
          ],
        • "audienceFilters": [
          • {
            • "fieldName": "type",
            • "values": [
              • {
                • "value": "Spreadsheet",
                • "relationType": "EQUALS"
                },
              • {
                • "value": "Presentation",
                • "relationType": "EQUALS"
                }
              ]
            }
          ],
        • "permissions": {
          • "write": {
            • "scopeType": "GLOBAL",
            • "create": true,
            • "update": true,
            • "delete": true
            }
          },
        • "id": 0,
        • "createTime": "2019-08-24T14:15:22Z",
        • "updateTime": "2019-08-24T14:15:22Z",
        • "creator": {
          • "name": "George Clooney",
          • "obfuscatedId": "abc123"
          },
        • "updatedBy": {
          • "name": "George Clooney",
          • "obfuscatedId": "abc123"
          },
        • "itemCount": 0,
        • "roles": [
          • {
            • "sourceDocumentSpec": {
              • "url": "string"
              },
            • "person": {
              • "name": "George Clooney",
              • "obfuscatedId": "abc123"
              },
            • "group": {
              • "type": "DEPARTMENT",
              • "id": "string",
              • "name": "string"
              },
            • "role": "OWNER"
            }
          ]
        },
      • "collections": [
        • {
          • "name": "string",
          • "description": "string",
          • "addedRoles": [
            • {
              • "sourceDocumentSpec": {
                • "url": null
                },
              • "person": {
                • "name": "George Clooney",
                • "obfuscatedId": "abc123"
                },
              • "group": {
                • "type": null,
                • "id": null,
                • "name": null
                },
              • "role": "OWNER"
              }
            ],
          • "removedRoles": [
            • {
              • "sourceDocumentSpec": {
                • "url": null
                },
              • "person": {
                • "name": "George Clooney",
                • "obfuscatedId": "abc123"
                },
              • "group": {
                • "type": null,
                • "id": null,
                • "name": null
                },
              • "role": "OWNER"
              }
            ],
          • "audienceFilters": [
            • {
              • "fieldName": "type",
              • "values": [
                • {
                  • "value": "Spreadsheet",
                  • "relationType": "EQUALS"
                  },
                • {
                  • "value": "Presentation",
                  • "relationType": "EQUALS"
                  }
                ]
              }
            ],
          • "icon": "string",
          • "adminLocked": true,
          • "parentId": 0,
          • "thumbnail": {
            • "photoId": "string",
            • "url": "string"
            },
          • "allowedDatasource": "string",
          • "permissions": {
            • "write": {
              • "scopeType": "GLOBAL",
              • "create": true,
              • "update": true,
              • "delete": true
              }
            },
          • "id": 0,
          • "createTime": "2019-08-24T14:15:22Z",
          • "updateTime": "2019-08-24T14:15:22Z",
          • "creator": {
            • "name": "George Clooney",
            • "obfuscatedId": "abc123"
            },
          • "updatedBy": {
            • "name": "George Clooney",
            • "obfuscatedId": "abc123"
            },
          • "itemCount": 0,
          • "childCount": 0,
          • "items": [
            • {
              • "name": "string",
              • "description": "string",
              • "icon": "string",
              • "collectionId": 0,
              • "documentId": "string",
              • "url": "string",
              • "itemId": "string",
              • "createdBy": {
                • "name": "George Clooney",
                • "obfuscatedId": "abc123"
                },
              • "createdAt": "2019-08-24T14:15:22Z",
              • "document": {
                • "id": null,
                • "datasource": null,
                • "connectorType": null,
                • "docType": null,
                • "content": null,
                • "containerDocument": null,
                • "parentDocument": null,
                • "title": null,
                • "url": null,
                • "metadata": null,
                • "sections": [ ]
                },
              • "shortcut": {
                • "id": null,
                • "inputAlias": null,
                • "destinationUrl": null,
                • "destinationDocumentId": null,
                • "description": null,
                • "unlisted": null,
                • "urlTemplate": null,
                • "addedRoles": [ ],
                • "removedRoles": [ ],
                • "permissions": null,
                • "createdBy": null,
                • "createTime": null,
                • "updatedBy": null,
                • "updateTime": null,
                • "destinationDocument": null,
                • "intermediateUrl": null,
                • "viewPrefix": null,
                • "isExternal": null,
                • "editUrl": null,
                • "alias": null,
                • "title": null,
                • "roles": [ ]
                },
              • "collection": null,
              • "itemType": "DOCUMENT"
              }
            ],
          • "pinMetadata": {
            • "existingPins": [
              • {
                • "category": null,
                • "value": null,
                • "target": null
                }
              ],
            • "eligiblePins": [
              • {
                • "id": null,
                • "target": null
                }
              ]
            },
          • "shortcuts": [
            • "string"
            ],
          • "children": [
            • null
            ],
          • "roles": [
            • {
              • "sourceDocumentSpec": {
                • "url": null
                },
              • "person": {
                • "name": "George Clooney",
                • "obfuscatedId": "abc123"
                },
              • "group": {
                • "type": null,
                • "id": null,
                • "name": null
                },
              • "role": "OWNER"
              }
            ]
          }
        ],
      • "documentCategory": "string",
      • "sourceDocument": {
        • "id": "string",
        • "datasource": "string",
        • "connectorType": "API_CRAWL",
        • "docType": "string",
        • "content": {
          • "fullTextList": [
            • "string"
            ]
          },
        • "containerDocument": { },
        • "parentDocument": { },
        • "title": "string",
        • "url": "string",
        • "metadata": {
          • "container": "container",
          • "parentId": "JIRA_EN-1337",
          • "createTime": "2000-01-23T04:56:07.000Z",
          • "datasource": "datasource",
          • "author": {
            • "name": "name"
            },
          • "documentId": "documentId",
          • "updateTime": "2000-01-23T04:56:07.000Z",
          • "mimeType": "mimeType",
          • "objectType": "Feature Request",
          • "components": [
            • "Backend",
            • "Networking"
            ],
          • "status": [
            • "Done"
            ],
          • "customData": {
            • "someCustomField": "someCustomValue"
            }
          },
        • "sections": [
          • {
            • "title": "string",
            • "url": "string"
            }
          ]
        }
      },
    • "trackingToken": "string"
    },
  • "error": {
    • "errorType": "NO_PERMISSION",
    • "answerAuthor": {
      • "name": "George Clooney",
      • "obfuscatedId": "abc123"
      }
    }
}