Skip to content

Requests and validation

Request classes map Java-friendly methods to the snake_case field names required by Okatana.

new CreateBoardRequest("Review")
    .wipLimit(4)
    .done(false);

serializes as:

{
  "name": "Review",
  "wip_limit": 4,
  "is_done": false
}

Local checks

The SDK validates constraints present in the supplied contract before network I/O. Examples include:

  • project name: maximum 180 characters;
  • project key: maximum 12 characters;
  • project description: maximum 5,000 characters;
  • board name: maximum 120 characters;
  • board color: maximum 32 characters;
  • WIP limit: minimum 1 when non-null;
  • ticket title: maximum 500 characters;
  • ticket description/comment HTML: maximum 200,000 characters;
  • ticket move position: minimum 0;
  • page size: 1 through 200;
  • document title: maximum 500 characters;
  • document caption: maximum 2,000 characters;
  • document content: maximum 1,000,000 characters;
  • document editors: maximum 100;
  • document tags: maximum 20, each maximum 50 characters;
  • notification recipients: 1 through 100;
  • notification title: maximum 180 characters;
  • notification body: maximum 2,000 characters;
  • notification URL: internal /app path when supplied.

Local validation is not a replacement for server validation. Relationship rules, organization boundaries, membership, WIP state, sanitization, and other business rules are still enforced by Okatana.