Categories

Get categories

Returns all categories for the specified tenant

GET /orgs/{org_id}/categories

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name

Request example

1
2
3
4
5



curl -X GET https://customers.sta.masstack.com/v4/orgs/telco/categories \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
200	OK	All categories returned successfully	Categories
400	Bad Request	Invalid request body	ErrorResponse
401	Unauthorized	Unauthorized	ErrorResponse
403	Forbidden	Forbidden resource	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
503	Service Unavailable	Service unavailable	ErrorResponse
504	Gateway Time-out	Repository timeout	ErrorResponse

Post categories

Inserts new categories for the specified tenant

POST /orgs/{org_id}/categories

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
body	body	PostCategories	true	‘none’

Request body - instance of PostCategories

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "categories": [
    {
      "name": "risk",
      "description": "Risk category",
      "valid_values": [
        "string"
      ]
    }
  ]
}

Name	Type	Required	Description
categories	[PostCategory]	true	none

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17



curl -X POST https://customers.sta.masstack.com/v4/orgs/telco/categories \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY" \
 --data-raw "{
  'categories': [
    {
      'name': 'risk',
      'description': 'Risk category',
      'valid_values': [
        'string'
      ]
    }
  ]
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Categories created successfully	Categories
400	Bad Request	Invalid request body	ErrorResponse
401	Unauthorized	Unauthorized	ErrorResponse
403	Forbidden	Forbidden resource	ErrorResponse
409	Conflict	Conflict	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
503	Service Unavailable	Service unavailable	ErrorResponse
504	Gateway Time-out	Repository timeout	ErrorResponse

Get category

Returns specified category

GET /orgs/{org_id}/categories/{category_id}

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
category_id	path	integer(int32)	true	Category id to be returned

Request example

1
2
3
4
5



curl -X GET https://customers.sta.masstack.com/v4/orgs/telco/categories/214748364 \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
200	OK	Category returned successfully	Category
400	Bad Request	Invalid request body	ErrorResponse
401	Unauthorized	Unauthorized	ErrorResponse
403	Forbidden	Forbidden resource	ErrorResponse
404	Not Found	Resource not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
503	Service Unavailable	Service unavailable	ErrorResponse
504	Gateway Time-out	Repository timeout	ErrorResponse

Update category information

PATCH /orgs/{org_id}/categories/{category_id}

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
category_id	path	integer(int32)	true	Category id to be returned
body	body	PatchCategory	true	‘none’

Request body - instance of PatchCategory

1
2
3
4
5
6


{
  "description": "Risk category",
  "valid_values": [
    "string"
  ]
}

Name	Type	Required	Description
description	string	false	Category description
valid_values	[string]	false	Must include all values already present and new values to be added, or less values to be removed.

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12



curl -X PATCH https://customers.sta.masstack.com/v4/orgs/telco/categories/214748364 \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY" \
 --data-raw "{
  'description': 'Risk category',
  'valid_values': [
    'string'
  ]
}" 

Responses

Code	Meaning	Description	Schema
204	No Content	successful operation	None
400	Bad Request	Invalid request body	ErrorResponse
401	Unauthorized	Unauthorized	ErrorResponse
403	Forbidden	Forbidden resource	ErrorResponse
404	Not Found	Resource not found	ErrorResponse
409	Conflict	Conflict	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
503	Service Unavailable	Service unavailable	ErrorResponse
504	Gateway Time-out	Repository timeout	ErrorResponse

Delete category by id

Delete the category by its id

DELETE /orgs/{org_id}/categories/{category_id}

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
category_id	path	integer(int32)	true	Category id to be returned

Request example

1
2
3
4
5



curl -X DELETE https://customers.sta.masstack.com/v4/orgs/telco/categories/214748364 \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
204	No Content	successful operation	None
400	Bad Request	Invalid request body	ErrorResponse
401	Unauthorized	Unauthorized	ErrorResponse
403	Forbidden	Forbidden resource	ErrorResponse
404	Not Found	Resource not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
503	Service Unavailable	Service unavailable	ErrorResponse
504	Gateway Time-out	Repository timeout	ErrorResponse