Create a tag for a resource.

POST

/api/workspace/tags

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/tags"),
    Content = new StringContent("{ \"Owner\": { \"ModuleKey\": \"example\", \"ResourceKind\": \"example\", \"ContextResourceId\": \"example\", \"ResourceObjectId\": \"example\" }, \"TagName\": \"example\", \"Color\": \"example\", \"Category\": \"example\" }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/tags';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"Owner":{"ModuleKey":"example","ResourceKind":"example","ContextResourceId":"example","ResourceObjectId":"example"},"TagName":"example","Color":"example","Category":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/workspace/tags \
  --header 'Content-Type: application/json' \
  --data '{ "Owner": { "ModuleKey": "example", "ResourceKind": "example", "ContextResourceId": "example", "ResourceObjectId": "example" }, "TagName": "example", "Color": "example", "Category": "example" }'

Authorizations

None

Parameters

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body

Request payload to create a tag.

object

Owner

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

TagName

Tag name.

string

nullable

Color

Optional color value.

string

nullable

Category

Optional category.

string

nullable

Example^generated

{
  "Owner": {
    "ModuleKey": "example",
    "ResourceKind": "example",
    "ContextResourceId": "example",
    "ResourceObjectId": "example"
  },
  "TagName": "example",
  "Color": "example",
  "Category": "example"
}

Request payload to create a tag.

object

Owner

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

TagName

Tag name.

string

nullable

Color

Optional color value.

string

nullable

Category

Optional category.

string

nullable

Example^generated

{
  "Owner": {
    "ModuleKey": "example",
    "ResourceKind": "example",
    "ContextResourceId": "example",
    "ResourceObjectId": "example"
  },
  "TagName": "example",
  "Color": "example",
  "Category": "example"
}

Request payload to create a tag.

object

Owner

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

TagName

Tag name.

string

nullable

Color

Optional color value.

string

nullable

Category

Optional category.

string

nullable

Example^generated

{
  "Owner": {
    "ModuleKey": "example",
    "ResourceKind": "example",
    "ContextResourceId": "example",
    "ResourceObjectId": "example"
  },
  "TagName": "example",
  "Color": "example",
  "Category": "example"
}

Responses

200

application/json

object

Data

Tag details.

object

Tag identifier.

string

nullable

Owner

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

TagName

Tag name.

string

nullable

Color

Optional color value.

string

nullable

Category

Optional category.

string

nullable

CreatedAt

Creation timestamp.

string format: date-time

CreatedByUserId

Creator user identifier.

string

nullable

CreatedByUserName

Creator display name.

string

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Tag details.

object

Tag identifier.

string

nullable

Owner

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

TagName

Tag name.

string

nullable

Color

Optional color value.

string

nullable

Category

Optional category.

string

nullable

CreatedAt

Creation timestamp.

string format: date-time

CreatedByUserId

Creator user identifier.

string

nullable

CreatedByUserName

Creator display name.

string

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

application/json

object

Data

Tag details.

object

Tag identifier.

string

nullable

Owner

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

TagName

Tag name.

string

nullable

Color

Optional color value.

string

nullable

Category

Optional category.

string

nullable

CreatedAt

Creation timestamp.

string format: date-time

CreatedByUserId

Creator user identifier.

string

nullable

CreatedByUserName

Creator display name.

string

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Create a tag for a resource.

Authorizations

Parameters

Query Parameters

Request Body

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

Example^generated

Example^generated

Example^generated

Example^generated