Powered by Redocly

Tags

Add Tag to company

post/{dataset}/v2/companies/{nationalIn}/tags/{tagUid}

Add tag to a specific company. If pair company-tag already exists it does not modify the data.

SecurityApiKey
Request
path Parameters
nationalIn
required
string or null

Unique Id of the company.

tagUid
required
string <uuid>

Unique ID of the tag.

dataset
required
string
query Parameters
description
string or null

Description for link between the tag and company.

Responses
200

Success

Remove Tag from company

delete/{dataset}/v2/companies/{nationalIn}/tags/{tagUid}

Removes a specific tag from the company.

SecurityApiKey
Request
path Parameters
nationalIn
required
string or null

Unique Id of the company

tagUid
required
string <uuid>

Unique ID of the tag

dataset
required
string
Responses
200

Success

Get Tags from company

get/{dataset}/v2/companies/{nationalIn}/tags

Returns list of tags for a specific company.

SecurityApiKey
Request
path Parameters
nationalIn
required
string or null

Unique Id of the company

dataset
required
string
Responses
200

Success

Response samples
application/json
[
  • {
    }
]

Create Tag share

put/{dataset}/v3/tags/{tagId}/shares/{userEmail}

Creates tag share to given users.

SecurityApiKey
Request
path Parameters
tagId
required
string or null

Tag ID create a share for.

userEmail
required
string or null

User email address.

dataset
required
string
Request Body schema:
required

Share details.

role
required
string (BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v3.Shares.TagShareRoleDto)
Enum: "Viewer" "Contributor" "Manager" "Owner"
expiresAt
string or null <date-time>

Date and time when share expires.

Responses
200

Success

Request samples
{
  • "role": "Viewer",
  • "expiresAt": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "data": [
    ]
}

Remove Tag share

delete/{dataset}/v3/tags/{tagId}/shares/{userEmail}

Removes existing tag share from specific tag, identified by System.Guid, and user identified by email.

SecurityApiKey
Request
path Parameters
tagId
required
string <uuid>

Unique tag identifier.

userEmail
required
string

User email address.

dataset
required
string
Responses
200

Success

Create new Tag

post/{dataset}/v2/tags

Creates new, empty, user Tag with provided details.

SecurityApiKey
Request
path Parameters
dataset
required
string
Request Body schema:

Information about the tag to be added.

label
required
string [ 0 .. 50 ] characters

Name of the tag.

color
string or null

Tag color as hex value. For example: 6095e2

order
integer or null <int32>

Priority order of the tag.

Responses
200

Success

Request samples
{
  • "label": "string",
  • "color": "string",
  • "order": 0
}
Response samples
application/json
{
  • "uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
  • "name": "string",
  • "color": "string",
  • "order": 0,
  • "description": "string",
  • "localizations": [
    ],
  • "type": "User",
  • "share": {
    },
  • "createdAt": "2019-08-24T14:15:22Z"
}

Get user Tags

get/{dataset}/v2/tags

If no user is send via parameters it will take currently logged user. Returns list of all available tags for specific user.

SecurityApiKey
Request
path Parameters
dataset
required
string
query Parameters
User.Uid
string or null <uuid>

Unique identifier.

Roles
Array of strings or null (BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v2.TagShareRoleDto)

Shares roles to request.

Enum: "Viewer" "Contributor" "Manager" "Owner"
Responses
200

Success

Response samples
application/json
[
  • {
    }
]

Delete Tag

delete/{dataset}/v2/tags/{uid}

Delete tag based on tag's unique identifier. To delete a tag, you must be owner of the tag or have sufficient permissions.

SecurityApiKey
Request
path Parameters
uid
required
string <uuid>

Tag's unique identifier.

dataset
required
string
Responses
200

Success

Update Tag Companies

patch/{dataset}/v2/tags/{uid}/companies

Updates Tag's companies using PATCH operation. Allowed operations: add, remove Allowed path: /companyTags More details on how to construct Patch JSON can be found in Guides section.

SecurityApiKey
Request
path Parameters
uid
required
string <uuid>

Tag's unique identifier.

dataset
required
string
Request Body schema:

JsonPatchDocument with update.

Array
object or null
path
string or null
op
string or null
from
string or null
Responses
200

Successfully updated a tag

201

Successfully requested an update, tag is being updated asynchronously

400

Invalid payload

404

Tag does not exist

Request samples
[
  • {
    }
]

Get Tag companies

get/{dataset}/v2/tags/{uid}/companies

Gets a list of companies currently having a specific tag.

SecurityApiKey
Request
path Parameters
uid
required
string <uuid>

Unique identifier of the tag.

dataset
required
string
query Parameters
includeNonExisting
boolean

Should the results contain non-existing companies? (default: false).

Responses
200

Success

Response samples
application/json
[
  • "string"
]
➔ Next to Obsolete