POST api/consumer/v1/workspaces/{workspaceId}/categories

Add a new workspace category

Request Information

URI Parameters

NameDescriptionTypeAdditional information
workspaceId

Workspace ID

 integer

Required

Body Parameters

New workspace category information

EventCategoryEditDto
NameDescriptionTypeAdditional information
Icon

The icon of the element

 string

None
Color

The color of the element

 string

None
EntityId

The target's entity identifier

 integer

None
EntityFullname

Entity full name of element

 string

None
Code

The short code of the element

 string

None
Description

The description of the element

 string

None
IsActive

True if the element is active, false otherwise

 boolean

None
Id

Unique ID

 integer

None

Request Formats

application/json, text/json

Sample: 
{
  "Icon": "sample string 1",
  "Color": "sample string 2",
  "EntityId": 3,
  "EntityFullname": "sample string 4",
  "Code": "sample string 5",
  "Description": "sample string 6",
  "IsActive": true,
  "Id": 8
}

application/xml, text/xml

Sample: 
<EventCategoryEditDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oryx.Web.Api.Models">
  <Id>8</Id>
  <Code>sample string 5</Code>
  <Description>sample string 6</Description>
  <IsActive>true</IsActive>
  <Color>sample string 2</Color>
  <EntityFullname>sample string 4</EntityFullname>
  <EntityId>3</EntityId>
  <Icon>sample string 1</Icon>
</EventCategoryEditDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

New workspace category

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None
Content

HttpContent

None
StatusCode

HttpStatusCode

None
ReasonPhrase

string

None
Headers

Collection of Object

None
RequestMessage

HttpRequestMessage

None
IsSuccessStatusCode

boolean

None