POST api/ApprovalFlowTemplate

Creates a new ApprovalFlowTemplate

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Title	string	None.
Description	string	None.
ApprovalFlowEntityId	BusinessEntityTypeId	None.
SupervisorRoleId	integer	None.
NotificationInRoleIds	Collection of integer	None.
NotificationOutRoleIds	Collection of integer	None.
Steps	Collection of ApprovalStepTemplateCreateDto	None.
ProjectId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "title": "sample string 1",
  "description": "sample string 2",
  "approvalFlowEntityId": 1,
  "supervisorRoleId": 3,
  "notificationInRoleIds": [
    1,
    2
  ],
  "notificationOutRoleIds": [
    1,
    2
  ],
  "steps": [
    {
      "stepNumber": 1,
      "execRoleId": 2,
      "approvalFlowStepTypeId": 3,
      "doNotNotifyExecutor": true,
      "notificationInRoleIds": [
        1,
        2
      ],
      "notificationOutRoleIds": [
        1,
        2
      ],
      "notificationCcRoleIds": [
        1,
        2
      ]
    },
    {
      "stepNumber": 1,
      "execRoleId": 2,
      "approvalFlowStepTypeId": 3,
      "doNotNotifyExecutor": true,
      "notificationInRoleIds": [
        1,
        2
      ],
      "notificationOutRoleIds": [
        1,
        2
      ],
      "notificationCcRoleIds": [
        1,
        2
      ]
    }
  ],
  "projectId": 1
}

text/html

Sample:

{"title":"sample string 1","description":"sample string 2","approvalFlowEntityId":1,"supervisorRoleId":3,"notificationInRoleIds":[1,2],"notificationOutRoleIds":[1,2],"steps":[{"stepNumber":1,"execRoleId":2,"approvalFlowStepTypeId":3,"doNotNotifyExecutor":true,"notificationInRoleIds":[1,2],"notificationOutRoleIds":[1,2],"notificationCcRoleIds":[1,2]},{"stepNumber":1,"execRoleId":2,"approvalFlowStepTypeId":3,"doNotNotifyExecutor":true,"notificationInRoleIds":[1,2],"notificationOutRoleIds":[1,2],"notificationCcRoleIds":[1,2]}],"projectId":1}

application/xml, text/xml

Sample:

<ApprovalFlowTemplateCreateDto 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 2</Description>
  <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>
    <ApprovalStepTemplateCreateDto>
      <ApprovalFlowStepTypeId>3</ApprovalFlowStepTypeId>
      <DoNotNotifyExecutor>true</DoNotNotifyExecutor>
      <ExecRoleId>2</ExecRoleId>
      <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>1</StepNumber>
    </ApprovalStepTemplateCreateDto>
    <ApprovalStepTemplateCreateDto>
      <ApprovalFlowStepTypeId>3</ApprovalFlowStepTypeId>
      <DoNotNotifyExecutor>true</DoNotNotifyExecutor>
      <ExecRoleId>2</ExecRoleId>
      <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>1</StepNumber>
    </ApprovalStepTemplateCreateDto>
  </Steps>
  <SupervisorRoleId>3</SupervisorRoleId>
  <Title>sample string 1</Title>
</ApprovalFlowTemplateCreateDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

URI

Response Formats

application/json, text/json, text/html

Sample:

"http://webapihelppage1.com"

application/xml, text/xml

Sample:

<anyURI xmlns="http://schemas.microsoft.com/2003/10/Serialization/">http://webapihelppage1.com/</anyURI>