Ticket API
{ http://soa.com/wsdl/ticket/1.0 } TicketAPI
The Tickets service provides operations for managing tickets about apps or APIs, including the ticket label and the associated comments and marks.
GET/ticketsgetTickets
Parameters
Name
Type
Description
Model
APIID
query
string
AppID
query
string
RetrievingUserID
query
string
AuthorID
query
string
ItemID
query
string
Tag
query
string
Label
query
string
State
query
string
IncludeComments
query
boolean
NumberOfComments
query
integer
IncludeActions
query
boolean
SortBy
query
string
start
query
integer
count
query
integer
Reponse
Produces application/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
Tickets
Tickets {
Ticket {
Action {}
BoardItemArtifact {
Image {
AuthoringUser {
CommentsPreview {
Comment {
TargetResource {
Ticket( Collection of Ticket )
}
Ticket {
Action( Collection of Action )
Description( string )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact )
Label( Collection of string )
Marks( int )
Image( Image )
Created( dateTime )
TicketID( string )
AppID( string )
UserID( string )
AuthoringUser( AuthoringUser )
UserName( string )
Comments( int )
DescriptionMediaType( string )
Title( string )
APIID( string )
CommentsPreview( CommentsPreview )
TargetResources( Collection of TargetResource )
PubDate( dateTime )
State( string )
Environment( string )
Published( boolean )
Visibility( string )
Tag( Collection of string )
Link( string )
}
Action {}
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 )
}
CommentsPreview {
Comment( Collection of Comment )
Count( int )
}
Comment {
Action( Collection of Action )
UserName( string )
Updated( dateTime )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact )
Marks( int )
CommentSubjectID( string )
CommentID( string )
Created( dateTime )
AvatarURL( anyURI )
WorkflowState( string )
Content( string )
UserID( string )
Published( boolean )
MediaType( string )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
POST/ticketssubmitTicket
Parameters
Accepts application/json application/xml application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
body
entity
Ticket
Ticket {
Action {}
BoardItemArtifact {
Image {
AuthoringUser {
CommentsPreview {
Comment {
TargetResource {
Action( Collection of Action, required )
Description( string )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact, required )
Label( Collection of string )
Marks( int )
Image( Image, required )
Created( dateTime )
TicketID( string )
AppID( string )
UserID( string, required )
AuthoringUser( AuthoringUser, required )
UserName( string )
Comments( int )
DescriptionMediaType( string )
Title( string )
APIID( string )
CommentsPreview( CommentsPreview, required )
TargetResources( Collection of TargetResource, required )
PubDate( dateTime )
State( string )
Environment( string )
Published( boolean )
Visibility( string )
Tag( Collection of string )
Link( string )
}
Action {}
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 )
}
CommentsPreview {
Comment( Collection of Comment, required )
Count( int )
}
Comment {
Action( Collection of Action, required )
UserName( string )
Updated( dateTime )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact, required )
Marks( int )
CommentSubjectID( string )
CommentID( string )
Created( dateTime )
AvatarURL( anyURI )
WorkflowState( string )
Content( string )
UserID( string, required )
Published( boolean )
MediaType( string )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image, required )
Avatar( string )
Name( string )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/tickets/labelsgetSupportedLabels
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
Labels
Labels {
Label( Collection of string )
}
DELETE/tickets/{ticketID}deleteTicket
Parameters
Name
Type
Description
Model
ticketID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
GET/tickets/{ticketID}getTicket
Parameters
Name
Type
Description
Model
ticketID
path
string
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
Ticket
Ticket {
Action {}
BoardItemArtifact {
Image {
AuthoringUser {
CommentsPreview {
Comment {
TargetResource {
Action( Collection of Action )
Description( string )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact )
Label( Collection of string )
Marks( int )
Image( Image )
Created( dateTime )
TicketID( string )
AppID( string )
UserID( string )
AuthoringUser( AuthoringUser )
UserName( string )
Comments( int )
DescriptionMediaType( string )
Title( string )
APIID( string )
CommentsPreview( CommentsPreview )
TargetResources( Collection of TargetResource )
PubDate( dateTime )
State( string )
Environment( string )
Published( boolean )
Visibility( string )
Tag( Collection of string )
Link( string )
}
Action {}
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 )
}
CommentsPreview {
Comment( Collection of Comment )
Count( int )
}
Comment {
Action( Collection of Action )
UserName( string )
Updated( dateTime )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact )
Marks( int )
CommentSubjectID( string )
CommentID( string )
Created( dateTime )
AvatarURL( anyURI )
WorkflowState( string )
Content( string )
UserID( string )
Published( boolean )
MediaType( string )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
POST/tickets/{ticketID}/actionsexecuteWorkflowAction
Parameters
Accepts application/json application/xml application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
ticketID
path
string
body
entity
Action
Action {
ActionParameter {
ActionName( string, required )
Parameters( Collection of ActionParameter, required )
UserID( string, required )
Comments( string )
}
ActionParameter {
Value( string )
Name( string, required )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/tickets/{ticketID}/commentsgetTicketComments
Parameters
Name
Type
Description
Model
ticketID
path
string
start
query
integer
count
query
integer
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
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( anyURI )
WorkflowState( string )
Content( string )
UserID( string )
Published( boolean )
MediaType( string )
}
Action {}
BoardItemArtifact {
UriPath( string )
FileName( string )
ContextID( string )
BaseUri( string )
}
POST/tickets/{ticketID}/marksmarkTicket
Parameters
Accepts text/plain
Name
Type
Description
Model
ticketID
path
string
body
entity
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
POST/tickets/{ticketID}/labelsupdateTicketLabels
Parameters
Accepts application/json application/xml application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
ticketID
path
string
body
entity
ticketLabelChange
ticketLabelChange {
comments( string )
createdDts( dateTime )
userID( string )
labels( Collection of string )
}
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
string
POST/tickets/{ticketID}/commentscommentOnTicket
Parameters
Accepts application/json application/xml application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
ticketID
path
string
body
entity
Comment
Comment {
Action {}
BoardItemArtifact {
Action( Collection of Action, required )
UserName( string )
Updated( dateTime )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact, required )
Marks( int )
CommentSubjectID( string )
CommentID( string )
Created( dateTime )
AvatarURL( anyURI )
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
DELETE/tickets/{ticketID}/marks/{userID}unmarkTicket
Parameters
Name
Type
Description
Model
ticketID
path
string
userID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
