AlertAPI
{ urn:com.soa.apialert.service.impl } AlertAPI
The Alerts service provides operations that allow you to manage alerts on APIs, including adding, retrieving, and deleting alerts, commenting on an alert, and retrieving comments.
POST/alertscreateAlert
Parameters
Accepts application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
body
entity
Alert
Alert {
BoardItemArtifact {
Image {
AuthoringUser {
Description( string )
UserName( string, required )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact, required )
Priority( string )
Comments( int )
DescriptionMediaType( string, required )
Title( string )
ContractID( string, required )
APIID( string, required )
Marks( int )
Image( Image, required )
Created( dateTime )
AlertID( string )
Type( string )
PubDate( dateTime )
ResourceID( Collection of string )
UserID( string, required )
AuthoringUser( AuthoringUser, required )
Environment( string )
Published( boolean )
Visibility( string )
Tag( Collection of string )
Link( string )
}
BoardItemArtifact {
UriPath( string )
FileName( string, required )
ContextID( string )
BaseUri( string )
}
Image {
Description( string )
Title( string, required )
Url( anyURI, required )
Link( anyURI, required )
}
AuthoringUser {
UserID( string, required )
Image( Image, required )
Name( string )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/alertsgetAlerts
Parameters
Accepts */*
Name
Type
Description
Model
APIID
query
string
ItemID
query
string
Tag
query
string
SortBy
query
string
IncludeComments
query
boolean
NumberOfComments
query
integer
start
query
integer
count
query
integer
Reponse
Produces text/xmlapplication/rss+xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
rss
rss {
rssChannel {
rssImage {
rssItem {
rssEnclosure {
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
rssSkipDays {
rssCloud {
rssTextInput {
channel( rssChannel )
version( string )
}
rssChannel {
image( rssImage )
copyright( string )
item( rssItem )
skipHours( rssSkipHours )
lastBuildDate( string )
link( anyURI )
rating( string )
description( string )
generator( string )
language( string )
title( string )
managingEditor( string )
webMaster( string )
pubDate( string )
ttl( int )
skipDays( rssSkipDays )
cloud( rssCloud )
textInput( rssTextInput )
docs( anyURI )
category( rssCategory )
}
rssImage {
link( anyURI )
width( int )
description( string )
title( string )
url( string )
height( int )
}
rssItem {
comments( anyURI )
enclosure( rssEnclosure )
author( string )
link( anyURI )
description( string )
guid( rssGuid )
source( rssSource )
title( string )
category( rssCategory )
pubDate( string )
}
rssEnclosure {
length( string )
type( string )
url( string )
}
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
hour( Collection of string )
}
rssSkipDays {
day( Collection of string )
}
rssCloud {
path( string )
protocol( string )
port( int )
registerProcedure( string )
domain( string )
}
rssTextInput {
name( string )
link( anyURI )
description( string )
title( string )
}
GET/alerts/{AlertID}getAlert
Parameters
Accepts */*
Name
Type
Description
Model
AlertID
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
Alert
Alert {
BoardItemArtifact {
Image {
AuthoringUser {
Description( string )
UserName( string )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact )
Priority( string )
Comments( int )
DescriptionMediaType( string )
Title( string )
ContractID( string )
APIID( string )
Marks( int )
Image( Image )
Created( dateTime )
AlertID( string )
Type( string )
PubDate( dateTime )
ResourceID( Collection of string )
UserID( string )
AuthoringUser( AuthoringUser )
Environment( string )
Published( boolean )
Visibility( string )
Tag( Collection of string )
Link( string )
}
BoardItemArtifact {
UriPath( string )
FileName( string )
ContextID( string )
BaseUri( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
AuthoringUser {
UserID( string )
Image( Image )
Name( string )
}
DELETE/alerts/{AlertID}deleteAlert
Parameters
Accepts */*
Name
Type
Description
Model
AlertID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
POST/alerts/{AlertID}/commentscommentOnAlert
Parameters
Accepts application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
AlertID
path
string
body
entity
Comment
Comment {
Action {}
BoardItemArtifact {
Action( Collection of Action, required )
UserName( string, required )
Updated( dateTime )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact, required )
Marks( int )
CommentSubjectID( string )
CommentID( string )
Created( dateTime )
AvatarURL( string, required )
WorkflowState( string )
Content( string )
UserID( string, required )
Published( boolean )
MediaType( string )
}
Action {}
BoardItemArtifact {
UriPath( string )
FileName( string, required )
ContextID( string )
BaseUri( string )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/alerts/{AlertID}/commentsgetAlertComments
Parameters
Accepts */*
Name
Type
Description
Model
AlertID
path
string
start
query
integer
count
query
integer
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
Comments
Comments {
Comment {
Action {}
BoardItemArtifact {
Comment( Collection of Comment )
totalResults( long )
startIndex( long )
}
Comment {
Action( Collection of Action )
UserName( string )
Updated( dateTime )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact )
Marks( int )
CommentSubjectID( string )
CommentID( string )
Created( dateTime )
AvatarURL( string )
WorkflowState( string )
Content( string )
UserID( string )
Published( boolean )
MediaType( string )
}
Action {}
BoardItemArtifact {
UriPath( string )
FileName( string )
ContextID( string )
BaseUri( string )
}
