Identity__announcement

QUERYidentity__announcement(where: CommonFindDocumentDto!): Announcement!

Platform admin only.

Arguments

where*

Returns

identity__announcement

_id*ID!

body*String!

createdAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

createdBy?

sendAsEmail?Boolean

severity*NoticeSeverity!

Value inCRITICALINFOWARNING

title*String!

updatedAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

visible?Boolean

Example Request

query Identity__announcement($where: CommonFindDocumentDto!) {
  identity__announcement(where: $where) {
    _id
    body
    createdAt
    createdBy {
      email
      name
      phoneNumber
      referenceId
    }
    sendAsEmail
    severity
    title
    updatedAt
    visible
  }
}

query Identity__announcement($where: CommonFindDocumentDto!) {  identity__announcement(where: $where) {    _id    body    createdAt    createdBy {      email      name      phoneNumber      referenceId    }    sendAsEmail    severity    title    updatedAt    visible  }}

Variables

{
  "where": {
    "and": [
      {
        "and": [
          {
            "and": [
              {
                "and": [
                  {}
                ],
                "key": "string"
              }
            ],
            "key": "string"
          }
        ],
        "key": "string"
      }
    ],
    "key": "string"
  }
}

Variables

{  "where": {    "and": [      {        "and": [          {            "and": [              {                "and": [                  {}                ],                "key": "string"              }            ],            "key": "string"          }        ],        "key": "string"      }    ],    "key": "string"  }}

Example Response

{
  "data": {
    "identity__announcement": {
      "_id": "1",
      "body": "string",
      "createdAt": "<DateTime>",
      "createdBy": {
        "email": "string",
        "name": "string",
        "phoneNumber": "string",
        "referenceId": "1"
      },
      "sendAsEmail": true,
      "severity": "CRITICAL",
      "title": "string",
      "updatedAt": "<DateTime>",
      "visible": true
    }
  }
}

Example Response

{  "data": {    "identity__announcement": {      "_id": "1",      "body": "string",      "createdAt": "<DateTime>",      "createdBy": {        "email": "string",        "name": "string",        "phoneNumber": "string",        "referenceId": "1"      },      "sendAsEmail": true,      "severity": "CRITICAL",      "title": "string",      "updatedAt": "<DateTime>",      "visible": true    }  }}

ArgumentsCopy Anchor Link

ReturnsCopy Anchor Link

Arguments

Returns