DigiOffice API Services Services

<back to all web services

GetTaskForEntityOperation

Get workflow tasks for entity.

Requires Authentication
The following routes are available for this service:
GET/api/workflowtasks/{EntityName}/{EntityID}
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


/** @description Get workflow tasks for entity. */
// @Api(Description="Get workflow tasks for entity.")
class GetTaskForEntityOperation implements JsonSerializable
{
    public function __construct(
        /** @description Name of the entity */
        // @ApiMember(Description="Name of the entity", IsRequired=true)
        /** @var string */
        public string $EntityName='',

        /** @description Primary key of the entity */
        // @ApiMember(Description="Primary key of the entity", IsRequired=true)
        /** @var string */
        public string $EntityID=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['EntityName'])) $this->EntityName = $o['EntityName'];
        if (isset($o['EntityID'])) $this->EntityID = $o['EntityID'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->EntityName)) $o['EntityName'] = $this->EntityName;
        if (isset($this->EntityID)) $o['EntityID'] = $this->EntityID;
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetTaskForEntityOperation 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/{EntityName}/{EntityID} 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
	}
]