JetBrains Space Help

Docs

Create draft

post /api/http/docs/drafts
Request arguments
object with fields :
  • title : string ( Nullable and Optional , defaults to null )

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

  • textVersion : integer (format: int64) ( Nullable and Optional )

  • type : DraftDocumentType ( Optional , defaults to "WYSIWYG" )

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

  • publicationDetails2 : PublicationDetails ( Nullable and Optional )

Response
DR_Draft

Get draft

get /api/http/docs/drafts/{id}
Request arguments
id : string (Path) ( Required )
Response
DR_Draft

Update draft

patch /api/http/docs/drafts/{id}
Request arguments
id : string (Path) ( Required )
object with fields :
  • title : string ( Nullable and Optional , defaults to null )

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

  • textVersion : integer (format: int64) ( Nullable and Optional )

  • type : DraftDocumentType ( Nullable and Optional , defaults to null )

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

  • publicationDetails2 : PublicationDetails ( Nullable and Optional )

Response
DR_Draft

Delete draft

delete /api/http/docs/drafts/{id}
Request arguments
id : string (Path) ( Required )
Response
No arguments

Create folder

post /api/http/docs/drafts/folder
Request arguments
object with fields :
  • name : string ( Required )

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

Get folder by alias

get /api/http/docs/drafts/folder/alias:{alias}
Request arguments
alias : string (Path) ( Required )

Delete folder

delete /api/http/docs/drafts/folder/{id}
Request arguments
id : string (Path) ( Required )
Response
No arguments

Update name

patch /api/http/docs/drafts/folder/{id}/name
Request arguments
id : string (Path) ( Required )
object with fields :
  • name : string ( Required )

Response
No arguments

Update parent

patch /api/http/docs/drafts/folder/{id}/parent
Request arguments
id : string (Path) ( Required )
object with fields :
  • parentFolderId : string ( Required )

Create profile

post /api/http/docs/drafts/{id}/editors/profiles
Request arguments
id : string (Path) ( Required )
object with fields :
  • editorId : string ( Required )

Response
No arguments

Get all profiles

get /api/http/docs/drafts/{id}/editors/profiles
Request arguments
id : string (Path) ( Required )
Response
array of TD_MemberProfile

Delete profile

delete /api/http/docs/drafts/{id}/editors/profiles/{editorId}
Request arguments
id : string (Path) ( Required )
editorId : string (Path) ( Required )
Response
No arguments

Create team

post /api/http/docs/drafts/{id}/editors/teams
Request arguments
id : string (Path) ( Required )
object with fields :
  • teamId : string ( Required )

Response
No arguments

Get all teams

get /api/http/docs/drafts/{id}/editors/teams
Request arguments
id : string (Path) ( Required )
Response
array of TD_Team

Delete team

delete /api/http/docs/drafts/{id}/editors/teams/{teamId}
Request arguments
id : string (Path) ( Required )
teamId : string (Path) ( Required )
Response
No arguments
Last modified: 18 November 2020