Nomadesk API

Storage: Workflows: GetWorkflow

GetWorkflow

Gets the workflows for a file/directory

Input Parameter Type Description
Token* String Security token
FileserverName* String Vault name(nmsa)
Output Parameter Type Description
Success Boolean True or false

*=required

CURL EXAMPLE

Get all workflows for a path

curl -v 'https://example.com/storage/api.php?Token=52f7f033-0b7d-e682-7305-7039f8b93a33&Task=GetWorkflow&FileserverName=nmsa980676080100&FilterBy[]=Path&FilterValue[]=/workflow'

Response

<Response>
    <Status>1</Status>
    <Message>Success</Message>
    <Workflows>
        <Workflow>
            <ID>e1b13d0f-7d13-6e3c-7464-f732e648fbf6</ID>
            <AccountName>nmua531025527305</AccountName>
            <Path>workflow</Path>
            <Type>immediateemail</Type>
            <URI></URI>
            <Headers></Headers>
            <EventTypes></EventTypes>
            <SuccessFileserverName></SuccessFileserverName>
            <SuccessType></SuccessType>
            <SuccessPath></SuccessPath>
            <FailFileserverName></FailFileserverName>
            <FailType></FailType>
            <FailPath></FailPath>
            <Recursive>false</Recursive>
            <IncludeFile>false</IncludeFile>
        </Workflow>
        <Workflow>
            <ID>6ebb9acc-9f41-fa02-9f6a-909dbb831d48</ID>
            <AccountName>nmua590018166689</AccountName>
            <Path>workflow</Path>
            <Type>dailyemail</Type>
            <URI></URI>
            <Headers></Headers>
            <EventTypes></EventTypes>
            <SuccessFileserverName></SuccessFileserverName>
            <SuccessType></SuccessType>
            <SuccessPath></SuccessPath>
            <FailFileserverName></FailFileserverName>
            <FailType></FailType>
            <FailPath></FailPath>
            <Recursive>false</Recursive>
            <IncludeFile>false</IncludeFile>
        </Workflow>
        <Workflow>
            <ID>5ade8161-5c43-dcae-c235-4a43013a4013</ID>
            <AccountName>nmua531025527305</AccountName>
            <Path>workflow</Path>
            <Type>HTTPCallback</Type>
            <URI>https://example.com/workflow.php</URI>
            <Headers>
                <Header>
                    <Key>header01</Key>
                    <Value>myValue01</Value>
                </Header>
                <Header>
                    <Key>header02</Key>
                    <Value>myValue02</Value>
                </Header>
            </Headers>
            <EventTypes>
                <EventType>New</EventType>
                <EventType>Deleted</EventType>
                <EventType>Moved</EventType>
                <EventType>DataUpdated</EventType>
                <EventType>Renamed</EventType>
                <EventType>Download</EventType>
            </EventTypes>
            <SuccessFileserverName></SuccessFileserverName>
            <SuccessType></SuccessType>
            <SuccessPath></SuccessPath>
            <FailFileserverName></FailFileserverName>
            <FailType></FailType>
            <FailPath></FailPath>
            <Recursive>true</Recursive>
            <IncludeFile>false</IncludeFile>
        </Workflow>
    </Workflows>
</Response>

Get all workflows for a specific type

curl -v 'https://example.com/storage/api.php?Token=52f7f033-0b7d-e682-7305-7039f8b93a33&Task=GetWorkflow&FileserverName=nmsa980676080100&FilterBy[]=Type&FilterValue[]=immediateemail'

Response

<Response>
    <Status>1</Status>
    <Message>Success</Message>
    <Workflows>
        <Workflow>
            <ID>e1b13d0f-7d13-6e3c-7464-f732e648fbf6</ID>
            <AccountName>nmua531025527305</AccountName>
            <Path>workflow</Path>
            <Type>immediateemail</Type>
            <URI></URI>
            <Headers></Headers>
            <EventTypes></EventTypes>
            <SuccessFileserverName></SuccessFileserverName>
            <SuccessType></SuccessType>
            <SuccessPath></SuccessPath>
            <FailFileserverName></FailFileserverName>
            <FailType></FailType>
            <FailPath></FailPath>
            <Recursive>false</Recursive>
            <IncludeFile>false</IncludeFile>
        </Workflow>
    </Workflows>
</Response>