DigiOffice Gateway Web Services

<back to all web services

StartSideStep

Requires Authentication
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports IDB.API.DTO.Workflow.Operations
Imports IDB.API.DTO.Workflow
Imports IDB.API.DTO.Interfaces
Imports IDB.API.DTO

Namespace Global

    Namespace IDB.API.DTO

        Public Partial Class Group
            Inherits UserOrGroup
            Public Overridable Property Image As String
        End Class

        Public Partial Class User
            Inherits UserOrGroup
            Public Overridable Property Image As String
        End Class

        Public Partial Class UserOrGroup
            Public Overridable Property ID As Integer
            Public Overridable Property Title As String
            Public Overridable Property IsChecked As Boolean
            Public Overridable Property Image As String
        End Class
    End Namespace

    Namespace IDB.API.DTO.Interfaces

        Public Partial Class AdhocTransitionDetails
            Public Sub New()
                AdhocTransitions = New List(Of WorkflowTaskAdhocTransition)
            End Sub

            Public Overridable Property AdhocTransitions As List(Of WorkflowTaskAdhocTransition)
        End Class
    End Namespace

    Namespace IDB.API.DTO.Workflow

        Public Partial Class SideStepDetails
            Inherits AdhocTransitionDetails
            Public Overridable Property Coordinator As User
            Public Overridable Property Comment As WorkflowTaskActionComment
            Public Overridable Property Urgent As Boolean
        End Class

        Public Partial Class WorkflowTaskActionComment
            Public Overridable Property Comment As String
            Public Overridable Property Required As Boolean
        End Class

        Public Partial Class WorkflowTaskAdhocTransition
            Public Sub New()
                Users = New List(Of User)
                Groups = New List(Of Group)
                UsersOrGroups = New List(Of UserOrGroup)
            End Sub

            Public Overridable Property ID As Guid
            Public Overridable Property Title As String
            Public Overridable Property AssignmentAllowed As Boolean
            Public Overridable Property AssignmentRequired As Boolean
            Public Overridable Property UserEnvironment As Integer
            Public Overridable Property Users As List(Of User)
            Public Overridable Property Groups As List(Of Group)
            Public Overridable Property Delay As WorkflowTaskDelay
            Public Overridable Property Reason As WorkflowTaskReason
            Public Overridable Property UsersOrGroups As List(Of UserOrGroup)
            Public Overridable Property Value As String
        End Class

        Public Partial Class WorkflowTaskDelay
            Public Overridable Property DelayDate As Nullable(Of Date)
            Public Overridable Property Reason As String
        End Class

        Public Partial Class WorkflowTaskReason
            Public Overridable Property Reason As String
            Public Overridable Property Required As Boolean
        End Class
    End Namespace

    Namespace IDB.API.DTO.Workflow.Operations

        Public Partial Class StartSideStep
            Public Overridable Property ProcessID As Integer
            Public Overridable Property WorkflowTaskID As Integer
            Public Overridable Property Details As SideStepDetails
        End Class
    End Namespace
End Namespace

VB.NET StartSideStep DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/oneway/StartSideStep HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ProcessID":0,"WorkflowTaskID":0,"Details":{"Coordinator":{"Image":"Icons/User","ID":0,"Title":"String","IsChecked":false},"Comment":{"Comment":"String","Required":false},"Urgent":false,"AdhocTransitions":[{"ID":"00000000-0000-0000-0000-000000000000","Title":"String","AssignmentAllowed":false,"AssignmentRequired":false,"UserEnvironment":0,"Users":[{"Image":"Icons/User","ID":0,"Title":"String","IsChecked":false}],"Groups":[{"Image":"Icons/Group","ID":0,"Title":"String","IsChecked":false}],"Delay":{"DelayDate":"0001-01-01T00:00:00.0000000","Reason":"String"},"Reason":{"Reason":"String","Required":false},"UsersOrGroups":[{"__type":"IDB.API.DTO.User, IDB.API.DTO","Image":"Icons/User","ID":0,"Title":"String","IsChecked":false},{"__type":"IDB.API.DTO.Group, IDB.API.DTO","Image":"Icons/Group","ID":0,"Title":"String","IsChecked":false}],"Value":"String\r\nString"}]}}