High-level RESTful Web service attributes

Table 1. Resource operation attributes
Attribute Description
WSDelete
In order to remove an existing resource, you set the WSDelete attribute.
WSGet
In order to retrieve a resource, you set the WSGet attribute.
WSPost
In order to create a new resource, you set the WSPost attribute.
WSPut
Update an existing resource with the WSPut attribute.
Table 2. Path templating attributes
Attribute Description
WSParam
Specifies a value for a template path to a REST Web service resource.
WSPath = "/{ path-element | value-template } [/...]"
Specifies a path to a REST Web service resource that identifies its function and allows parameters to be passed in the URL.
Table 4. Name, description, optional attributes
Attribute Description
WSDescription
Describes REST function parameters.
WSName
Specify alternative names for parameters in a REST function.
WSOptional
Qualifies a parameter as optional in a REST function.
Table 5. File handling attributes
Attribute Description
WSAttachment
Defines file attachments in the REST message.
WSMedia = " MIME-type [,...]"
Defines the data format of the REST message.
Table 6. HTTP code attributes
Attribute Description
WSRetCode= "{ code | code:description } "
Defines the HTTP status sent in the REST response.
Table 7. Context attributes
Attribute Description
WSContext
Defines an injection variable to retrieve REST operation context values at the service level.
Table 8. Error handling attributes
Attribute Description
WSError= "description"
Specifies a description of the status-code that is returned in the HTTP response.
WSThrows = "{ code | code:description | code:@variable } [,...]"
Defines a list of errors that may be encountered accessing a REST resource.
Table 9. Security handling attributes
Attribute Description
WSInfo
Specify information about the Web service such as title, version, contact details, scopes, etc.
WSScope = "{ scope } [,...]"
Specify security in the REST service via scopes.