Categories

Category API: `/api/bw/v2/category`

API BW version 2 (Beta)

Allows you to add, update or delete Category terms that are used to categorize or filter the Resources and Maps of a Boldest platform account.

Methods

POST: Create/Update Category

POST json Data to import in JSON format according to Schema /api/bw/v2/category/schema.json

Consult the Schema documentation for the structure of the JSON data.

RESULT:

HTTP 201 Created. The Category did not exist, so it was created

{
  "done": "Create Category TEST111",
  "id": "TEST111",
  "new": true,
  "update": true
}

HTTP 202 Accepted. The Category existed, so it was updated

{
  "done": "Update Category TEST111",
  "id": "TEST111",
  "new": false,
  "update": true
}

HTTP 400 Wrong request

{
  "fail": "Wrong request"
}

HTTP 401 Unauthorized

{
  "fail": "Unauthorized"
}

HTTP 409 Conflict. The submitted contents are not valid

{
  "fail": "Explanation of the problems encountered"
}

GET: Get Category/s

/{ids} Id or Ids CSV format (Optional)
/excludeFiles Ignore file fields (Optional) (Default:No)

DELETE: Delete Category/s

/{ids} Id or Ids CSV format

RESULT:

HTTP 202 Deleted

{
  "done": "Deletion of 5 Categories done",
  "batchId": "22123112345678",
  "count": 5 // Number of Categories deleted
}

Partial deletion

{
  "done": "Deletion of 3 Categories done",
  "batchId": "22123112345678",
  "count": 3, // Number of Categories deleted
  "fail": "Deletion of 2 Categories not done",
  "failed": ["TEST114", "TEST115"]
}

HTTP 400 Wrong request

{
  "fail": "Wrong request"
}

HTTP 401 Unauthorized

{
  "fail": "Unauthorized"
}

HTTP 404 Not found

{
  "fail": "No Categories to delete"
}

HTTP 409 Conflict. The submitted contents are not valid

{
  "fail": "Deletion of 5 Categories not done"
}

GET: Get Schema JSON from the data structure of a Category

/full Schema and data (Optinal)
/schema.json JSON schema for import

RESULT:

HTTP 200 Success

JSON schema document

GET: Get Schema JSON schema of a group of Categories in a batch process

/full Schema and data (Optinal)
/schema.multiple.json Schema for batch import JSON

RESULT:

HTTP 200 Success

JSON schema document

Category schema documentation

Properties:

These are the fields used in the JSON for the map creation and update API.

id (required) `Type: string. Size: (3, 80)`

Unique key that identifies the Category term

title `Type: string. Size: (0, 100)`

Name of the Category term

description `Type: string (nullable). Size: (0, 500)`

Description text of the Category term

image `Type: uri. Size: (0, 1500)`

URL to icon that represents the Category term (Black svg or png file. Square canvas with a certain margin on all four sides)

Language information

This schema includes certain fields which have multiple languages support.

The following fields have multiple languages support:

title
description

When you use the name of this fields without the suffix with language you are referring to the field in the default language.

If you want to use a field in a different language, you must add to the field name the language code separated by an underscore (_).

For example, if the proyect have English language and you want to use the field title in English language, you must add the language code en to the field name as title_en.