DigiOffice API Services Services

<back to all web services

GetTaskOperation

Get workflow task.

export class WorkflowTaskActionDTO
{
    public BeginGroup: boolean;
    public DigiOfficeIcon: string;
    public Enabled: boolean;
    public FontAwesomeIcon: string;
    public Hint: string;
    public Name: string;
    public ShowTextForRootItems: boolean;
    public Text: string;
    public Url: string;
    public Items: WorkflowTaskActionDTO[];

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

export class WorkflowTaskDTO
{
    public ID: number;
    public Name: string;
    public WorkflowID: number;
    public WorkflowDescription: string;
    public RootWorkflowID: number;
    public TransitionID: string;
    public TransitionName: string;
    public ActivationID?: string;
    public TypeID: number;
    public TypeDescription: string;
    public StatusID: number;
    public StatusDescription: string;
    public UserID?: number;
    public Active: boolean;
    public OfferedDate?: string;
    public AssignedDate?: string;
    public StartDate?: string;
    public ExpirationDate?: string;
    public Order: number;
    public Progress?: number;
    public FinishedDate?: string;
    public FinishedByUserID?: number;
    public FinishedDocumentID?: string;
    public Read: boolean;
    public DeferDate?: string;
    public DeferReason: string;
    public Reason: string;
    public Urgent: boolean;
    public Status: string;
    public AvailableActions: WorkflowTaskActionDTO[];
    public FinishActions: WorkflowTaskActionDTO[];
    public CommentActions: WorkflowTaskActionDTO[];
    public DocumentActions: WorkflowTaskActionDTO[];
    public NumberOfComments: number;
    public RelativeDetailLink: string;
    public FirstSideStepID: number;
    public FirstSideStepOmschr: string;
    public FirstSideStepDetailLink: string;
    public IsSideStepOfWorkflowID?: number;
    public IsSideStepOfWorkflowOmschr: string;
    public IsSideStepOfWorkflowDetailLink: string;
    public IsSideStepOfTaskID?: number;
    public IsSideStepOfTaskOmschr: string;
    public IsSideStepOfTaskDetailLink: string;
    public IsObservedID?: number;
    public IsObservedOmschr: string;
    public IsObservedDetailLink: string;

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

/** @description Get workflow task. */
// @Api(Description="Get workflow task.")
export class GetTaskOperation
{
    /** @description ID of the workflow task(s) to return */
    // @ApiMember(Description="ID of the workflow task(s) to return", IsRequired=true)
    public TaskID: number;

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

TypeScript GetTaskOperation DTOs

GET /api/workflowtasks/{TaskID} HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WorkflowTaskDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.Workflow.API.DTOs">
  <ActivationID>00000000-0000-0000-0000-000000000000</ActivationID>
  <Active>false</Active>
  <AssignedDate>0001-01-01T00:00:00</AssignedDate>
  <AvailableActions i:nil="true" />
  <CommentActions i:nil="true" />
  <DeferDate>0001-01-01T00:00:00</DeferDate>
  <DeferReason>String</DeferReason>
  <DocumentActions i:nil="true" />
  <ExpirationDate>0001-01-01T00:00:00</ExpirationDate>
  <FinishActions i:nil="true" />
  <FinishedByUserID>0</FinishedByUserID>
  <FinishedDate>0001-01-01T00:00:00</FinishedDate>
  <FinishedDocumentID>00000000-0000-0000-0000-000000000000</FinishedDocumentID>
  <FirstSideStepDetailLink>String</FirstSideStepDetailLink>
  <FirstSideStepID>0</FirstSideStepID>
  <FirstSideStepOmschr>String</FirstSideStepOmschr>
  <ID>0</ID>
  <IsObservedDetailLink>String</IsObservedDetailLink>
  <IsObservedID>0</IsObservedID>
  <IsObservedOmschr>String</IsObservedOmschr>
  <IsSideStepOfTaskDetailLink>String</IsSideStepOfTaskDetailLink>
  <IsSideStepOfTaskID>0</IsSideStepOfTaskID>
  <IsSideStepOfTaskOmschr>String</IsSideStepOfTaskOmschr>
  <IsSideStepOfWorkflowDetailLink>String</IsSideStepOfWorkflowDetailLink>
  <IsSideStepOfWorkflowID>0</IsSideStepOfWorkflowID>
  <IsSideStepOfWorkflowOmschr>String</IsSideStepOfWorkflowOmschr>
  <Name>String</Name>
  <NumberOfComments>0</NumberOfComments>
  <OfferedDate>0001-01-01T00:00:00</OfferedDate>
  <Order>0</Order>
  <Progress>0</Progress>
  <Read>false</Read>
  <Reason>String</Reason>
  <RelativeDetailLink>String</RelativeDetailLink>
  <RootWorkflowID>0</RootWorkflowID>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <Status>String</Status>
  <StatusDescription>String</StatusDescription>
  <StatusID>0</StatusID>
  <TransitionID>00000000-0000-0000-0000-000000000000</TransitionID>
  <TransitionName>String</TransitionName>
  <TypeDescription>String</TypeDescription>
  <TypeID>0</TypeID>
  <Urgent>false</Urgent>
  <UserID>0</UserID>
  <WorkflowDescription>String</WorkflowDescription>
  <WorkflowID>0</WorkflowID>
</WorkflowTaskDTO>