Get resource types

Gets a list of resource types.

get

Query parameters

CodestringOptional

Filter by code.

NamestringOptional

Filter by name.

TagsstringOptional

Filter by tags.

DescriptionstringOptional

Filter by description.

Typestring · enumOptional

The param type to apply filter.

Possible values:

KeywordsstringOptional

Filter by keywords.

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

Responses

200

The request was successful.

application/json

The API result model 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: 1Required

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

get

/api/v1/resource-types

HTTPcURLJavaScriptPython

GET /api/v1/resource-types HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": [
    {
      "id": "sApKpllz4sAplsmzha",
      "parentBrandId": null,
      "guid": "00000000-0000-0000-0000-000000000000",
      "code": "USER",
      "name": "User",
      "description": "The user resource",
      "tags": "ResourceType Tags",
      "type": "BuiltIn"
    }
  ],
  "errors": []
}