Create an issue

Creates a new issue.

post

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

The issue of the dto transfer, It's presentation with the create issue request from client.

issueCategoryIdstring · nullableOptional

The id of the issue category.

parentIdstring · nullableOptional

The parent id of the issue. If the issue is sub-issue, it's parent id is the parent issue id.

contentstring · min: 1Required

The content of the issue.

refIdinteger · int64Optional

The referrer id of the issue.

refObjectstring · nullableOptional

The referrer object of the issue.

refTypeinteger · int32 · nullableOptional

The referrer type of the issue.

assigneeIdstring · nullableOptional

Assignee user id of the issue.

prioritystring · enumOptional

Provides the values for the Issue Priority of the Issue entity.

Possible values:

namestring · nullableOptional

The name of the issue.

descriptionstring · nullableOptional

The description of the issue.

issueCcstring · nullableOptional

The cc of the issue. This value is the email address of the user.

tagsstring · nullableOptional

The tags of the issue. This value is the tags of the issue.

Responses

201

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

post

/api/v1/issues

HTTPcURLJavaScriptPython

POST /api/v1/issues HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 205

{
  "issueCategoryId": "text",
  "parentId": "text",
  "content": "text",
  "refId": 1,
  "refObject": "text",
  "refType": 1,
  "assigneeId": "text",
  "priority": "Low",
  "name": "text",
  "description": "text",
  "issueCc": "text",
  "tags": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 201,
  "message": "The request was successful.",
  "data": {
    "id": "sApKpllz4sAplsmzha",
    "assigneeUserId": "USER_ASSIGN_ID",
    "parentId": "PARENT_ID",
    "name": "NAME",
    "description": "DESCRIPTION",
    "refType": 1,
    "refObject": "REF_OBJECT",
    "refId": 1,
    "content": "CONTENT",
    "issueCc": "ISSUE_CC",
    "issueCategoryCode": "ISSUE_CATEGORY_CODE",
    "issueCategoryName": "ISSUE_CATEGORY_NAME",
    "priority": "High",
    "tags": "#User",
    "status": "Open",
    "medias": [
      "https://example.com/media/issue.png"
    ],
    "children": [],
    "childrenCount": 1,
    "reactions": [
      {
        "type": "Like",
        "issueReactionType": "Like",
        "userId": "USER_ID",
        "id": "ID"
      }
    ],
    "user": {
      "id": "Plamxinzg18snza",
      "code": "EXAMPLE",
      "avatar": "https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50",
      "packageId": "1Plamxinzg18snza",
      "packageCode": "PACKAGE",
      "emailAddress": "[e-mail]",
      "phoneNumber": "[phone]",
      "nickName": "example",
      "roles": [
        "admin",
        "support"
      ]
    }
  },
  "errors": []
}