Announcement

PreviousAuthentication NextAPI Registration

Gets a announcement with the given id

get

This endpoint is used to fetch a announcement details in the current organization

Authorizations

Path parameters

idstringRequired

Responses

200

No response body

get

GET /ux/common/announcement/announcements/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

Edits the announcement with given id

put

This endpoint is used to edit an existing announcement for the current organization

Authorizations

Path parameters

idstringRequired

Responses

200

No response body

put

PUT /ux/common/announcement/announcements/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

Delete the announcement with given id

delete

This endpoint is used to delete an existing announcement for the current organization

Authorizations

Path parameters

idstringRequired

Responses

204

No response body

delete

DELETE /ux/common/announcement/announcements/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

get

API endpoint that allows announcements to be viewed or edited.

Authorizations

Responses

200

No response body

get

GET /ux/common/announcement/announcements/change-ancmt/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

API endpoint that allows announcements to be viewed or edited.

Authorizations

Responses

200

No response body

get

GET /ux/common/announcement/announcements/options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

Gets a list of announcement

get

This endpoint is used to fetch all the announcement in the current organization

Authorizations

Query parameters

items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses

200Success

application/json

get

GET /ux/common/announcement/announcements/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Creates a new Announcement

post

This endpoint is used to save a new announcement for the current organization

Authorizations

Body

Other propertiesanyOptional

Responses

201

No response body

post

POST /ux/common/announcement/announcements/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 184

{
  "summary": "VPN Issue",
  "description": "",
  "catalogue": "",
  "impact_service": "",
  "impact_service_name": "service1",
  "service_classification": "",
  "service_classification_name": "",
  "state": "Open"
}

201

No response body

No content