POST v1/WorkflowQueueAdd

Request Information

URI Parameters

None.

Body Parameters

WorkflowQueueAddDto
NameDescriptionTypeAdditional information
UserAD

string

None.

AppCode

string

None.

AccountName

string

None.

PassWord

string

None.

ID

string

None.

WorkflowCode

string

None.

ApplicationCode

string

None.

Subject

string

None.

RequestID

string

None.

ActionType

integer

None.

Action

string

None.

ProcessID

integer

None.

WorkFlowSN

string

None.

ActionUser

string

None.

ActionUserDisplayName

string

None.

ActionUserEmail

string

None.

ToUser

string

None.

ToUserDisplayName

string

None.

ToUserEmail

string

None.

BaseQueueID

globally unique identifier

None.

Comments

string

None.

BusinessData

BusinessData

None.

Request Formats

application/json, text/json

Sample:
{
  "UserAD": "sample string 1",
  "AppCode": "sample string 2",
  "AccountName": "sample string 3",
  "PassWord": "sample string 4",
  "ID": "sample string 5",
  "WorkflowCode": "sample string 6",
  "ApplicationCode": "sample string 7",
  "Subject": "sample string 8",
  "RequestID": "sample string 9",
  "ActionType": 10,
  "Action": "sample string 11",
  "ProcessID": 1,
  "WorkFlowSN": "sample string 12",
  "ActionUser": "sample string 13",
  "ActionUserDisplayName": "sample string 14",
  "ActionUserEmail": "sample string 15",
  "ToUser": "sample string 16",
  "ToUserDisplayName": "sample string 17",
  "ToUserEmail": "sample string 18",
  "BaseQueueID": "6b1f5c91-2f41-4436-8b91-96f8e94cff78",
  "Comments": "sample string 19",
  "BusinessData": {
    "WorkflowCode": "sample string 1",
    "RequestAD": "sample string 2",
    "RequestEmail": "sample string 3",
    "RequestDisplayName": "sample string 4",
    "BusinessKeyID": "sample string 5",
    "CountryCode": "sample string 6",
    "CompanyCode": "sample string 7",
    "DivisionCode": "sample string 8",
    "LBUCode": "sample string 9",
    "RequestDate": "sample string 10",
    "Roles": [
      {
        "ActivityID": "038c7899-07ae-40fd-90ac-62ba1229a8b0",
        "Level": 2,
        "Users": [
          {
            "UserAD": "sample string 1",
            "K2UserID": "sample string 2",
            "UserEmail": "sample string 3",
            "EmpNo": "sample string 4",
            "DisplayName": "sample string 5",
            "RoleName": "sample string 6",
            "RoleID": "7238caaf-1cdd-494b-9e39-f34d87bb304a"
          },
          {
            "UserAD": "sample string 1",
            "K2UserID": "sample string 2",
            "UserEmail": "sample string 3",
            "EmpNo": "sample string 4",
            "DisplayName": "sample string 5",
            "RoleName": "sample string 6",
            "RoleID": "7238caaf-1cdd-494b-9e39-f34d87bb304a"
          }
        ]
      },
      {
        "ActivityID": "038c7899-07ae-40fd-90ac-62ba1229a8b0",
        "Level": 2,
        "Users": [
          {
            "UserAD": "sample string 1",
            "K2UserID": "sample string 2",
            "UserEmail": "sample string 3",
            "EmpNo": "sample string 4",
            "DisplayName": "sample string 5",
            "RoleName": "sample string 6",
            "RoleID": "7238caaf-1cdd-494b-9e39-f34d87bb304a"
          },
          {
            "UserAD": "sample string 1",
            "K2UserID": "sample string 2",
            "UserEmail": "sample string 3",
            "EmpNo": "sample string 4",
            "DisplayName": "sample string 5",
            "RoleName": "sample string 6",
            "RoleID": "7238caaf-1cdd-494b-9e39-f34d87bb304a"
          }
        ]
      }
    ],
    "TOAFields": [
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      }
    ],
    "FormApprover": [
      {
        "ApproverAD": "sample string 1",
        "ApproverEmail": "sample string 2",
        "ApproverDisplanyName": "sample string 3"
      },
      {
        "ApproverAD": "sample string 1",
        "ApproverEmail": "sample string 2",
        "ApproverDisplanyName": "sample string 3"
      }
    ]
  }
}

application/xml, text/xml

Sample:
<WorkflowQueueAddDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iProcess.AzureAPI.ServiceBus.Models">
  <Action>sample string 11</Action>
  <ActionType>10</ActionType>
  <ActionUser>sample string 13</ActionUser>
  <ActionUserDisplayName>sample string 14</ActionUserDisplayName>
  <ActionUserEmail>sample string 15</ActionUserEmail>
  <ApplicationCode>sample string 7</ApplicationCode>
  <BaseQueueID>6b1f5c91-2f41-4436-8b91-96f8e94cff78</BaseQueueID>
  <BusinessData>
    <BusinessKeyID>sample string 5</BusinessKeyID>
    <CompanyCode>sample string 7</CompanyCode>
    <CountryCode>sample string 6</CountryCode>
    <DivisionCode>sample string 8</DivisionCode>
    <FormApprover>
      <FormApprover>
        <ApproverAD>sample string 1</ApproverAD>
        <ApproverDisplanyName>sample string 3</ApproverDisplanyName>
        <ApproverEmail>sample string 2</ApproverEmail>
      </FormApprover>
      <FormApprover>
        <ApproverAD>sample string 1</ApproverAD>
        <ApproverDisplanyName>sample string 3</ApproverDisplanyName>
        <ApproverEmail>sample string 2</ApproverEmail>
      </FormApprover>
    </FormApprover>
    <LBUCode>sample string 9</LBUCode>
    <RequestAD>sample string 2</RequestAD>
    <RequestDate>sample string 10</RequestDate>
    <RequestDisplayName>sample string 4</RequestDisplayName>
    <RequestEmail>sample string 3</RequestEmail>
    <Roles>
      <Roles>
        <ActivityID>038c7899-07ae-40fd-90ac-62ba1229a8b0</ActivityID>
        <Level>2</Level>
        <Users>
          <RoleUser>
            <DisplayName>sample string 5</DisplayName>
            <EmpNo>sample string 4</EmpNo>
            <K2UserID>sample string 2</K2UserID>
            <RoleID>7238caaf-1cdd-494b-9e39-f34d87bb304a</RoleID>
            <RoleName>sample string 6</RoleName>
            <UserAD>sample string 1</UserAD>
            <UserEmail>sample string 3</UserEmail>
          </RoleUser>
          <RoleUser>
            <DisplayName>sample string 5</DisplayName>
            <EmpNo>sample string 4</EmpNo>
            <K2UserID>sample string 2</K2UserID>
            <RoleID>7238caaf-1cdd-494b-9e39-f34d87bb304a</RoleID>
            <RoleName>sample string 6</RoleName>
            <UserAD>sample string 1</UserAD>
            <UserEmail>sample string 3</UserEmail>
          </RoleUser>
        </Users>
      </Roles>
      <Roles>
        <ActivityID>038c7899-07ae-40fd-90ac-62ba1229a8b0</ActivityID>
        <Level>2</Level>
        <Users>
          <RoleUser>
            <DisplayName>sample string 5</DisplayName>
            <EmpNo>sample string 4</EmpNo>
            <K2UserID>sample string 2</K2UserID>
            <RoleID>7238caaf-1cdd-494b-9e39-f34d87bb304a</RoleID>
            <RoleName>sample string 6</RoleName>
            <UserAD>sample string 1</UserAD>
            <UserEmail>sample string 3</UserEmail>
          </RoleUser>
          <RoleUser>
            <DisplayName>sample string 5</DisplayName>
            <EmpNo>sample string 4</EmpNo>
            <K2UserID>sample string 2</K2UserID>
            <RoleID>7238caaf-1cdd-494b-9e39-f34d87bb304a</RoleID>
            <RoleName>sample string 6</RoleName>
            <UserAD>sample string 1</UserAD>
            <UserEmail>sample string 3</UserEmail>
          </RoleUser>
        </Users>
      </Roles>
    </Roles>
    <TOAFields>
      <TOAInfo>
        <Key>sample string 1</Key>
        <Value>sample string 2</Value>
      </TOAInfo>
      <TOAInfo>
        <Key>sample string 1</Key>
        <Value>sample string 2</Value>
      </TOAInfo>
    </TOAFields>
    <WorkflowCode>sample string 1</WorkflowCode>
  </BusinessData>
  <Comments>sample string 19</Comments>
  <ID>sample string 5</ID>
  <ProcessID>1</ProcessID>
  <RequestID>sample string 9</RequestID>
  <Subject>sample string 8</Subject>
  <ToUser>sample string 16</ToUser>
  <ToUserDisplayName>sample string 17</ToUserDisplayName>
  <ToUserEmail>sample string 18</ToUserEmail>
  <WorkFlowSN>sample string 12</WorkFlowSN>
  <WorkflowCode>sample string 6</WorkflowCode>
  <AccountName>sample string 3</AccountName>
  <AppCode>sample string 2</AppCode>
  <PassWord>sample string 4</PassWord>
  <UserAD>sample string 1</UserAD>
</WorkflowQueueAddDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.