⚠️ This documentation pertains to a preview endpoint. This feature is not yet ready for API consumption and may change.
For inquiries or feedback, please contact us at Glean.

Read Announcement

post/getannouncement

Read the details of an Announcement given its ID.

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

GetAnnouncement request

id
required
integer

The id of the announcement to be retrieved.

Responses
200

OK

Response Schema: application/json
object (Announcement)
object (AnnouncementError)
trackingToken
string

An opaque token that represents this particular announcement. To be used for /feedback reporting.

400

Invalid request

401

Not Authorized

429

Too Many Requests

Request samples
application/json
{
  • "id": 0
}
Response samples
application/json
{
  • "announcement": {
    • "startTime": "2019-08-24T14:15:22Z",
    • "endTime": "2019-08-24T14:15:22Z",
    • "title": "string",
    • "body": {
      • "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": [
                • 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
                }
              ]
            },
          • "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."
          }
        ]
      },
    • "emoji": "string",
    • "thumbnail": {
      • "photoId": "string",
      • "url": "string"
      },
    • "banner": {
      • "photoId": "string",
      • "url": "string"
      },
    • "audienceFilters": [
      • {
        • "fieldName": "type",
        • "values": [
          • {
            • "value": "Spreadsheet",
            • "relationType": "EQUALS"
            },
          • {
            • "value": "Presentation",
            • "relationType": "EQUALS"
            }
          ]
        }
      ],
    • "sourceDocumentId": "string",
    • "hideAttribution": true,
    • "channel": "MAIN",
    • "postType": "TEXT",
    • "isPrioritized": true,
    • "viewUrl": "string",
    • "draftId": 342,
    • "permissions": {
      • "write": {
        • "scopeType": "GLOBAL",
        • "create": true,
        • "update": true,
        • "delete": true
        }
      },
    • "id": 0,
    • "author": {
      • "name": "George Clooney",
      • "obfuscatedId": "abc123"
      },
    • "createTimestamp": 0,
    • "lastUpdateTimestamp": 0,
    • "updatedBy": {
      • "name": "George Clooney",
      • "obfuscatedId": "abc123"
      },
    • "viewerInfo": {
      • "isDismissed": true,
      • "isRead": true
      },
    • "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"
          }
        ]
      },
    • "isPublished": true
    },
  • "trackingToken": "string",
  • "error": {
    • "errorType": "INVALID_ID"
    }
}