tvpl.api

<back to all web services

UpdateStepStatusRequest

Requires Authentication
The following routes are available for this service:
POST/WorkflowStep/status
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class UpdateStepStatusRequest
    {
        public Integer stepId = null;
        public CategoryStatusKeys statusKey = null;
        public String comment = null;
        
        public Integer getStepId() { return stepId; }
        public UpdateStepStatusRequest setStepId(Integer value) { this.stepId = value; return this; }
        public CategoryStatusKeys getStatusKey() { return statusKey; }
        public UpdateStepStatusRequest setStatusKey(CategoryStatusKeys value) { this.statusKey = value; return this; }
        public String getComment() { return comment; }
        public UpdateStepStatusRequest setComment(String value) { this.comment = value; return this; }
    }

    public static enum CategoryStatusKeys
    {
        WorkCreated,
        WorkInProgress,
        WorkReturned,
        WorkCompleted,
        WorkCancelled,
        WorkDone,
        StepNotStarted,
        StepInProgress,
        StepDone,
        StepCompleted,
        StepSkipped,
        StepReturned,
        NotSigned,
        SignatureReturned,
        SignaturePending;
    }

    public static class WorkflowStepResponse implements IResponseRequest
    {
        public Integer code = null;
        public String message = null;
        public Integer insertedId = null;
        
        public Integer getCode() { return code; }
        public WorkflowStepResponse setCode(Integer value) { this.code = value; return this; }
        public String getMessage() { return message; }
        public WorkflowStepResponse setMessage(String value) { this.message = value; return this; }
        public Integer getInsertedId() { return insertedId; }
        public WorkflowStepResponse setInsertedId(Integer value) { this.insertedId = value; return this; }
    }

}

Java UpdateStepStatusRequest DTOs

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

HTTP + CSV

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

POST /WorkflowStep/status HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"stepId":0,"statusKey":"WorkCreated","comment":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"code":0,"message":"String","insertedId":0}