DigiOffice API Services Services

<back to all web services

GetTaskOperation

Get workflow task.

Requires Authentication
The following routes are available for this service:
GET/api/workflowtasks/{TaskID}

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

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

HTTP + JSV

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

GET /api/workflowtasks/{TaskID} HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ID: 0,
	Name: String,
	WorkflowID: 0,
	WorkflowDescription: String,
	RootWorkflowID: 0,
	TransitionName: String,
	ActivationID: 00000000-0000-0000-0000-000000000000,
	TypeID: 0,
	TypeDescription: String,
	StatusID: 0,
	StatusDescription: String,
	UserID: 0,
	Active: False,
	OfferedDate: 0001-01-01,
	AssignedDate: 0001-01-01,
	StartDate: 0001-01-01,
	ExpirationDate: 0001-01-01,
	Order: 0,
	Progress: 0,
	FinishedDate: 0001-01-01,
	FinishedByUserID: 0,
	FinishedDocumentID: 00000000-0000-0000-0000-000000000000,
	Read: False,
	DeferDate: 0001-01-01,
	DeferReason: String,
	Reason: String,
	Urgent: False,
	Status: String,
	NumberOfComments: 0,
	RelativeDetailLink: String,
	FirstSideStepID: 0,
	FirstSideStepOmschr: String,
	FirstSideStepDetailLink: String,
	IsSideStepOfWorkflowID: 0,
	IsSideStepOfWorkflowOmschr: String,
	IsSideStepOfWorkflowDetailLink: String,
	IsSideStepOfTaskID: 0,
	IsSideStepOfTaskOmschr: String,
	IsSideStepOfTaskDetailLink: String,
	IsObservedID: 0,
	IsObservedOmschr: String,
	IsObservedDetailLink: String
}