Retrieve recommended documents for the given URL or Glean Document ID.
Recommendations request
OK
Accepted. The Retry-After header has a hint about when the response will be available
There are no recommendations for this URL
Invalid request
Not Authorized
Document does not exist or user cannot access document
Too Many Requests
{- "timestamp": "2019-08-24T14:15:22Z",
- "trackingToken": "string",
- "sessionInfo": {
- "sessionTrackingToken": "string",
- "tabId": "string",
- "lastSeen": "2019-08-24T14:15:22Z",
- "lastQuery": "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"
}
]
}, - "pageSize": 100,
- "maxSnippetSize": 400,
- "recommendationDocumentSpec": {
- "url": "string"
}, - "requestOptions": {
- "datasourceFilter": "string",
- "datasourcesFilter": [
- "string"
], - "facetFilterSets": [
- {
- "filters": [
- {
- "fieldName": "type",
- "values": [
- {
- "value": "Spreadsheet",
- "relationType": "EQUALS"
}, - {
- "value": "Presentation",
- "relationType": "EQUALS"
}
]
}
]
}
], - "context": {
- "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"
}
]
}, - "resultProminence": [
- "HERO"
]
}
}
{- "trackingToken": "string",
- "sessionInfo": {
- "sessionTrackingToken": "string",
- "tabId": "string",
- "lastSeen": "2019-08-24T14:15:22Z",
- "lastQuery": "string"
}, - "results": [
- {
- "snippets": [
- {
- "snippet": "snippet",
- "mimeType": "mimeType"
}
], - "metadata": {
- "container": "container",
- "createTime": "2000-01-23T04:56:07.000Z",
- "datasource": "datasource",
- "author": {
- "name": "name"
}, - "documentId": "documentId",
- "updateTime": "2000-01-23T04:56:07.000Z",
- "mimeType": "mimeType",
- "objectType": "objectType"
}, - "title": "title",
- "nativeAppUrl": "slack://foo/bar",
- "mustIncludeSuggestions": [
- {
- "missingTerm": "container",
- "query": "container"
}
]
}
], - "structuredResults": [
- {
- "document": {
- "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"
}
]
}, - "person": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "customer": {
- "id": "string",
- "domains": [
- "string"
], - "company": {
- "name": "string",
- "profileUrl": "string",
- "websiteUrls": [
- "string"
], - "logoUrl": "string",
- "location": "New York City",
- "phone": "string",
- "fax": "string",
- "industry": "Finances",
- "annualRevenue": 0,
- "numberOfEmployees": 0,
- "stockSymbol": "string",
- "foundedDate": "2019-08-24",
- "about": "Financial, software, data, and media company headquartered in Midtown Manhattan, New York City"
}, - "documentCounts": {
- "property1": 0,
- "property2": 0
}, - "poc": [
- {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}
], - "metadata": {
- "datasourceId": "string",
- "customData": {
- "property1": {
- "displayLabel": "string",
- "stringValue": "string",
- "stringListValue": [
- null
], - "numberValue": 0
}, - "property2": {
- "displayLabel": "string",
- "stringValue": "string",
- "stringListValue": [
- null
], - "numberValue": 0
}
}
}, - "mergedCustomers": [
- { }
], - "startDate": "2019-08-24",
- "contractAnnualRevenue": 0,
- "notes": "CIO is interested in trying out the product."
}, - "team": {
- "relatedObjects": {
- "property1": {
- "objects": [
- {
- "id": null,
- "metadata": { }
}
]
}, - "property2": {
- "objects": [
- {
- "id": null,
- "metadata": { }
}
]
}
}, - "permissions": {
- "write": {
- "scopeType": "GLOBAL",
- "create": true,
- "update": true,
- "delete": true
}
}, - "id": "string",
- "name": "string",
- "description": "string",
- "businessUnit": "string",
- "department": "string",
- "photoUrl": "string",
- "bannerUrl": "string",
- "members": [
- {
- "person": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "relationship": "MEMBER",
- "customRelationshipStr": "string",
- "joinDate": "2019-08-24T14:15:22Z"
}
], - "memberCount": 0,
- "emails": [
- {
- "email": "user@example.com",
- "type": "PRIMARY",
- "isUserGenerated": true
}
], - "datasourceProfiles": [
- {
- "datasource": "github",
- "handle": "string",
- "url": "string",
- "nativeAppUrl": "string",
- "isUserGenerated": true
}
], - "datasource": "string",
- "createdFrom": "string",
- "lastUpdatedAt": "2019-08-24T14:15:22Z",
- "status": "PROCESSED",
- "canBeDeleted": true,
- "loggingId": "string"
}, - "customEntity": {
- "permissions": {
- "write": {
- "scopeType": "GLOBAL",
- "create": true,
- "update": true,
- "delete": true
}
}, - "id": "string",
- "title": "string",
- "datasource": "string",
- "objectType": "string",
- "metadata": {
- "customData": {
- "property1": {
- "displayLabel": "string",
- "stringValue": "string",
- "stringListValue": [
- null
], - "numberValue": 0
}, - "property2": {
- "displayLabel": "string",
- "stringValue": "string",
- "stringListValue": [
- null
], - "numberValue": 0
}
}
}, - "roles": [
- {
- "sourceDocumentSpec": {
- "url": "string"
}, - "person": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "group": {
- "type": "DEPARTMENT",
- "id": "string",
- "name": "string"
}, - "role": "OWNER"
}
]
}, - "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": [
- {
- "document": {
- "id": null,
- "datasource": null,
- "connectorType": null,
- "docType": null,
- "content": null,
- "containerDocument": null,
- "parentDocument": null,
- "title": null,
- "url": null,
- "metadata": null,
- "sections": [ ]
}, - "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."
}
]
}, - "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": [ ]
}, - "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
]
}, - "reminders": [
- {
- "assignee": null,
- "requestor": null,
- "remindAt": null,
- "createdAt": null,
- "reason": null
}
], - "lastReminder": {
- "assignee": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "requestor": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "remindAt": 0,
- "createdAt": 0,
- "reason": "string"
}, - "visitorCount": [
- {
- "count": null,
- "period": null,
- "org": null
}
], - "candidateVerifiers": [
- {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}
]
}
}, - "board": {
- "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"
}
]
}
], - "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": null
}, - "person": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "group": {
- "type": null,
- "id": null,
- "name": null
}, - "role": "OWNER"
}
]
}, - "collections": [
- {
- "name": "string",
- "description": "string",
- "addedRoles": [
- {
- "sourceDocumentSpec": null,
- "person": null,
- "group": null,
- "role": null
}
], - "removedRoles": [
- {
- "sourceDocumentSpec": null,
- "person": null,
- "group": null,
- "role": null
}
], - "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": null,
- "create": null,
- "update": null,
- "delete": null
}
}, - "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": null,
- "description": null,
- "icon": null,
- "collectionId": null,
- "documentId": null,
- "url": null,
- "itemId": null,
- "createdBy": null,
- "createdAt": null,
- "document": null,
- "shortcut": null,
- "collection": null,
- "itemType": null
}
], - "pinMetadata": {
- "existingPins": [
- null
], - "eligiblePins": [
- null
]
}, - "shortcuts": [
- "string"
], - "children": [
- null
], - "roles": [
- {
- "sourceDocumentSpec": null,
- "person": null,
- "group": null,
- "role": null
}
]
}
], - "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"
}
]
}
}, - "extractedQnA": {
- "heading": "string",
- "question": "string",
- "questionResult": {
- "snippets": [
- {
- "snippet": "snippet",
- "mimeType": "mimeType"
}
], - "metadata": {
- "container": "container",
- "createTime": "2000-01-23T04:56:07.000Z",
- "datasource": "datasource",
- "author": {
- "name": "name"
}, - "documentId": "documentId",
- "updateTime": "2000-01-23T04:56:07.000Z",
- "mimeType": "mimeType",
- "objectType": "objectType"
}, - "title": "title",
- "nativeAppUrl": "slack://foo/bar",
- "mustIncludeSuggestions": [
- {
- "missingTerm": "container",
- "query": "container"
}
]
}
}, - "app": {
- "datasource": "string",
- "docType": "string",
- "mimeType": "string",
- "iconUrl": "string"
}, - "collection": {
- "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"
}
]
}
], - "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": "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
]
}, - "shortcut": {
- "id": 0,
- "inputAlias": "string",
- "destinationUrl": "string",
- "destinationDocumentId": "string",
- "description": "string",
- "unlisted": true,
- "urlTemplate": "string",
- "addedRoles": [
- null
], - "removedRoles": [
- null
], - "permissions": {
- "write": null
}, - "createdBy": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "createTime": "2019-08-24T14:15:22Z",
- "updatedBy": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "updateTime": "2019-08-24T14:15:22Z",
- "destinationDocument": {
- "id": null,
- "datasource": null,
- "connectorType": null,
- "docType": null,
- "content": null,
- "containerDocument": null,
- "parentDocument": null,
- "title": null,
- "url": null,
- "metadata": null,
- "sections": [ ]
}, - "intermediateUrl": "string",
- "viewPrefix": "string",
- "isExternal": true,
- "editUrl": "string",
- "alias": "string",
- "title": "string",
- "roles": [
- null
]
}, - "collection": null,
- "itemType": "DOCUMENT"
}
], - "pinMetadata": {
- "existingPins": [
- {
- "category": "COMPANY_RESOURCE",
- "value": "string",
- "target": "RESOURCE_CARD"
}
], - "eligiblePins": [
- {
- "id": 0,
- "target": {
- "category": null,
- "value": null,
- "target": null
}
}
]
}, - "shortcuts": [
- "string"
], - "children": [
- null
], - "roles": [
- {
- "sourceDocumentSpec": {
- "url": "string"
}, - "person": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "group": {
- "type": "DEPARTMENT",
- "id": "string",
- "name": "string"
}, - "role": "OWNER"
}
]
}, - "answerBoard": {
- "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"
}
]
}, - "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": 0,
- "inputAlias": "string",
- "destinationUrl": "string",
- "destinationDocumentId": "string",
- "description": "string",
- "unlisted": true,
- "urlTemplate": "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"
}
], - "permissions": {
- "write": {
- "scopeType": "GLOBAL",
- "create": true,
- "update": true,
- "delete": true
}
}, - "createdBy": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "createTime": "2019-08-24T14:15:22Z",
- "updatedBy": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "updateTime": "2019-08-24T14:15:22Z",
- "destinationDocument": {
- "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"
}
]
}, - "intermediateUrl": "string",
- "viewPrefix": "string",
- "isExternal": true,
- "editUrl": "string",
- "alias": "string",
- "title": "string",
- "roles": [
- {
- "sourceDocumentSpec": {
- "url": "string"
}, - "person": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "group": {
- "type": "DEPARTMENT",
- "id": "string",
- "name": "string"
}, - "role": "OWNER"
}
]
}, - "querySuggestions": {
- "suggestions": [
- {
- "query": "app:github type:pull author:mortimer",
- "label": "Mortimer's PRs",
- "datasource": "github"
}
], - "person": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}
}, - "relatedDocuments": [
- {
- "relation": "CASE",
- "associatedEntityId": "string",
- "querySuggestion": {
- "query": "app:github type:pull author:mortimer",
- "label": "Mortimer's PRs",
- "datasource": "github"
}, - "documents": [
- {
- "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
]
}
], - "results": [
- {
- "snippets": [
- {
- "snippet": "snippet",
- "mimeType": "mimeType"
}
], - "metadata": {
- "container": "container",
- "createTime": "2000-01-23T04:56:07.000Z",
- "datasource": "datasource",
- "author": {
- "name": "name"
}, - "documentId": "documentId",
- "updateTime": "2000-01-23T04:56:07.000Z",
- "mimeType": "mimeType",
- "objectType": "objectType"
}, - "title": "title",
- "nativeAppUrl": "slack://foo/bar",
- "mustIncludeSuggestions": [
- {
- "missingTerm": "container",
- "query": "container"
}
]
}
]
}
], - "relatedQuestion": {
- "question": "string",
- "answer": "string",
- "ranges": [
- {
- "startIndex": 0,
- "endIndex": 0,
- "type": "BOLD",
- "url": "string",
- "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
]
}
}
]
}, - "disambiguation": {
- "name": "string",
- "id": "string",
- "type": "PERSON"
}, - "snippets": [
- {
- "snippet": "snippet",
- "mimeType": "mimeType"
}
], - "trackingToken": "string",
- "prominence": "HERO",
- "source": "EXPERT_DETECTION"
}
], - "generatedQnaResult": {
- "question": "string",
- "answer": "string",
- "followUpPrompts": [
- "string"
], - "followupActions": [
- {
- "actionInstanceId": "string"
}
], - "ranges": [
- {
- "startIndex": 0,
- "endIndex": 0,
- "type": "BOLD",
- "url": "string",
- "document": {
- "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"
}
]
}
}
], - "status": "COMPUTING",
- "cursor": "string",
- "trackingToken": "string"
}, - "errorInfo": {
- "badGmailToken": true,
- "badOutlookToken": true,
- "invalidOperators": [
- {
- "key": "string",
- "value": "string"
}
], - "errorMessages": [
- {
- "source": "string",
- "errorMessage": "string"
}
]
}, - "requestID": "string",
- "backendTimeMillis": 1100
}