Create a feature

Creates a new feature.

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

This class represents the feature data transfer object for the command request.

eventIdstring · nullableOptional

The event id. This value represents the event that the feature belongs to.

codestring · min: 1Required

The code of the feature.

namestring · min: 1Required

The name of the feature.

unitstring · nullableOptional

The unit of the feature.

defaultValueinteger · int32 · nullableOptional

The default value of the feature.

helpURLstring · uri · nullableOptional

The help URL of the feature. This value must be a valid URL.

imagestring · uri · nullableOptional

The image of the feature. This value must be a valid URL.

stylesstring · nullableOptional

The style of the feature. It is a JSON string. You can use this property to store the CSS styles of the feature.

descriptionstring · nullableOptional

The description of the feature. The description can be a long text.

tagsstring · nullableOptional

The tags of the feature. You can use this property to store the tags of the feature.

zOrderinteger · int64Optional

The zOrder number in the list. This property is used to sort the features in the list when displaying them. By default, the value is 1.

statusstring · enumOptional

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

Supported values:

• Inactive - In case of JFW object's status being inactive.
• Active - In case of JFW object's status being active

Possible values:

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

403

The user's access was denied.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

post

/api/v1/features

HTTPcURLJavaScriptPython

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

{
  "eventId": "EVT12345",
  "code": "FEATURE_LOGIN",
  "name": "Login Feature",
  "unit": null,
  "defaultValue": null,
  "helpURL": null,
  "image": "https://cdn.jframework.io/features/login-icon.png",
  "styles": "{\"iconColor\":\"#4CAF50\",\"background\":\"#F9F9F9\"}",
  "description": "Allows users to log into the system using secure authentication.",
  "tags": "#auth",
  "zOrder": 1,
  "status": "Active"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 201,
  "message": "The request was successful.",
  "data": {
    "id": "sApKpllz4sAplsmzha",
    "parentBrandId": "ParentBrandId",
    "eventId": "TrackingEventId",
    "code": "Code",
    "name": "Name",
    "unit": null,
    "defaultValue": null,
    "helpURL": null,
    "image": "https://www.example.com/image.jpg",
    "styles": "{\"color\": \"red\"}",
    "description": "Description",
    "tags": "Tag1, Tag2",
    "zOrder": 1,
    "status": "Active"
  },
  "errors": []
}