DigiOffice Gateway Web Services

StartSideStep


export class UserOrGroup
{
    public ID?: number;
    public Title?: string;
    public IsChecked?: boolean;
    public Image?: string;

    public constructor(init?: Partial<UserOrGroup>) { (Object as any).assign(this, init); }
}

export class User extends UserOrGroup
{
    public Image?: string;

    public constructor(init?: Partial<User>) { super(init); (Object as any).assign(this, init); }
}

export class Group extends UserOrGroup
{
    public Image?: string;

    public constructor(init?: Partial<Group>) { super(init); (Object as any).assign(this, init); }
}

export class WorkflowTaskDelay
{
    public DelayDate?: string;
    public Reason?: string;

    public constructor(init?: Partial<WorkflowTaskDelay>) { (Object as any).assign(this, init); }
}

export class WorkflowTaskReason
{
    public Reason?: string;
    public Required?: boolean;

    public constructor(init?: Partial<WorkflowTaskReason>) { (Object as any).assign(this, init); }
}

export class WorkflowTaskAdhocTransition
{
    public ID?: string;
    public Title?: string;
    public AssignmentAllowed?: boolean;
    public AssignmentRequired?: boolean;
    public UserEnvironment?: number;
    public Users?: User[];
    public Groups?: Group[];
    public Delay?: WorkflowTaskDelay;
    public Reason?: WorkflowTaskReason;
    public UsersOrGroups?: UserOrGroup[];
    public Value?: string;

    public constructor(init?: Partial<WorkflowTaskAdhocTransition>) { (Object as any).assign(this, init); }
}

export class AdhocTransitionDetails
{
    public AdhocTransitions?: WorkflowTaskAdhocTransition[];

    public constructor(init?: Partial<AdhocTransitionDetails>) { (Object as any).assign(this, init); }
}

export class WorkflowTaskActionComment
{
    public Comment?: string;
    public Required?: boolean;

    public constructor(init?: Partial<WorkflowTaskActionComment>) { (Object as any).assign(this, init); }
}

export class SideStepDetails extends AdhocTransitionDetails
{
    public Coordinator?: User;
    public Comment?: WorkflowTaskActionComment;
    public Urgent?: boolean;

    public constructor(init?: Partial<SideStepDetails>) { super(init); (Object as any).assign(this, init); }
}

export class StartSideStep
{
    public ProcessID?: number;
    public WorkflowTaskID?: number;
    public Details?: SideStepDetails;

    public constructor(init?: Partial<StartSideStep>) { (Object as any).assign(this, init); }
}

TypeScript 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"}]}}