Jump to: navigation, search

Rule Packages

API Method Syntax Request Body Response Body HTTP Status Codes Notes
Query Packages GET [+]Show N/A [+]Show
  • 200 OK—Response body provided
  • 401 Unauthorized—APIToken not valid
  • 403 Forbidden—User does not have permission for the specified tenant or business node.
  • 503—Service Unavailable
User must have permission to view the specified tenant and business node.
Query Package Details GET [+]Show N/A [+]Show
  • 200 OK—Response body provided
  • 401 Unauthorized—APIToken not valid
  • 404 Not Found—could not find specified package ID. Use Query Packages to obtain correct ID.
  • 503—Service Unavailable
 
Create Package POST [+]Show [+]Show [+]Show
  • 201 Created—Response body provided
  • 401 Unauthorized—APIToken not valid
  • 403 Forbidden—User does not have permission for the specified tenant or business node, or does not have proper permission to perform this operation.
  • 422 Unprocessable Entry—Field Validation Error
[+]Show

Other possible return values:

  • 1001—name—package name contains invalid character(s)
  • 1002—name—package name cannot contain java keyword(s)
  • 1003—name—package name already in use
  • 1004—type—package type must be specified
  • 1005—templates—specified template: {templatename} version: {version} not found
  • 1006—businessName—business name already in use
  • 503—Service Unavailable
 
Modify Package PUT [+]Show [+]Show [+]Show
  • 200 OK—Response body provided
  • 401 Unauthorized—APIToken not valid
  • 403 Forbidden—User does not have permission for the specified tenant or business node, or does not have proper permission to perform this operation.
  • 422 - Unprocessable Entry - Field Validation Error
[+]Show
  • 1005—templates—specified template: {templatename} version: {version} not found
  • 1006—businessName—business name already in use
  • 503—Service Unavailable
User must have MODIFY_PACKAGE permission. User can modify the following fields:
  • businessName
  • description
  • templates

Any other fields modified will be ignored.

Delete Package DELETE [+]Show N/A N/A
  • 204 No Content—Returned if successful operation
  • 401 Unauthorized—APIToken not valid
  • 403 Forbidden—User does not have permission for the specified tenant or does not have proper permission to perform this operation.
  • 404 Not Found—Could not find specified package ID.
  • 503—Service Unavailable
User must have PACKAGE_DELETE permission.
This page was last modified on July 30, 2015, at 06:17.

Feedback

Comment on this article:

blog comments powered by Disqus