POST Workflows/Workflow?validateOnly={validateOnly}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
validateOnly | boolean |
Default value is False |
Body Parameters
WorkflowDTOName | Description | Type | Additional information |
---|---|---|---|
WorkflowID | integer |
None. |
|
WorkflowName | string |
None. |
|
BusinessUnits | Collection of integer |
None. |
|
Groups | Collection of integer |
None. |
|
WorkflowRules | Collection of WorkflowRuleDTO |
None. |
|
WorkflowEventType | WorkflowEventType |
None. |
|
WorkflowEventRuleType | WorkflowEventRuleType |
None. |
|
RecordState | RecordState |
None. |
|
Created | AuditDataDTO |
None. |
|
LastUpdated | AuditDataDTO |
None. |
Request Formats
application/json, text/json
Sample:
{ "workflowID": 1, "workflowName": "sample string 2", "businessUnits": [ 1, 2 ], "groups": [ 1, 2 ], "workflowRules": [ { "workflowRuleID": 1, "workflowID": 2, "workflowRuleTriggers": [ { "workflowRuleTriggerID": 1, "workflowRuleID": 2, "parentRuleTriggerID": 1, "fieldType": 1, "expressionType": 1, "workflowRuleActions": [ { "workflowRuleActionID": 1, "workflowRuleTriggerID": 2, "actionType": 1, "fieldType": 1, "value": [], "summary": "sample string 3", "recordState": 1, "created": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" } }, { "workflowRuleActionID": 1, "workflowRuleTriggerID": 2, "actionType": 1, "fieldType": 1, "value": [], "summary": "sample string 3", "recordState": 1, "created": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" } } ], "summary": "sample string 3", "recordState": 1, "created": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" } }, { "workflowRuleTriggerID": 1, "workflowRuleID": 2, "parentRuleTriggerID": 1, "fieldType": 1, "expressionType": 1, "workflowRuleActions": [ { "workflowRuleActionID": 1, "workflowRuleTriggerID": 2, "actionType": 1, "fieldType": 1, "value": [], "summary": "sample string 3", "recordState": 1, "created": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" } }, { "workflowRuleActionID": 1, "workflowRuleTriggerID": 2, "actionType": 1, "fieldType": 1, "value": [], "summary": "sample string 3", "recordState": 1, "created": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" } } ], "summary": "sample string 3", "recordState": 1, "created": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" } } ], "recordState": 1, "created": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" } }, { "workflowRuleID": 1, "workflowID": 2, "workflowRuleTriggers": [ { "workflowRuleTriggerID": 1, "workflowRuleID": 2, "parentRuleTriggerID": 1, "fieldType": 1, "expressionType": 1, "workflowRuleActions": [ { "workflowRuleActionID": 1, "workflowRuleTriggerID": 2, "actionType": 1, "fieldType": 1, "value": [], "summary": "sample string 3", "recordState": 1, "created": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" } }, { "workflowRuleActionID": 1, "workflowRuleTriggerID": 2, "actionType": 1, "fieldType": 1, "value": [], "summary": "sample string 3", "recordState": 1, "created": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" } } ], "summary": "sample string 3", "recordState": 1, "created": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" } }, { "workflowRuleTriggerID": 1, "workflowRuleID": 2, "parentRuleTriggerID": 1, "fieldType": 1, "expressionType": 1, "workflowRuleActions": [ { "workflowRuleActionID": 1, "workflowRuleTriggerID": 2, "actionType": 1, "fieldType": 1, "value": [], "summary": "sample string 3", "recordState": 1, "created": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" } }, { "workflowRuleActionID": 1, "workflowRuleTriggerID": 2, "actionType": 1, "fieldType": 1, "value": [], "summary": "sample string 3", "recordState": 1, "created": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" } } ], "summary": "sample string 3", "recordState": 1, "created": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" } } ], "recordState": 1, "created": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" } } ], "workflowEventType": 1, "workflowEventRuleType": 100, "recordState": 1, "created": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T08:11:41.3714805+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:11:41 AM" } }
application/xml, text/xml
Sample:
<WorkflowDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models"> <BusinessUnits xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </BusinessUnits> <Created> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <Groups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </Groups> <LastUpdated> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <RecordState>Active</RecordState> <WorkflowEventRuleType>ResidentAdd</WorkflowEventRuleType> <WorkflowEventType>Resident</WorkflowEventType> <WorkflowID>1</WorkflowID> <WorkflowName>sample string 2</WorkflowName> <WorkflowRules> <WorkflowRuleDTO> <Created> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <LastUpdated> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <RecordState>Active</RecordState> <WorkflowID>2</WorkflowID> <WorkflowRuleID>1</WorkflowRuleID> <WorkflowRuleTriggers> <WorkflowRuleTriggerDTO> <Created> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <ExpressionType>Answered</ExpressionType> <ExpressionValue xmlns:d6p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" /> <FieldType>BusinessUnit</FieldType> <LastUpdated> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <ParentRuleTriggerID>1</ParentRuleTriggerID> <RecordState>Active</RecordState> <Summary>sample string 3</Summary> <WorkflowRuleActions> <WorkflowRuleActionDTO> <ActionType>SetValue</ActionType> <Created> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <FieldType>BusinessUnit</FieldType> <LastUpdated> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <RecordState>Active</RecordState> <Summary>sample string 3</Summary> <Value xmlns:d8p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" /> <WorkflowRuleActionID>1</WorkflowRuleActionID> <WorkflowRuleTriggerID>2</WorkflowRuleTriggerID> </WorkflowRuleActionDTO> <WorkflowRuleActionDTO> <ActionType>SetValue</ActionType> <Created> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <FieldType>BusinessUnit</FieldType> <LastUpdated> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <RecordState>Active</RecordState> <Summary>sample string 3</Summary> <Value xmlns:d8p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" /> <WorkflowRuleActionID>1</WorkflowRuleActionID> <WorkflowRuleTriggerID>2</WorkflowRuleTriggerID> </WorkflowRuleActionDTO> </WorkflowRuleActions> <WorkflowRuleID>2</WorkflowRuleID> <WorkflowRuleTriggerID>1</WorkflowRuleTriggerID> </WorkflowRuleTriggerDTO> <WorkflowRuleTriggerDTO> <Created> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <ExpressionType>Answered</ExpressionType> <ExpressionValue xmlns:d6p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" /> <FieldType>BusinessUnit</FieldType> <LastUpdated> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <ParentRuleTriggerID>1</ParentRuleTriggerID> <RecordState>Active</RecordState> <Summary>sample string 3</Summary> <WorkflowRuleActions> <WorkflowRuleActionDTO> <ActionType>SetValue</ActionType> <Created> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <FieldType>BusinessUnit</FieldType> <LastUpdated> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <RecordState>Active</RecordState> <Summary>sample string 3</Summary> <Value xmlns:d8p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" /> <WorkflowRuleActionID>1</WorkflowRuleActionID> <WorkflowRuleTriggerID>2</WorkflowRuleTriggerID> </WorkflowRuleActionDTO> <WorkflowRuleActionDTO> <ActionType>SetValue</ActionType> <Created> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <FieldType>BusinessUnit</FieldType> <LastUpdated> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <RecordState>Active</RecordState> <Summary>sample string 3</Summary> <Value xmlns:d8p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" /> <WorkflowRuleActionID>1</WorkflowRuleActionID> <WorkflowRuleTriggerID>2</WorkflowRuleTriggerID> </WorkflowRuleActionDTO> </WorkflowRuleActions> <WorkflowRuleID>2</WorkflowRuleID> <WorkflowRuleTriggerID>1</WorkflowRuleTriggerID> </WorkflowRuleTriggerDTO> </WorkflowRuleTriggers> </WorkflowRuleDTO> <WorkflowRuleDTO> <Created> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <LastUpdated> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <RecordState>Active</RecordState> <WorkflowID>2</WorkflowID> <WorkflowRuleID>1</WorkflowRuleID> <WorkflowRuleTriggers> <WorkflowRuleTriggerDTO> <Created> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <ExpressionType>Answered</ExpressionType> <ExpressionValue xmlns:d6p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" /> <FieldType>BusinessUnit</FieldType> <LastUpdated> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <ParentRuleTriggerID>1</ParentRuleTriggerID> <RecordState>Active</RecordState> <Summary>sample string 3</Summary> <WorkflowRuleActions> <WorkflowRuleActionDTO> <ActionType>SetValue</ActionType> <Created> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <FieldType>BusinessUnit</FieldType> <LastUpdated> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <RecordState>Active</RecordState> <Summary>sample string 3</Summary> <Value xmlns:d8p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" /> <WorkflowRuleActionID>1</WorkflowRuleActionID> <WorkflowRuleTriggerID>2</WorkflowRuleTriggerID> </WorkflowRuleActionDTO> <WorkflowRuleActionDTO> <ActionType>SetValue</ActionType> <Created> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <FieldType>BusinessUnit</FieldType> <LastUpdated> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <RecordState>Active</RecordState> <Summary>sample string 3</Summary> <Value xmlns:d8p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" /> <WorkflowRuleActionID>1</WorkflowRuleActionID> <WorkflowRuleTriggerID>2</WorkflowRuleTriggerID> </WorkflowRuleActionDTO> </WorkflowRuleActions> <WorkflowRuleID>2</WorkflowRuleID> <WorkflowRuleTriggerID>1</WorkflowRuleTriggerID> </WorkflowRuleTriggerDTO> <WorkflowRuleTriggerDTO> <Created> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <ExpressionType>Answered</ExpressionType> <ExpressionValue xmlns:d6p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" /> <FieldType>BusinessUnit</FieldType> <LastUpdated> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <ParentRuleTriggerID>1</ParentRuleTriggerID> <RecordState>Active</RecordState> <Summary>sample string 3</Summary> <WorkflowRuleActions> <WorkflowRuleActionDTO> <ActionType>SetValue</ActionType> <Created> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <FieldType>BusinessUnit</FieldType> <LastUpdated> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <RecordState>Active</RecordState> <Summary>sample string 3</Summary> <Value xmlns:d8p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" /> <WorkflowRuleActionID>1</WorkflowRuleActionID> <WorkflowRuleTriggerID>2</WorkflowRuleTriggerID> </WorkflowRuleActionDTO> <WorkflowRuleActionDTO> <ActionType>SetValue</ActionType> <Created> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <FieldType>BusinessUnit</FieldType> <LastUpdated> <DateUtc>2024-12-04T08:11:41.3714805+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <RecordState>Active</RecordState> <Summary>sample string 3</Summary> <Value xmlns:d8p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" /> <WorkflowRuleActionID>1</WorkflowRuleActionID> <WorkflowRuleTriggerID>2</WorkflowRuleTriggerID> </WorkflowRuleActionDTO> </WorkflowRuleActions> <WorkflowRuleID>2</WorkflowRuleID> <WorkflowRuleTriggerID>1</WorkflowRuleTriggerID> </WorkflowRuleTriggerDTO> </WorkflowRuleTriggers> </WorkflowRuleDTO> </WorkflowRules> </WorkflowDTO>
application/x-www-form-urlencoded
Sample:
Sample not available.
application/x-compressed-json
Sample:
� �V�N�0���WRj�AT�U�8@r�8�č"��TQ����/�$mh*!j$��]{g�g���2������b�n�;�Đ�IKi��E��� �B)/��BlNl�h�PfE��P�XTٲ�9hU��[��(��n'v�%�R���t�8p�#�K� Q���}����T�{����^/�^/k����<.�hnXRE�p���<14K�g2x�\7e�f V��<�2��3"t�O!�!�K�L���cT(!��yl��R�б3�ZX[lkv�66���^c;$�D��u��S+2� O"���x�~f��?�+��H<��~4�B����'�j��_/͍���:[C3�1��mv? �Y��
Response Information
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |