TagAPI

string

mode

query

Provide mode accountTag/userTag

No

string

Responses

Response Type Description

Response Type	Description
Success	`Schema`: Result Response contain customParams, It provide list of tag Id's. Sample JSON `Response Sample : { "returnCode": 0, "messageKey": "msg_tag_success_addTag", "detailedMessage": "Tag(s) added successfully.", "exception": null, "browser": "Mozilla 5.0 (Windows)", "sessionId": "CADE3D2F44DC48016F", "customParams": { "tagIds": [ 10052, 10053 ] }, "errorMessages": null, "success": true }`
Failure	Unexpected error `Schema`: Result

Success

Schema: Result

Response contain customParams, It provide list of tag Id's.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_tag_success_addTag",
  "detailedMessage": "Tag(s) added successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "CADE3D2F44DC48016F",
  "customParams": {
    "tagIds": [
      10052,
      10053
    ]
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema: Result

/tag.do?cmd=ListActiveTag

GET /tag.do?cmd=ListActiveTag

Tag

Summary

Get active tag list.

Description

Get Tag list -

Three types of lists :
Shared tags - Provide mode accountTags.
List will return all account level shared tags
User tags - Provide mode userTags.
List will return all user tags.
All tags - Provide mode filterTags.
List will return both shared and user tags.

.

Access

Contact +

Parameters

Name

Located in

Description

Required

Schema

mode

query

accountTags = Get account level shared tags
userTags = Get user tags
filterTags = Get both login user and account tags.

No

string

Responses

Response Type Description

Response Type	Description
Success	Retrieval successful `Schema`: List of tags Tag
Failure	Unexpected error `Schema`: Result

Success

Retrieval successful

Schema: List of tags Tag

Failure

Unexpected error

Schema: Result

/tag.do?cmd=ListObjectTag

GET /tag.do?cmd=ListObjectTag

Tag

Summary

List Object Tag

Description

Get list of tags associated with object.

Access

For Mode accountTags - Account Admin +, Project manager with Create tag permissions
For User Tag - Contact + with Self access

Parameters

Name

Located in

Description

Required

Schema

objectType

query

Provide the object type,

Request = 2
Project = 3
Folder = 4
Client = 5
Campaign = 6
User = 7
Task = 9
Review = 10
File = 12
Todo = 13

Yes

integer

mode

query

Provide mode accountTag/userTag

No

string

objectIds

query

Provide comma separated object Ids

Yes

string

Responses

Response Type Description

Response Type	Description
Success	Retrieval successful `Schema`: List of tags { Tag }
Failure	Unexpected error `Schema`: Result

Success

Retrieval successful

Schema: List of tags

{ Tag }

Failure

Unexpected error

Schema: Result

/tag.do?cmd=ListAvailableObjectTag

GET /tag.do?cmd=ListAvailableObjectTag

Tag

Summary

List available Object Tag

Description

Get list of tags available to add to object .

Access

For Mode accountTags - Account Admin +, Project manager with Create tag permissions
For User Tag - Contact + with Self access

Parameters

Name

Located in

Description

Required

Schema

objectType

query

Provide the object type,

Request = 2
Project = 3
Folder = 4
Client = 5
Campaign = 6
User = 7
Task = 9
Review = 10
File = 12
Todo = 13

Yes

integer

mode

query

Provide mode accountTag/userTag

No

string

objectIds

query

Provide comma separated object Ids

Yes

string

Responses

Response Type Description

Response Type	Description
Success	Retrieval successful `Schema`: List of tags { Tag }
Failure	Unexpected error `Schema`: Result

Success

Retrieval successful

Schema: List of tags

{ Tag }

Failure

Unexpected error

Schema: Result

/tag.do?cmd=ListActiveObjectTag

GET /tag.do?cmd=ListActiveObjectTag

Tag

Summary

Get objects active tags.

Description

Get objects active tags.

Access

Contact +

Parameters

Name

Located in

Description

Required

Schema

objectType

query

Provide the object type,

Request = 2
Project = 3
Folder = 4
Client = 5
Campaign = 6
User = 7
Task = 9
Review = 10
File = 12
Todo = 13

Yes

integer

mode

query

Provide mode accountTag/userTag

No

string

objectIds

query

Provide comma separated object Ids

Yes

string

Responses

Response Type Description

Response Type	Description
Success	Retrieval successful `Schema`: List of tags { Tag }
Failure	Unexpected error `Schema`: Result

Success

Retrieval successful

Schema: List of tags

{ Tag }

Failure

Unexpected error

Schema: Result

/tag.do?cmd=ListTags

GET /tag.do?cmd=ListTags

Tag

Summary

Get active tag list. If isIncludeArchive true then get archived tags too.

Description

Get active tag list. If isIncludeArchive true then get archived tags too.

Access

Contact +

Parameters

Name

Located in

Description

Required

Schema

mode

query

Provide mode accountTag/userTag

Yes

string

isIncludeArchive

query

provide isIncludeArchive - true/false

Yes

type:"boolean"

boolean

Responses

Response Type Description

Response Type	Description
Success	Retrieval successful `Schema`: List of tags { Tag }
Failure	Unexpected error `Schema`: Result

Success

Retrieval successful

Schema: List of tags

{ Tag }

Failure

Unexpected error

Schema: Result

/tag.do?cmd=UpdateObjectTags

GET /tag.do?cmd=UpdateObjectTags

Tag

Summary

Update Object Tags

Description

Upadate object tags - Add,remove new user/shared tags.

Access

For Mode accountTags - Account Admin +, Project manager with Create tag permissions
For User Tag - Contact + with Self access

Parameters

Name

Located in

Description

Required

Schema

objectType

query

Provide the object type,

Request = 2
Project = 3
Folder = 4
Client = 5
Campaign = 6
User = 7
Task = 9
Review = 10
File = 12
Todo = 13

Yes

integer

objectIds

query

Provide comma separated object Ids

Yes

string

myTagIds

query

Provide Comma separated user tag ids

Yes

string

sharedTagIds

query

Provide Comma sepereted account shared tag ids

Yes

string

newMyTags

query

Provide Comma separated new user tag names

Yes

string

newSharedTags

query

Provide Comma separated new account shared tag names

Yes

string

Responses

Response Type Description

Response Type	Description
Success	Tag(s) added successfully. `Schema`: Result
Failure	Unexpected error `Schema`: Result

Success

Tag(s) added successfully.

Schema: Result

Failure

Unexpected error

Schema: Result

/tag.do?cmd=RemoveObjectTags

GET /tag.do?cmd=RemoveObjectTags

Tag

Summary

Remove Object Tags

Description

Remove Object Tags

Access

Contact +

Parameters

Name

Located in

Description

Required

Schema

objectType

query

Provide the object type,

Request = 2
Project = 3
Folder = 4
Client = 5
Campaign = 6
User = 7
Task = 9
Review = 10
File = 12
Todo = 13

Yes

integer

objectIds

query

Provide comma separated object Ids

Yes

string

tagIds

query

Provide comma separated tag Ids

Yes

string

Responses

Response Type Description

Response Type	Description
Success	Tag(s) deleted successfully. `Schema`: Result
Failure	Unexpected error `Schema`: Result

Success

Tag(s) deleted successfully.

Schema: Result

Failure

Unexpected error

Schema: Result

/tag.do?cmd=UpdateTag

GET /tag.do?cmd=UpdateTag

Tag

Summary

Update Tag

Description

Update tag.

Access

For Mode accountTags - Account Admin +, Project manager with Create tag permissions
For User Tag - Contact + with Self access

Parameters

Name

Located in

Description

Required

Schema

tagId

query

Provide

Yes

integer

mode

query

Provide mode accountTag/userTag

No

string

name

query

Provide changed tag name.

Yes

string

Responses

Response Type Description

Response Type	Description
Success	Tag updated successfully. `Schema`: Result
Failure	Unexpected error `Schema`: Result

Success

Tag updated successfully.

Schema: Result

Failure

Unexpected error

Schema: Result

/tag.do?cmd=ListUserActiveTags

GET /tag.do?cmd=ListUserActiveTags
Tag

Summary

List User Active Tags
Description
Get active tag list for user

Access
- Contact + (Self)
- Account Admin
Parameters

th>Schema

Name Located in Description Required

userId query
Provide user Id
Yes

Object
type:"integer"

integer

Responses

Response Type Description

Success
Retrieval successful

Schema: List of tags

{ Tag }

Failure
Unexpected error

Schema: Result

Response Type	Description
Success	Retrieval successful `Schema`: List of tags { Tag }
Failure	Unexpected error `Schema`: Result

/tag.do?cmd=AddTagsWithObject

GET /tag.do?cmd=AddTagsWithObject

Tag

Summary

Add Tags With Object

Description

Add tags with particular object.

Access

Contact + (Self)
Account Admin

Parameters

Name

Located in

Description

Required

Schema

tagNames

query

Provide tag name.

Yes

string

objectType

query

Provide the object type,

Request = 2
Project = 3
Folder = 4
Client = 5
Campaign = 6
User = 7
Task = 9
Review = 10
File = 12
Todo = 13

Yes

integer

objectIds

query

Provide comma separated object Ids

Yes

string

Responses

Response Type Description

Success

Tag(s) applied successfully.

Schema: Result

Failure

Unexpected error

Schema: Result

/tag.do?cmd=ArchiveTag

GET /tag.do?cmd=ArchiveTag
Tag

Summary

Archive Tags
Description
Archive Tags personal/Shared

Access
- For Mode accountTags - Account Admin +, Project manager with Create tag permissions
- For User Tag - Contact + with Self access
Parameters

Name Located in Description Required Schema

tagIds query
Provide comma separated tag Ids to add
Yes

Object
type:"string"

string

Responses

Response Type Description

Success
Tag(s) archived successfully.

Schema: Result

Failure
Unexpected error

Schema: Result

/tag.do?cmd=MergeTags

GET /tag.do?cmd=MergeTags

Tag

Summary

Merge Tags

Description

Merge Shared Tags

Access

Account Admin+

Parameters

Name

Located in

Description

Required

Schema

tagIds

query

Provide comma separated tag Ids to add

Yes

string

tagName

query

Provide tag name

Yes