Connectors Reference

Cloud Connect Studio

This connector will be used to integrate with Fuji Xerox Cloud Connect Studio solution. This connector will be used as Trigger only and will be triggered once user perform a Scan from Cloud Connect Studio solution

 

Status: Preview

Tier: Premium

Version: v1

 

Actions:

Name

Summary

ApiHooksUnsubscribeByIdDelete (string id)

ApiHooksUnsubscribeByIdDelete

ApiGetSolutionList ()

ApiGetSolutionList

ApiGetSolutionMetaData (string id)

ApiGetSolutionMetaData

 

Triggers:

Name

Summary

ApiHooksSubscribePost (string solutionId, WebHookRequestBody data)

New Scan

 

Objects:

Name

Summary

ApiGetSolutionListResponseItem

 

ApiGetSolutionMetaDataResponse

 

WebHookRequestBody

 

 

Actions:

ApiHooksUnsubscribeByIdDelete

Summary: ApiHooksUnsubscribeByIdDelete

Description:

 

Syntax:

CloudConnectStudio.ApiHooksUnsubscribeByIdDelete (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

 

 

True

 

Returns:

 

ApiGetSolutionList

Summary: ApiGetSolutionList

Description: ApiGetSolutionList

 

Syntax:

CloudConnectStudio.ApiGetSolutionList ()

 

Returns:

          Type:array of (ApiGetSolutionListResponseItem)

 

ApiGetSolutionMetaData

Summary: ApiGetSolutionMetaData

Description: ApiGetSolutionMetaData

 

Syntax:

CloudConnectStudio.ApiGetSolutionMetaData (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

 

 

True

 

Returns:

          Type:ApiGetSolutionMetaDataResponse

 

Triggers:

Trigger ApiHooksSubscribePost

Summary: New Scan

Description: Triggers when a scan is perfomed from Cloud Connect Studio solution

 

Syntax:

CloudConnectStudio.ApiHooksSubscribePost (string solutionId, WebHookRequestBody data)

 

Parameters:

Name

Type

Summary

Required

Related Action

solutionId

string

(Select Solution)

Select solution you want to scan from

True

ApiGetSolutionList

data

WebHookRequestBody

 

 

True

 

Returns:

 


 

ApiGetSolutionListResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

label

string

 

 

key

string

 

 


 

ApiGetSolutionMetaDataResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

WebHookRequestBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

url

string