Update Answer

post/editanswer

Update an existing user-generated Answer.

SecurityBearerAuth
Request
header Parameters
X-Glean-Auth-Type
string

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

X-Scio-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).

Request Body schema: application/json
required

EditAnswer request

id
required
integer

The opaque ID of the Answer.

addedCollections
Array of integers

IDs of Collections to which a document is added.

Array of objects (UserRoleSpecification)

A list of user roles for the answer added by the owner.

Array of objects (FacetFilter)

Filters which restrict who should see the answer. Values are taken from the corresponding filters in people search.

boardId
integer

The parent board ID of this Answer, or 0 if it's a floating Answer.

bodyText
string

The plain text answer to the question.

object (StructuredTextMutableProperties)
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.

question
string
questionVariations
Array of strings

Additional ways of phrasing this question.

removedCollections
Array of integers

IDs of Collections from which a document is removed.

Array of objects (UserRoleSpecification)

A list of user roles for the answer removed by the owner.

Array of objects (UserRoleSpecification)

A list of roles for this answer explicitly granted by an owner, editor, or admin.

object or object or object (DocumentSpec)
sourceType
string
Enum: "DOCUMENT" "ASSISTANT"
Responses
200

OK

Response Schema: application/json
id
required
integer

The opaque ID of the Answer.

Array of objects (UserRoleSpecification)

A list of user roles for the answer added by the owner.

Array of objects (FacetFilter)

Filters which restrict who should see the answer. Values are taken from the corresponding filters in people search.

object (Person)
object (AnswerBoard)
boardId
integer

The parent board ID of this Answer, or 0 if it's a floating Answer.

bodyText
string

The plain text answer to the question.

Array of objects (Collection)

The collections to which the answer belongs.

object (StructuredText)
createTime
string <date-time>

The time the answer was created in ISO format (ISO 8601).

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.

documentCategory
string

The document's document_category(.proto).

object (AnswerLikes)
object (ObjectPermissions)
question
string
questionVariations
Array of strings

Additional ways of phrasing this question.

Array of objects (UserRoleSpecification)

A list of user roles for the answer removed by the owner.

Array of objects (UserRoleSpecification)

A list of roles for this answer explicitly granted by an owner, editor, or admin.

object (Document)
object or object or object (DocumentSpec)
sourceType
string
Enum: "DOCUMENT" "ASSISTANT"
object (Person)
updateTime
string <date-time>

The time the answer was last updated in ISO format (ISO 8601).

object (Verification)
400

Invalid request

401

Not Authorized

429

Too Many Requests

Request samples
application/json
{
  • "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",
  • "addedCollections": [
    • 0
    ],
  • "removedCollections": [
    • 0
    ],
  • "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."
    }
}
Response samples
application/json
{
  • "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": [
              • "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"
              }
            ]
          },
        • "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": [
            • "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"
            }
          ]
        },
      • "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": 0,
            • "maxDaysFromNow": 0,
            • "start": {
              • "epochSeconds": 0,
              • "daysFromNow": 0
              },
            • "end": {
              • "epochSeconds": 0,
              • "daysFromNow": 0
              }
            },
          • "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": "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": [
                • 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
                }
              ]
            },
          • "shortcut": {
            • "id": 0,
            • "inputAlias": "string",
            • "destinationUrl": "string",
            • "destinationDocumentId": "string",
            • "description": "string",
            • "unlisted": true,
            • "urlTemplate": "string",
            • "addedRoles": [
              • {
                • "sourceDocumentSpec": null,
                • "person": null,
                • "group": null,
                • "role": null
                }
              ],
            • "removedRoles": [
              • {
                • "sourceDocumentSpec": null,
                • "person": null,
                • "group": null,
                • "role": null
                }
              ],
            • "permissions": {
              • "write": {
                • "scopeType": null,
                • "create": null,
                • "update": null,
                • "delete": 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": "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
                ]
              },
            • "intermediateUrl": "string",
            • "viewPrefix": "string",
            • "isExternal": true,
            • "editUrl": "string",
            • "alias": "string",
            • "title": "string",
            • "roles": [
              • {
                • "sourceDocumentSpec": null,
                • "person": null,
                • "group": null,
                • "role": null
                }
              ]
            },
          • "collection": null,
          • "itemType": "DOCUMENT"
          }
        ],
      • "pinMetadata": {
        • "existingPins": [
          • {
            • "category": "COMPANY_RESOURCE",
            • "value": "string",
            • "target": "RESOURCE_CARD"
            }
          ],
        • "eligiblePins": [
          • {
            • "id": 0,
            • "target": {
              • "category": "COMPANY_RESOURCE",
              • "value": "string",
              • "target": "RESOURCE_CARD"
              }
            }
          ]
        },
      • "shortcuts": [
        • "string"
        ],
      • "children": [
        • null
        ],
      • "roles": [
        • {
          • "sourceDocumentSpec": {
            • "url": "string"
            },
          • "person": {
            • "name": "George Clooney",
            • "obfuscatedId": "abc123"
            },
          • "group": {
            • "type": "DEPARTMENT",
            • "id": "string",
            • "name": "string"
            },
          • "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"
        }
      ]
    }
}