API Tester Params —
squish.issue.attachPOST
Attaches a file to the specified comment.
GET Parameters:
- prj: The short name of the project
- id: The display ID of the enclosing issue
- comment: The comment ID to attach the file to (see also getComments and postComment)
- stealth: Passing a value of 1 will cause the modification date/count/user to remain unchanged. This is especially useful if attaching to a description immediately after submission. (default=0)
Data Object (JSON-encoded in POST):
- file_name: The name of the attachment
- file_data: The base64-encoded file data
URL:
https://api.squishlist.com/rest/?method=squish.issue.attach
Result:
None yet.
squish.issue.getCommentsGET
Returns a list of comment information objects for the specified issue.
GET Parameters:
- prj: The short name of the project
- id: The display ID of the issue you want comments for
- raw: Passing a value of 1 will cause values to be returned unformatted (default=0)
URL:
https://api.squishlist.com/rest/?method=squish.issue.getComments
Result:
None yet.
squish.issue.getFieldDataGET
Returns all field data for the specified issue. The fields returned may vary depending on the issue type, and whether the API session user is a developer/manager for the issue's project.
GET Parameters:
- prj: The short name of the project
- id: The display ID of the issue you want data for
- raw: Passing a value of 1 will cause values to be returned unformatted (default=0)
- inactive: Passing a value of 1 will include inactive field data (default=0)
URL:
https://api.squishlist.com/rest/?method=squish.issue.getFieldData
Result:
None yet.
squish.issue.getHistoryGET
Returns a list of history information for the specified issue.
GET Parameters:
- prj: The short name of the project
- id: The display ID of the issue you want history for
- raw: Passing a value of 1 will cause values to be returned unformatted (default=0)
URL:
https://api.squishlist.com/rest/?method=squish.issue.getHistory
Result:
None yet.
squish.issue.getRelatedIssuesGET
Returns a list of any issues related to this one, either by being specified in a comment, or referenced in a comment on another issue.
GET Parameters:
- prj: The short name of the project
- id: The display ID of the issue you want related issues for
URL:
https://api.squishlist.com/rest/?method=squish.issue.getRelatedIssues
Result:
None yet.
squish.issue.postCommentPOST
Posts a comment on the specified issue.
GET Parameters:
- prj: The short name of the project
- id: The display ID of the issue you want to post a comment on
Data Object (JSON-encoded in POST):
- comment: The body of the comment
- format: The formatting syntax ("bbcode" or "markdown") - defaults to the user's preference
- confidential: True if the comment should be confidential, false otherwise
URL:
https://api.squishlist.com/rest/?method=squish.issue.postComment
Result:
None yet.
squish.issue.submitPOST
Submits a new issue to the specified project.
GET Parameters:
- prj: The short name of the project
- format: The formatting syntax used in the description ("bbcode" or "markdown") - defaults to the user's preference
Data Object (JSON-encoded in POST):
- The keys of the JSON object should be either variable IDs or bug_field names, both available from the getFields API call. The values associated with the keys are dependent on the variable type. Lookups may be specified using either IDs or labels.
URL:
https://api.squishlist.com/rest/?method=squish.issue.submit
Result:
None yet.
squish.issue.updatePOST
Updates the specified issue.
GET Parameters:
- prj: The short name of the project
- id: The display ID of the issue to update
Data Object (JSON-encoded in POST):
- The keys of the JSON object should be either variable IDs or bug_field names, both available from the getFields API call. The values associated with the keys are dependent on the variable type. Lookups may be specified using either IDs or labels.
URL:
https://api.squishlist.com/rest/?method=squish.issue.update
Result:
None yet.