idManager.TagsApi

All URIs are relative to /api

Method	HTTP request	Description
clearTagsByCode	DELETE /v1/tags/code/{code}	Clear tags by identification code
createTag	POST /v1/tags	Create a tag
deleteTag	DELETE /v1/tags/{id}	Delete a tag
getTag	GET /v1/tags/{id}	Gets a tag
listTags	GET /v1/tags	List tags
updateTag	PUT /v1/tags/{id}	Update a tag

clearTagsByCode

Object clearTagsByCode(code)

Clear tags by identification code

Clear all tags from an identification with the provided code.

Example

import idManager from '@intuate/idmanager';

let apiInstance = new idManager.TagsApi();
let code = "code_example"; // String | tag code to delete
apiInstance.clearTagsByCode(code).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
code	String	tag code to delete

Return type

Object

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

createTag

CreateTagResponse createTag(data)

Create a tag

Create a tag for an identification, will be added at the end of the list.

Example

import idManager from '@intuate/idmanager';

let apiInstance = new idManager.TagsApi();
let data = new idManager.ModelTag(); // ModelTag | tag to create
apiInstance.createTag(data).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
data	ModelTag	tag to create

Return type

CreateTagResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

deleteTag

Object deleteTag(id)

Delete a tag

Delete a tag from an identification with the provided id. Indexes will be reorganized.

Example

import idManager from '@intuate/idmanager';

let apiInstance = new idManager.TagsApi();
let id = 789; // Number | tag id to delete
apiInstance.deleteTag(id).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	Number	tag id to delete

Return type

Object

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getTag

GetTagResponse getTag(id)

Gets a tag

Gets a tag from an identification with the provided id.

Example

import idManager from '@intuate/idmanager';

let apiInstance = new idManager.TagsApi();
let id = 789; // Number | tag id to get
apiInstance.getTag(id).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	Number	tag id to get

Return type

GetTagResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

listTags

ListTagsResponse listTags(opts)

List tags

List tags from an identification.

Example

import idManager from '@intuate/idmanager';

let apiInstance = new idManager.TagsApi();
let opts = {
  'page': 789, // Number | page of the list
  'start': 789, // Number | start offset of the list
  'limit': 50, // Number | limit number of record per fetch
  'sort': "sort_example", // String | sort is for sorting records. JSON encoded, ex: [{\"property\":\"name\",\"direction\":\"ASC\"}]
  'filter': "filter_example" // String | filter is for filtering records. JSON encoded, ex: [{\"property\":\"#search\",\"value\":\"test value\",\"type\":\"string\",\"operator\":\"like\"}]
};
apiInstance.listTags(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
page	Number	page of the list	[optional]
start	Number	start offset of the list	[optional]
limit	Number	limit number of record per fetch	[optional] [default to 50]
sort	String	sort is for sorting records. JSON encoded, ex: [{\"property\":\"name\",\"direction\":\"ASC\"}]	[optional]
filter	String	filter is for filtering records. JSON encoded, ex: [{\"property\":\"#search\",\"value\":\"test value\",\"type\":\"string\",\"operator\":\"like\"}]	[optional]

Return type

ListTagsResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

updateTag

UpdateTagResponse updateTag(id, data)

Update a tag

Update a tag from an identification with the provided id.

Example

import idManager from '@intuate/idmanager';

let apiInstance = new idManager.TagsApi();
let id = 789; // Number | tag id to update
let data = new idManager.ModelTag(); // ModelTag | tag to update
apiInstance.updateTag(id, data).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	Number	tag id to update
data	ModelTag	tag to update

Return type

UpdateTagResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json