Create an issue category

Creates a new issue category.

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 category of the dto transfer when creating or updating.

parenIdstring | nullableOptional

The id of the parent issue category.If null, it is a root issue category.

groupCodestring | nullableOptional

The group code of the issue category.

codestring · min: 1Required

The code of the issue category.

namestring · min: 1Required

The name of the issue category.

descriptionstring | nullableOptional

The description of the issue category.

tagsstring | nullableOptional

The tags of the issue category.

suggestionUrlstring · uri | nullableOptional

The links of the issue category.

Example: https://www.example.com/suggestion

statusstring · enumOptional

This enum is used to define the common status of an object in JFW.

Supported values:

Possible values:

Responses

201

The request was successful.

application/json

401

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

application/json

403

The user's access was denied.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

post

HTTPcURLJavaScriptPython

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

{
  "parenId": "text",
  "groupCode": "text",
  "code": "text",
  "name": "text",
  "description": "text",
  "tags": "text",
  "suggestionUrl": "https://www.example.com/suggestion",
  "status": "Inactive"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 201,
  "message": "The request was successful.",
  "data": {
    "groupCode": "REPORT-PROBLEM",
    "parentId": null,
    "code": "USER-REPORT",
    "name": "User Report",
    "description": "This is a user report",
    "isSystem": false,
    "tags": "#Tags",
    "suggestionURL": "https://www.example.com/suggestion",
    "status": "Active",
    "id": "sApKpllz4sAplsmzha"
  },
  "errors": []
}