JetBrains Space Help

Blog

Publish blog post

post /api/http/blog

Rights, that may be checked: Publish articles

Request arguments
object with fields :
  • title : string ( Required )

  • content : string ( Required )

  • locations : array of string ( Nullable and Optional , defaults to null )

  • teams : array of string ( Nullable and Optional , defaults to null )

  • event : BlogCalendarEvent ( Nullable and Optional , defaults to null )

Response
ArticleRecord

Get all blog posts

get /api/http/blog

Rights, that may be checked: View articles

Request arguments
$skip : string (Query) ( Nullable and Optional , defaults to null )
$top : integer (format: int32) (Query) ( Nullable and Optional , defaults to 100 )
term : string (Query) ( Nullable and Optional , defaults to null )
dateFrom : string (format: date-time) (Query) ( Nullable and Optional , defaults to null )
dateTo : string (format: date-time) (Query) ( Nullable and Optional , defaults to null )
authorId : string (Query) ( Nullable and Optional , defaults to null )
teamId : string (Query) ( Nullable and Optional , defaults to null )
locationId : string (Query) ( Nullable and Optional , defaults to null )
forProfile : string (Query) ( Nullable and Optional , defaults to null )
Response
object with fields :
  • next : string ( Required )

  • totalCount : integer (format: int32) ( Nullable and Optional , defaults to null )

  • data : array of ArticleRecord ( Required )

Import blog posts

post /api/http/blog/import

Rights, that may be checked: Import articles

Request arguments
object with fields :
Response
array of ArticleImportResult

Get stats

get /api/http/blog/stats

Rights, that may be checked: View articles

Request arguments
dateFrom : string (format: date-time) (Query) ( Nullable and Optional , defaults to null )
dateTo : string (format: date-time) (Query) ( Nullable and Optional , defaults to null )
authorId : string (Query) ( Nullable and Optional , defaults to null )
teamId : string (Query) ( Nullable and Optional , defaults to null )
locationId : string (Query) ( Nullable and Optional , defaults to null )
Response
BG_Stats

Get blog post by alias

get /api/http/blog/alias:{alias}

Rights, that may be checked: View articles

Request arguments
alias : string (Path) ( Required )
Response
ArticleRecord

Get blog post by external id

get /api/http/blog/external-id:{id}

Rights, that may be checked: View articles

Request arguments
id : string (Path) ( Required )
Response
ArticleRecord

Get blog post

get /api/http/blog/{id}

Rights, that may be checked: View articles

Request arguments
id : string (Path) ( Required )
Response
ArticleRecord

Update blog post

patch /api/http/blog/{id}

Rights, that may be checked: Publish articles

Request arguments
id : string (Path) ( Required )
object with fields :
  • title : string ( Nullable and Optional , defaults to null )

  • content : string ( Nullable and Optional , defaults to null )

  • locations : array of string ( Nullable and Optional , defaults to null )

  • teams : array of string ( Nullable and Optional , defaults to null )

  • event : BlogCalendarEvent ( Nullable and Optional )

Response
ArticleRecord

Unpublish blog post

delete /api/http/blog/{id}

Unpublish Blog post

Rights, that may be checked: Unpublish articles

Request arguments
id : string (Path) ( Required )
Response
No arguments
Last modified: 18 November 2020