Trendsic Platform Service

<back to all web services

EngineSuggestionsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/engine/suggestions
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkflowSuggestionView:
    suggestion_id: int = 0
    suggestion_key: Optional[str] = None
    title: Optional[str] = None
    evidence: Optional[str] = None
    impact: Optional[str] = None
    vertical: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EngineSuggestionsResponse:
    suggestions: List[WorkflowSuggestionView] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EngineSuggestionsRequest:
    pass

Python EngineSuggestionsRequest 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/suggestions HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Suggestions: 
	[
		{
			SuggestionId: 0,
			SuggestionKey: String,
			Title: String,
			Evidence: String,
			Impact: String,
			Vertical: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}