Plugins - Tag Management

Replace all tags for a plugin

PUT

http://localhost:3000/api/plugins/{pluginId}/tags

Remove all existing tags from a plugin and associate it with a new set of tags.

curl -X PUT 'http://localhost:3000/api/plugins/550e8400-e29b-41d4-a716-446655440000/tags' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "tagIds": [
    "tag123-456-789",
    "tag987-654-321"
  ]
}'

const body = `{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "tagIds": [
    "tag123-456-789",
    "tag987-654-321"
  ]
}`;

const response = await fetch('http://localhost:3000/api/plugins/550e8400-e29b-41d4-a716-446655440000/tags', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "tagIds": [
    "tag123-456-789",
    "tag987-654-321"
  ]
}'''

response = requests.put(
    'http://localhost:3000/api/plugins/550e8400-e29b-41d4-a716-446655440000/tags',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "tagIds": [
    "tag123-456-789",
    "tag987-654-321"
  ]
}

200

[
  {
    "deletedAt": "2018-11-21T06:20:32.232Z",
    "createdAt": "2018-11-21T06:20:32.232Z",
    "updatedAt": "2018-11-21T06:20:32.232Z",
    "id": "string",
    "isActive": true,
    "isArchived": false,
    "archivedAt": "2018-11-21T06:20:32.232Z",
    "tenantId": "string",
    "organizationId": "string",
    "plugin": {
      "deletedAt": "2018-11-21T06:20:32.232Z",
      "createdAt": "2018-11-21T06:20:32.232Z",
      "updatedAt": "2018-11-21T06:20:32.232Z",
      "id": "string",
      "isActive": false,
      "isArchived": false,
      "archivedAt": "2018-11-21T06:20:32.232Z",
      "name": "string",
      "description": "string",
      "type": "DESKTOP",
      "status": "ACTIVE",
      "categoryId": "string",
      "category": {},
      "versions": [
        "string"
      ],
      "author": "string",
      "license": "string",
      "homepage": "string",
      "repository": "string",
      "uploadedBy": {
        "deletedAt": "2018-11-21T06:20:32.232Z",
        "createdAt": "2018-11-21T06:20:32.232Z",
        "updatedAt": "2018-11-21T06:20:32.232Z",
        "id": "string",
        "isActive": true,
        "isArchived": false,
        "archivedAt": "2018-11-21T06:20:32.232Z",
        "tenantId": "string",
        "thirdPartyId": "string",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phoneNumber": "string",
        "username": "string",
        "timeZone": "string",
        "timeFormat": 12,
        "hash": "string",
        "refreshToken": "string",
        "imageUrl": "string",
        "preferredLanguage": "en",
        "preferredComponentLayout": "CARDS_GRID",
        "uiPreferences": {},
        "code": "string",
        "codeExpireAt": "2024-01-15T09:30:00Z",
        "emailVerifiedAt": "2024-01-15T09:30:00Z",
        "lastLoginAt": "2024-01-15T09:30:00Z",
        "emailToken": "string",
        "roleId": "string",
        "imageId": "string",
        "defaultTeamId": "string",
        "lastTeamId": "string",
        "defaultOrganizationId": "string",
        "lastOrganizationId": "string"
      },
      "uploadedAt": "2024-01-15T09:30:00Z",
      "requiresSubscription": false,
      "isFeatured": false,
      "isVerified": false,
      "lastDownloadedAt": "2024-01-15T09:30:00Z",
      "pluginTenants": [
        "string"
      ],
      "settings": [
        "string"
      ],
      "subscriptions": [
        "string"
      ],
      "subscriptionPlans": [
        "string"
      ],
      "pluginTags": [
        "string"
      ]
    },
    "pluginId": "550e8400-e29b-41d4-a716-446655440000",
    "tag": {
      "deletedAt": "2018-11-21T06:20:32.232Z",
      "createdAt": "2018-11-21T06:20:32.232Z",
      "updatedAt": "2018-11-21T06:20:32.232Z",
      "id": "string",
      "isActive": true,
      "isArchived": false,
      "archivedAt": "2018-11-21T06:20:32.232Z",
      "tenantId": "string",
      "organizationId": "string",
      "name": "string",
      "color": "string",
      "textColor": "string",
      "description": "string",
      "icon": "string",
      "isSystem": false,
      "tagTypeId": "string",
      "organizationTeamId": "string"
    },
    "tagId": "550e8400-e29b-41d4-a716-446655440000",
    "appliedAt": "2024-01-15T09:30:00Z",
    "appliedById": "550e8400-e29b-41d4-a716-446655440000",
    "priority": 50,
    "isFeatured": false
  }
]

Body

application/json

tenantobject

tenantIdstring

organizationobject

organizationIdstring

sentTostring

tagIdsArray<string>required

New array of tag IDs to associate with the plugin (replaces all existing tags)

Example

[
  "tag123-456-789",
  "tag987-654-321"
]

Parameters

pluginIdstring<uuid>requiredpath

Plugin ID

Response

200OKArray<PluginTag>

Successfully replaced plugin tags

Response fields application/json

Array<PluginTag>

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

pluginPlugin_1required

The plugin associated with this tag relationship

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleanfalse

Plugin is active or not

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

namestringrequired

Plugin name

descriptionstring

Plugin description

typestringDESKTOPWEBMOBILErequired

Type of the plugin

statusstringACTIVEINACTIVEDEPRECATEDARCHIVEDrequired

Status of the plugin

categoryIdstring

Plugin category ID

categoryobject

Plugin category

versionsArray<string>required

Versions of the plugin

authorstring

Plugin author

licensestring

Plugin license

homepagestring

Homepage URL

repositorystring

Repository URL

uploadedByUser

User who uploaded the plugin

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

thirdPartyIdstring

firstNamestring

lastNamestring

emailstring

phoneNumberstring

usernamestring

timeZonestring

timeFormatstring1224

hashstring

refreshTokenstring

imageUrlstring

preferredLanguagestringenbgherufreszhdeptitnlplar

preferredComponentLayoutstringCARDS_GRIDTABLE

uiPreferencesobject

codestring

codeExpireAtstring<date-time>

emailVerifiedAtstring<date-time>

lastLoginAtstring<date-time>

emailTokenstring

roleIdstring

imageIdstring

defaultTeamIdstring

lastTeamIdstring

defaultOrganizationIdstring

lastOrganizationIdstring

uploadedAtstring<date-time>

Upload date

requiresSubscriptionbooleanfalserequired

Is subscription plan enabled

isFeaturedbooleanfalserequired

Whether the plugin is featured

isVerifiedbooleanfalserequired

Whether the plugin is verified by Gauzy

lastDownloadedAtstring<date-time>

Last downloaded date

pluginTenantsArray<string>

Plugin tenants for this plugin

settingsArray<string>

Plugin settings

subscriptionsArray<string>

Plugin subscriptions

subscriptionPlansArray<string>

Plugin subscription plans

pluginTagsArray<string>

Plugin tag relationships

pluginIdstring<uuid>required

ID reference to the plugin

tagTagrequired

The tag associated with this plugin relationship

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

colorstringrequired

textColorstring

descriptionstring

iconstring

isSystembooleanfalse

tagTypeIdstring

organizationTeamIdstring

tagIdstring<uuid>required

ID reference to the tag

appliedAtstring<date-time>

Date when the tag was applied to the plugin

appliedByIdstring<uuid>

ID of the user who applied the tag

prioritynumber[0, 100]50

Priority or weight of this tag association (higher values = higher priority)

isFeaturedbooleanfalse

Whether this tag association is featured

Stack Overflow Website Demo