Connectors Reference

ShareEffect

ShareEffect helps automating business processes and organize information in Office 365. With our Connector you can begin using data from other systems as metadata in SharePoint. Visit flowconnector.ShareEffect.net for more information.

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

AddUpdateTerm (AddUpdateTermParameterBody body)

Add or update term

AddUpdateTermByKeyValue (AddUpdateTermByKeyValueParameterBody body)

Add or update term by key value

GetTermGroups ()

Get Termgroups

GetTermSets (string termgroupname)

GetTermSets

GetTermByKeyValue ([internal]string searchProperty, string searchValue)

Get terms by key value

GetTermByLabel (string searchValue)

Get terms by label

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

AddUpdateTermByKeyValueParameterBody

 

AddUpdateTermParameterBody

 

GetTermByKeyValueResponseItem

 

GetTermByLabelResponseItem

 

 

Actions:

AddUpdateTerm

Summary: Add or update term

Description: Add or update a term in a termset

 

Syntax:

ShareEffect.AddUpdateTerm (AddUpdateTermParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

AddUpdateTermParameterBody

 

 

True

 

Returns:

 

AddUpdateTermByKeyValue

Summary: Add or update term by key value

Description: Add or update a term in a termset using a keyvalue. For example: A static ID field from a CRM system.

 

Syntax:

ShareEffect.AddUpdateTermByKeyValue (AddUpdateTermByKeyValueParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

AddUpdateTermByKeyValueParameterBody

 

 

True

 

Returns:

 

GetTermGroups

Summary: Get Termgroups

Description: Get all termgroups

 

Syntax:

ShareEffect.GetTermGroups ()

 

Returns:

          Type:array of (string)

 

GetTermSets

Summary: GetTermSets

Description: Get all termsets for specific termgroup

 

Syntax:

ShareEffect.GetTermSets (string termgroupname)

 

Parameters:

Name

Type

Summary

Required

Related Action

termgroupname

string

 

 

True

 

Returns:

          Type:array of (string)

 

GetTermByKeyValue

Summary: Get terms by key value

Description: Get terms by key value

 

Syntax:

ShareEffect.GetTermByKeyValue ([internal]string searchProperty, string searchValue)

 

Parameters:

Name

Type

Summary

Required

Related Action

searchProperty

string

 

 

True

searchValue

string

(Key value)

The key value to search for

True

 

Returns:

          Type:array of (GetTermByKeyValueResponseItem)

 

GetTermByLabel

Summary: Get terms by label

Description: Get terms by label name

 

Syntax:

ShareEffect.GetTermByLabel (string searchValue)

 

Parameters:

Name

Type

Summary

Required

Related Action

searchValue

string

(Name)

Retrieve all terms by name

True

 

Returns:

          Type:array of (GetTermByLabelResponseItem)

 


 

AddUpdateTermByKeyValueParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

isavailable

boolean

 

Select to make this term available for tagging

keyvalue

string

 

The keyvalue for this term

otherlabels

string

 

Enter any synonyms for this term. Use a ';' to seperate items.

termlabel

string

 

The name for the label

termsgroup

string

 

Select a group

termsset

string

 

Select a termset


 

AddUpdateTermParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

isavailable

boolean

 

Select to make this term available for tagging

otherlabels

string

 

Enter any synonyms for this term. Use a ';' to seperate items.

termlabel

string

 

The name for the label

termsgroup

string

 

Select a group

termsset

string

 

Select a termset


 

GetTermByKeyValueResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

KeyValue

string

 

KeyValue

Term

string

 

Term

TermSet

string

 

TermSet


 

GetTermByLabelResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

KeyValue

string

 

KeyValue

Term

string

 

Term

TermSet

string

 

TermSet