Controller: General: GetWorkflow
AddFeedback
Gets the workflows on a vault
Authentication Methods
- With a username and password
Input Parameter | Type | Description |
---|---|---|
Token* | String | Security Token |
FileserverName* | String |
Output Parameter | Type | Description |
---|---|---|
Success | Boolean | True if success, false if failed |
*=required
CURL EXAMPLES
Get all workflows for a specific vault
curl -v 'https://example.com/ctrller/api.php?Task=GetWorkflow&Token=3e94e7f6-1cb8-e6c7-c4be-165f12d5ecf2&FileserverName=nmsa550069559329'
Response:
<Response>
<Status>1</Status>
<Message>Success</Message>
<TotalCount>1</TotalCount>
<Workflows>
<Workflow>
<ID>1c277578-3ad3-e9f4-e2bb-6f685c90f428</ID>
<Account>
<Name>nmua530653262290</Name>
<FirstName>firstname</FirstName>
<LastName>lastname</LastName>
<Email>user@example.com</Email>
</Account>
<Path>folder1/folder1.txt</Path>
<Type>immediateemail</Type>
<URI></URI>
<EventTypes>
</EventTypes>
<SuccessFileserverName></SuccessFileserverName>
<SuccessType></SuccessType>
<SuccessPath></SuccessPath>
<FailFileserverName></FailFileserverName>
<FailType></FailType>
<FailPath></FailPath>
<Recursive>true</Recursive>
<IncludeFile>false</IncludeFile>
</Workflow>
</Workflows>
</Response>
Get workflows filtered on a specific path
curl -v 'https://example.com/ctrller/api.php?Task=GetWorkflow&Token=3e94e7f6-1cb8-e6c7-c4be-165f12d5ecf2&FileserverName=nmsa550069559329&FilterBy[]=Path&FilterValue[]=%folder1%'
Response:
<Response>
<Status>1</Status>
<Message>Success</Message>
<TotalCount>1</TotalCount>
<Workflows>
<Workflow>
<ID>1c277578-3ad3-e9f4-e2bb-6f685c90f428</ID>
<Account>
<Name>nmua530653262290</Name>
<FirstName>firstname</FirstName>
<LastName>lastname</LastName>
<Email>user@example.com</Email>
</Account>
<Path>folder1/folder1.txt</Path>
<Type>immediateemail</Type>
<URI></URI>
<EventTypes>
</EventTypes>
<SuccessFileserverName></SuccessFileserverName>
<SuccessType></SuccessType>
<SuccessPath></SuccessPath>
<FailFileserverName></FailFileserverName>
<FailType></FailType>
<FailPath></FailPath>
<Recursive>true</Recursive>
<IncludeFile>false</IncludeFile>
</Workflow>
</Workflows>
</Response>
Get workflows filtered on the user it's first name
curl -v 'https://example.com/ctrller/api.php?Task=GetWorkflow&Token=3e94e7f6-1cb8-e6c7-c4be-165f12d5ecf2&FileserverName=nmsa550069559329&FilterBy[]=Firstname&FilterValue[]=firstname'
Response:
<Response>
<Status>1</Status>
<Message>Success</Message>
<TotalCount>1</TotalCount>
<Workflows>
<Workflow>
<ID>1c277578-3ad3-e9f4-e2bb-6f685c90f428</ID>
<Account>
<Name>nmua530653262290</Name>
<FirstName>firstname</FirstName>
<LastName>lastname</LastName>
<Email>user@example.com</Email>
</Account>
<Path>folder1/folder1.txt</Path>
<Type>immediateemail</Type>
<URI></URI>
<EventTypes>
</EventTypes>
<SuccessFileserverName></SuccessFileserverName>
<SuccessType></SuccessType>
<SuccessPath></SuccessPath>
<FailFileserverName></FailFileserverName>
<FailType></FailType>
<FailPath></FailPath>
<Recursive>true</Recursive>
<IncludeFile>false</IncludeFile>
</Workflow>
</Workflows>
</Response>