Home Page > Integration > REST API > Categories

Categories

Categories - /REST/1/Categories/:id

This endpoint is used for manipulating Categories within the system. Objects are always returned in a JSON format within an array. Empty results return an empty array.

 

Object

The Category resource takes on the following JSON form:

{
    "alive": "<bool>",
    "code": "<string>",
    "default_access_level": "<int>",
    "default_rank": "<int>",
    "description": "<text>",
    "display_order": "<int>",
    "id": "<int>",
    "name": "<string>",
    "projects_category": "<int>"
}

 

GET

This verb is used for retrieving resources, it is subject to the parameters mentioned in the overview and all fields mentioned above are searchable, for instance, to search for all Categories which are not alive and start with code "AXO":

 

curl -X GET http://my.openasset.example.org/REST/1/Categories?alive=0&code=AXO

 

PUT

This verb is used for updating an existing resource. The following JSON parameters can be used within the body:

 

JSON Parameter Allowed values
alive

boolean

default_access_level integer
default_rank integer
description text
name string
display_order integer
Last modified
07:16, 20 Mar 2015

Tags

This page has no custom tags.

Classifications

This page has no classifications.