Trendsic Platform Service

<back to all web services

EngineWorkflowArchivePreviewRequest

Requires Authentication
The following routes are available for this service:
GET/v1/engine/workflows/{WorkflowId}/archive
"use strict";
export class WorkflowArchivePreview {
    /** @param {{WorkflowId?:number,Name?:string,Status?:string,Trigger?:string,Queued?:number,Waiting?:number,Running?:number,Refusal?:string,HasPendingRequest?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    WorkflowId;
    /** @type {string} */
    Name;
    /** @type {string} */
    Status;
    /** @type {string} */
    Trigger;
    /** @type {number} */
    Queued;
    /** @type {number} */
    Waiting;
    /** @type {number} */
    Running;
    /** @type {string} */
    Refusal;
    /** @type {boolean} */
    HasPendingRequest;
}
export class EngineWorkflowArchivePreviewResponse {
    /** @param {{Preview?:WorkflowArchivePreview,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {WorkflowArchivePreview} */
    Preview;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class EngineWorkflowArchivePreviewRequest {
    /** @param {{WorkflowId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    WorkflowId;
}

JavaScript EngineWorkflowArchivePreviewRequest 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 /v1/engine/workflows/{WorkflowId}/archive HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Preview: 
	{
		WorkflowId: 0,
		Name: String,
		Status: String,
		Trigger: String,
		Queued: 0,
		Waiting: 0,
		Running: 0,
		Refusal: String,
		HasPendingRequest: False
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}