PUT api/ApprovalFlowTemplate/{approvalFlowTemplateId}
Updates a existing ApprovalFlowTemplate
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| approvalFlowTemplateId | integer |
Required |
Body Parameters
ApprovalFlowTemplateUpdateDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| ApprovalFlowEntityId | BusinessEntityTypeId |
None. |
|
| Title | string |
None. |
|
| Description | string |
None. |
|
| SupervisorRoleId | integer |
None. |
|
| NotificationInRoleIds | Collection of integer |
None. |
|
| NotificationOutRoleIds | Collection of integer |
None. |
|
| Steps | Collection of ApprovalStepTemplateUpdateDto |
None. |
|
| ProjectId | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"id": 1,
"approvalFlowEntityId": 1,
"title": "sample string 2",
"description": "sample string 3",
"supervisorRoleId": 4,
"notificationInRoleIds": [
1,
2
],
"notificationOutRoleIds": [
1,
2
],
"steps": [
{
"id": 1,
"isDeleted": true,
"stepNumber": 3,
"execRoleId": 4,
"approvalFlowStepTypeId": 5,
"doNotNotifyExecutor": true,
"notificationInRoleIds": [
1,
2
],
"notificationOutRoleIds": [
1,
2
],
"notificationCcRoleIds": [
1,
2
]
},
{
"id": 1,
"isDeleted": true,
"stepNumber": 3,
"execRoleId": 4,
"approvalFlowStepTypeId": 5,
"doNotNotifyExecutor": true,
"notificationInRoleIds": [
1,
2
],
"notificationOutRoleIds": [
1,
2
],
"notificationCcRoleIds": [
1,
2
]
}
],
"projectId": 1
}
text/html
Sample:
{"id":1,"approvalFlowEntityId":1,"title":"sample string 2","description":"sample string 3","supervisorRoleId":4,"notificationInRoleIds":[1,2],"notificationOutRoleIds":[1,2],"steps":[{"id":1,"isDeleted":true,"stepNumber":3,"execRoleId":4,"approvalFlowStepTypeId":5,"doNotNotifyExecutor":true,"notificationInRoleIds":[1,2],"notificationOutRoleIds":[1,2],"notificationCcRoleIds":[1,2]},{"id":1,"isDeleted":true,"stepNumber":3,"execRoleId":4,"approvalFlowStepTypeId":5,"doNotNotifyExecutor":true,"notificationInRoleIds":[1,2],"notificationOutRoleIds":[1,2],"notificationCcRoleIds":[1,2]}],"projectId":1}
application/xml, text/xml
Sample:
<ApprovalFlowTemplateUpdateDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.ApprovalFlowModule.Application.Dtos.Dtos.ApprovalFlowTemplateAgg">
<ApprovalFlowEntityId>Subcontract</ApprovalFlowEntityId>
<Description>sample string 3</Description>
<Id>1</Id>
<NotificationInRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:long>1</d2p1:long>
<d2p1:long>2</d2p1:long>
</NotificationInRoleIds>
<NotificationOutRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:long>1</d2p1:long>
<d2p1:long>2</d2p1:long>
</NotificationOutRoleIds>
<ProjectId>1</ProjectId>
<Steps>
<ApprovalStepTemplateUpdateDto>
<ApprovalFlowStepTypeId>5</ApprovalFlowStepTypeId>
<DoNotNotifyExecutor>true</DoNotNotifyExecutor>
<ExecRoleId>4</ExecRoleId>
<Id>1</Id>
<IsDeleted>true</IsDeleted>
<NotificationCcRoleIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:long>1</d4p1:long>
<d4p1:long>2</d4p1:long>
</NotificationCcRoleIds>
<NotificationInRoleIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:long>1</d4p1:long>
<d4p1:long>2</d4p1:long>
</NotificationInRoleIds>
<NotificationOutRoleIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:long>1</d4p1:long>
<d4p1:long>2</d4p1:long>
</NotificationOutRoleIds>
<StepNumber>3</StepNumber>
</ApprovalStepTemplateUpdateDto>
<ApprovalStepTemplateUpdateDto>
<ApprovalFlowStepTypeId>5</ApprovalFlowStepTypeId>
<DoNotNotifyExecutor>true</DoNotNotifyExecutor>
<ExecRoleId>4</ExecRoleId>
<Id>1</Id>
<IsDeleted>true</IsDeleted>
<NotificationCcRoleIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:long>1</d4p1:long>
<d4p1:long>2</d4p1:long>
</NotificationCcRoleIds>
<NotificationInRoleIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:long>1</d4p1:long>
<d4p1:long>2</d4p1:long>
</NotificationInRoleIds>
<NotificationOutRoleIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:long>1</d4p1:long>
<d4p1:long>2</d4p1:long>
</NotificationOutRoleIds>
<StepNumber>3</StepNumber>
</ApprovalStepTemplateUpdateDto>
</Steps>
<SupervisorRoleId>4</SupervisorRoleId>
<Title>sample string 2</Title>
</ApprovalFlowTemplateUpdateDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
booleanResponse Formats
application/json, text/json, text/html
Sample:
true
application/xml, text/xml
Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>